Get a collection of Jobs

get/jobs

Internal-Use Only

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

Request Samples

Response Samples

200
application/json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.batch.job",
4  "count": 1,
5  "start": 0,
6  "limit": 10,
7  "name": "jobs",
8  "items": [
9    {
10      "creationTimeStamp": "2022-06-14T15:00:49.668113Z",
11      "createdBy": "someuser",
12      "modifiedTimeStamp": "2022-06-14T15:01:05.66361Z",
13      "modifiedBy": "anonymous",
14      "contextId": "6794ba8a-6aff-4989-ae77-93f67286aea2",
15      "endedTimeStamp": "2022-06-14T15:01:02Z",
16      "executionHost": "10.254.3.12",
17      "fileSetId": "JOB_20220614_150046_039_1",
18      "id": "dbbb00c3-e67c-408b-bd84-9b57a2d69472",
19      "links": [
20        {
21          "method": "GET",
22          "rel": "self",
23          "href": "/batch/jobs/dbbb00c3-e67c-408b-bd84-9b57a2d69472",
24          "uri": "/batch/jobs/dbbb00c3-e67c-408b-bd84-9b57a2d69472",
25          "type": "application/vnd.sas.batch.job"
26        },
27        {
28          "method": "GET",
29          "rel": "up",
30          "href": "/batch/jobs",
31          "uri": "/batch/jobs",
32          "type": "application/vnd.sas.collection",
33          "itemType": "application/vnd.sas.batch.job"
34        }
35      ],
36      "name": "testEnvVars",
37      "processId": "b7e39cf9-eda7-400c-a752-301653e55e8e",
38      "workloadJobId": "5",
39      "returnCode": 0,
40      "state": "completed",
41      "startedTimeStamp": "2022-06-14T15:00:49Z",
42      "submittedTimeStamp": "2022-06-14T15:00:49Z",
43      "version": 1
44    }
45  ],
46  "links": [
47    {
48      "method": "GET",
49      "rel": "collection",
50      "href": "/batch/jobs",
51      "uri": "/batch/jobs",
52      "type": "application/vnd.sas.collection",
53      "itemType": "application/vnd.sas.batch.job"
54    },
55    {
56      "method": "GET",
57      "rel": "self",
58      "href": "/batch/jobs?start=0&limit=10",
59      "uri": "/batch/jobs?start=0&limit=10",
60      "type": "application/vnd.sas.collection",
61      "itemType": "application/vnd.sas.batch.job"
62    }
63  ]
64}

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	Specifies the filter criteria for returned items.
limit	integer	false	Limits the maximum number of resource items to return. The default value is "10".
sortBy	string<sort-criteria>	false	Sorts returned items by the specified criteria.
start	integer	false	Returns the offset of the first resource item to return. The default value is "0".

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	The query jobs request is not valid due to one of the following reasons. <UL> <LI> The start or limit value is not a number. <LI> The start or limit value is less than 0. <LI> The filter parameter is not a valid value. <LI> The sortBy parameter is not a valid value. </UL> See the returned error response for more information.	Schema
406	Not Acceptable	The requested response type is not acceptable. See the returned error response for more information and acceptable response types.	Schema