Jobs

Get the job information

Gets the job information or job state information for the specified job.

get/jobs/{jobId}

Request

  • Base URL: https://example.com/batch
  • URL: https://example.com/batch/jobs/{jobId}
  • Auth: none declared

Path parameters

jobIdstring required

The ID of the job.

Response

The request succeeded.

createdBystring

The username of whoever created the resource.

modifiedBystring

The username of whoever last modified the resource.

creationTimeStampstring date-time

The timestamp for when the resource was created.

modifiedTimeStampstring date-time

The timestamp for when the resource was last modified.

contextIdstring

Specifies the context ID that is associated with the job.

endedTimeStampstring date-time

If present, it specifies the timestamp when the job ended.

executionHoststring

If the job is running, this is the name of the host on which the job is being processed.

fileSetIdstring

Specifies the ID of the file set to use for transporting files to and from the job.

idstring

Specifies the ID of the job assigned by the Batch service.

namestring

The name of the job

portinteger

If the job is running, this is the port on which the job can be contacted by the Batch service to get the STDOUT information.

processIdstring

The operating system process ID of the job process.

workloadJobIdstring

If SAS Workload Management is in the deployment, this is the SAS Workload Orchestrator job ID.

returnCodeinteger

If the job has finished, this is the return code from the process.

state'pending' | 'running' | 'completed' | 'failed' | 'unknown'

The processing state of the Batch job.

startedTimeStampstring date-time

If present, it specifies the timestamp when the job was started.

submittedTimeStampstring date-time

Specifies the timestamp when the job was submitted.

versioninteger

Specifies the version number of this representation schema. This is version 1.

Example response

{
  "contextId": "16c332b2-4ac6-483b-85f6-7bb9d2d5a576",
  "endedTimeStamp": "2022-06-01T13:55:32Z",
  "executionHost": "myhost01.mycompany.com",
  "fileSetId": "JOB_20220606_182805_634_1",
  "id": "16a46fa5-f866-488d-9cec-92e226bfcf5",
  "name": "Monthly Status Report for New York",
  "port": 23645,
  "processId": "5",
  "workloadJobId": "1375",
  "returnCode": 2,
  "state": "failed",
  "startedTimeStamp": "2022-06-01T13:45:32Z",
  "submittedTimeStamp": "2022-06-01T13:44:32Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.