Get Job

GET/api/v2/orchestration/jobs/{jobRid}

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get the Job with the specified rid.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-read.

Path parameters

jobRid

string

The RID of a Job.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

Job

object

Hide child attributes

rid

string

The RID of a Job.

buildRid

string

The RID of the Build that the Job belongs to.

startedTime

string

The time this job started waiting for the dependencies to be resolved.

finishedTime

string

optional

The time this job was finished.

jobStatus

string (enum)

The status of the job.

Enum values: WAITING, RUNNING, SUCCEEDED, FAILED, CANCELED, DID_NOT_RUN

outputs

list<JobOutput>

optional

Outputs of the Job. Only outputs with supported types are listed here; unsupported types are omitted. Currently supported types are Dataset and Media Set outputs.

Show child attributes

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/orchestration/jobs/ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448?preview=true"

Response

Copied!

{
  "startedTime": "2003-05-06T12:34:56.789Z",
  "jobStatus": "WAITING",
  "buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
  "finishedTime": "2003-05-06T12:34:56.789Z",
  "rid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
}

Error responses

Error Name
`JobNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Job could not be found.
	Parameters	`jobRid`

See Errors for a general overview of errors in the platform.