Skip to content

POST /job/{job_key}/heartbeat

Job Heartbeat

POST
/job/{job_key}/heartbeat

Updates the work session last_online attribute with current time.

Writes the current timestamp to Job.last_online within a transaction on the
Job and WorkSession collections. Used by the production UI to signal that
an operator is still active on a job without recording a full event.

Emits: (direct transaction — no event class)
Required scope: traceability:batch-execution-record:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Path Parameters

job_key*
Type
string
Required

Query Parameters

work_session_key

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.