Jobs

Get a collection of Jobs

Returns a collection of job objects in the form of an application/vnd.sas.collection. It is based on the specified query parameters.

get/jobs

Request

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

Query parameters

startinteger

Returns the offset of the first resource item to return. The default value is "0".

limitinteger

Limits the maximum number of resource items to return. The default value is "10".

filterstring filter-criteria

Specifies the filter criteria for returned items.

sortBystring sort-criteria

Sorts returned items by the specified criteria.

Response

The request succeeded.

namestring

The name of the collection.

startinteger

The zero-based index of the first item in the collection.

limitinteger

The number of items that were requested for the collection.

countinteger

If populated indicates the number of items in the collection.

acceptstring

A space-delimited list of media types from which an Accept header may be constructed.

versioninteger

The version number of the collection representation. This representation is version 2.

Example response

{
  "items": [
    {
      "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.