GET /jobs/<job-id>/report

Returns a report that summarizes a specific job.

Request format

When Forming orchestrator API requests to this endpoint, the URI path must include an integer job ID identifying a specific task or deployment. For example, this request queries a job with ID 375:

https://orchestrator.example.com:8143/orchestrator/v1/jobs/375/report

Job IDs are returned in responses from some Command endpoints and GET /jobs.

Response format

The response is a JSON object containing an array called items. The array contains one or more JSON objects summarizing the job's status on each node it ran (or is currently running) on. These keys are used:

Key	Definition
node	The hostname of a node that the job ran on.
state	The job's current state on a specific node: new, ready, running, stopping, stopped, finished, or failed
timestamp	The time when the job's state last changed. this originally said "the time the job was created", but that doesn't follow the pattern of the other endpoints and it makes more sense to report the last state change time rather than the creation time.
events	IDs of events associated with the particular job and node.

For example, this response contains one summary report:

{
  "items" : [ {
    "node" : "node1.example.com",
    "state" : "running",
    "timestamp" : "2015-07-13T20:37:01Z",
    "events" : [ ]
  }, {
  ...
  } ]
}

If you want more details about the job, use the GET /jobs/<job-id> endpoint.

Error responses

If there is an error, Orchestrator API error responses provide error information in the kind key:

Response code	Key	Description
400	puppetlabs.orchestrator/validation-error	The job ID in the request is not an integer.
404	puppetlabs.orchestrator/unknown-job	No job exists that matches the specified job ID.