Gets a filtered list of jobs associated with the job request

post/jobRequests/{jobRequestId}/jobs

Returns a collection of application/vnd.sas.job.execution.job resources that were submitted using the specified job request. This particular call takes the filter in the body of the request to allow large filters that exceed standard URL length limits. Standard paging, filtering, and sorting options are specified in the Query Parameters and Request Body sections.

Request Samples

Response Samples


1{
2  "links": [
3    {
4      "method": "POST",
5      "rel": "collection",
6      "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
7      "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
8      "type": "text/plain",
9      "responseType": "application/vnd.sas.collection",
10      "responseItemType": "application/vnd.sas.job.execution.job"
11    },
12    {
13      "method": "POST",
14      "rel": "self",
15      "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
16      "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
17      "type": "text/plain",
18      "responseType": "application/vnd.sas.collection",
19      "responseItemType": "application/vnd.sas.job.execution.job"
20    },
21    {
22      "method": "POST",
23      "rel": "up",
24      "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/",
25      "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/",
26      "type": "text/plain",
27      "responseType": "application/vnd.sas.collection",
28      "responseItemType": "application/vnd.sas.job.execution.job"
29    },
30    {
31      "method": "POST",
32      "rel": "submitJob",
33      "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
34      "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4/jobs",
35      "responseType": "application/vnd.sas.job.execution.job"
36    }
37  ],
38  "name": "jobs",
39  "accept": "application/vnd.sas.job.execution.job",
40  "start": 0,
41  "count": 2,
42  "items": [
43    {
44      "creationTimeStamp": "2022-04-12T20:25:53.936Z",
45      "modifiedTimeStamp": "2022-04-12T20:26:14.424Z",
46      "createdBy": "user1",
47      "modifiedBy": "user1",
48      "version": 4,
49      "id": "2f52eecc-054b-45b0-837c-b3c21c6115a2",
50      "jobRequest": {
51        "creationTimeStamp": "2022-04-11T21:36:15.155Z",
52        "modifiedTimeStamp": "2022-04-11T21:36:15.155Z",
53        "createdBy": "sas.catalog",
54        "modifiedBy": "sas.catalog",
55        "version": 3,
56        "id": "3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
57        "name": "List Catalogs",
58        "jobDefinition": {
59          "creationTimeStamp": "0001-01-01T00:00:00.000Z",
60          "modifiedTimeStamp": "0001-01-01T00:00:00.000Z",
61          "version": 1,
62          "name": "List Catalogs",
63          "type": "Compute",
64          "parameters": [],
65          "code": "%macro web_list_catalogs(library);\n\t%let library=%upcase(&library);\n    proc sql ;\n        create table work.catalogs as select memname as Catalog, memtype as \n            Type, engine as Engine from sashelp.vmember where \n            libname=\"&library\" and memtype=\"CATALOG\";\n        run;\n        title \"Catalogs in &library\";\n\n    proc print data=work.catalogs;\n    run;\n%mend;\n\n%web_list_catalogs(SASHELP);\n",
66          "properties": []
67        },
68        "arguments": {
69          "_contextName": "SAS Job Execution compute context"
70        },
71        "properties": [],
72        "createdByApplication": "jobExecution",
73        "links": [
74          {
75            "method": "GET",
76            "rel": "self",
77            "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
78            "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
79            "type": "application/vnd.sas.job.execution.job.request"
80          }
81        ]
82      },
83      "state": "completed",
84      "endTimeStamp": "2022-04-12T20:26:14.423Z",
85      "heartbeatTimeStamp": "2022-04-12T20:25:54.349Z",
86      "submittedByApplication": "jobExecution",
87      "heartbeatInterval": 600,
88      "elapsedTime": 20487,
89      "results": {
90        "COMPUTE_CONTEXT": "SAS Studio compute context",
91        "1BCC3AB5-DC93-1040-8B87-B95E92D48DC5.log.txt": "/files/files/9ad6e3f4-998a-4512-922b-985ffa2f35bd",
92        "#LN00007": "/files/files/596eb924-93c7-48c8-a79c-b206f6f06df9",
93        "#LN00006": "/files/files/76962281-348a-4f57-978b-d3e42cd0677b",
94        "COMPUTE_JOB": "1BCC3AB5-DC93-1040-8B87-B95E92D48DC5",
95        "COMPUTE_SESSION": "13a661bb-68cc-4061-b49c-c989422c7199-ses0000 ended."
96      },
97      "logLocation": "/files/files/e685b834-ca4a-4de5-97e1-53474c3cfe7e",
98      "links": [
99        {
100          "method": "GET",
101          "rel": "self",
102          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2",
103          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2",
104          "type": "application/vnd.sas.job.execution.job"
105        },
106        {
107          "method": "GET",
108          "rel": "state",
109          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/state",
110          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/state",
111          "type": "text/plain"
112        },
113        {
114          "method": "PUT",
115          "rel": "update",
116          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2",
117          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2",
118          "type": "application/vnd.sas.job.execution.job",
119          "responseType": "application/vnd.sas.job.execution.job"
120        },
121        {
122          "method": "DELETE",
123          "rel": "delete",
124          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2",
125          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2"
126        },
127        {
128          "method": "PUT",
129          "rel": "updateState",
130          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/state",
131          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/state",
132          "type": "text/plain"
133        },
134        {
135          "method": "POST",
136          "rel": "updateHeartbeatTimeStamp",
137          "href": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/heartbeatTimeStamp",
138          "uri": "/jobExecution/jobs/2f52eecc-054b-45b0-837c-b3c21c6115a2/heartbeatTimeStamp",
139          "type": "text/plain"
140        },
141        {
142          "method": "GET",
143          "rel": "jobRequest",
144          "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
145          "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
146          "type": "application/vnd.sas.job.execution.job.request"
147        },
148        {
149          "method": "GET",
150          "rel": "log",
151          "href": "/files/files/e685b834-ca4a-4de5-97e1-53474c3cfe7e",
152          "uri": "/files/files/e685b834-ca4a-4de5-97e1-53474c3cfe7e"
153        }
154      ]
155    },
156    {
157      "creationTimeStamp": "2022-04-12T20:25:09.668Z",
158      "modifiedTimeStamp": "2022-04-12T20:25:30.334Z",
159      "createdBy": "user1",
160      "modifiedBy": "user1",
161      "version": 4,
162      "id": "f47d224c-5951-47df-b188-488635e04706",
163      "jobRequest": {
164        "creationTimeStamp": "2022-04-11T21:36:15.155Z",
165        "modifiedTimeStamp": "2022-04-11T21:36:15.155Z",
166        "createdBy": "sas.catalog",
167        "modifiedBy": "sas.catalog",
168        "version": 3,
169        "id": "3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
170        "name": "List Catalogs",
171        "jobDefinition": {
172          "creationTimeStamp": "0001-01-01T00:00:00.000Z",
173          "modifiedTimeStamp": "0001-01-01T00:00:00.000Z",
174          "version": 1,
175          "name": "List Catalogs",
176          "type": "Compute",
177          "parameters": [],
178          "code": "%macro web_list_catalogs(library);\n\t%let library=%upcase(&library);\n    proc sql ;\n        create table work.catalogs as select memname as Catalog, memtype as \n            Type, engine as Engine from sashelp.vmember where \n            libname=\"&library\" and memtype=\"CATALOG\";\n        run;\n        title \"Catalogs in &library\";\n\n    proc print data=work.catalogs;\n    run;\n%mend;\n\n%web_list_catalogs(SASHELP);\n",
179          "properties": []
180        },
181        "arguments": {
182          "_contextName": "SAS Job Execution compute context"
183        },
184        "properties": [],
185        "createdByApplication": "jobExecution",
186        "links": [
187          {
188            "method": "GET",
189            "rel": "self",
190            "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
191            "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
192            "type": "application/vnd.sas.job.execution.job.request"
193          }
194        ]
195      },
196      "state": "completed",
197      "endTimeStamp": "2022-04-12T20:25:30.333Z",
198      "heartbeatTimeStamp": "2022-04-12T20:25:10.755Z",
199      "submittedByApplication": "jobExecution",
200      "heartbeatInterval": 600,
201      "elapsedTime": 20665,
202      "results": {
203        "COMPUTE_CONTEXT": "SAS Studio compute context",
204        "#LN00007": "/files/files/3dd98070-7e7c-4790-9520-8c3457788d4d",
205        "#LN00006": "/files/files/6b607655-ec5d-4f80-b328-dcb44c193e21",
206        "COMPUTE_JOB": "57E97ADB-4900-A241-A0B1-90DD5E96D781",
207        "COMPUTE_SESSION": "b7260a74-e5f6-42fa-bcd9-431b98544148-ses0000 ended.",
208        "57E97ADB-4900-A241-A0B1-90DD5E96D781.log.txt": "/files/files/1b327089-72e3-4a93-a7e5-ea7615abfead"
209      },
210      "logLocation": "/files/files/030e858d-47f4-45eb-b9b4-2073257d16b8",
211      "links": [
212        {
213          "method": "GET",
214          "rel": "self",
215          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706",
216          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706",
217          "type": "application/vnd.sas.job.execution.job"
218        },
219        {
220          "method": "GET",
221          "rel": "state",
222          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/state",
223          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/state",
224          "type": "text/plain"
225        },
226        {
227          "method": "PUT",
228          "rel": "update",
229          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706",
230          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706",
231          "type": "application/vnd.sas.job.execution.job",
232          "responseType": "application/vnd.sas.job.execution.job"
233        },
234        {
235          "method": "DELETE",
236          "rel": "delete",
237          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706",
238          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706"
239        },
240        {
241          "method": "PUT",
242          "rel": "updateState",
243          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/state",
244          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/state",
245          "type": "text/plain"
246        },
247        {
248          "method": "POST",
249          "rel": "updateHeartbeatTimeStamp",
250          "href": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/heartbeatTimeStamp",
251          "uri": "/jobExecution/jobs/f47d224c-5951-47df-b188-488635e04706/heartbeatTimeStamp",
252          "type": "text/plain"
253        },
254        {
255          "method": "GET",
256          "rel": "jobRequest",
257          "href": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
258          "uri": "/jobExecution/jobRequests/3c6338bf-a2a0-4d2a-89d2-22d64ffb69e4",
259          "type": "application/vnd.sas.job.execution.job.request"
260        },
261        {
262          "method": "GET",
263          "rel": "log",
264          "href": "/files/files/030e858d-47f4-45eb-b9b4-2073257d16b8",
265          "uri": "/files/files/030e858d-47f4-45eb-b9b4-2073257d16b8"
266        }
267      ]
268    }
269  ],
270  "limit": 10,
271  "version": 2
272}

Path Parameters


jobRequestId	string	true	The ID of the job request.

Query Parameters


limit	integer	false	Represents the maximum number of jobs to return in this page of results. The actual number of returned jobs might be less if the collection has been exhausted. The default is 10.
sortBy	string<sort-criteria>	false	This determines the sort order of the returned jobs. The default sort order is descending on the creationTimeStamp field. the following sorts are examples: Sort ascending by ID: /jobExecution/jobRequests/{jobRequestId}/jobs?sortBy=id:ascending Sort descending by ID: /jobExecution/jobRequests/{jobRequestId}/jobs?sortBy=id:descending
start	integer	false	Represents the zero-based index of the first job to return. The default is 0 (zero).

Header Parameters


Delegate-Domain	string	false	The name of a credential domain of type OAuth2.0. The credential secret is retrieved to impersonate a group-managed service account for the current request.

Request Body

This determines the filter criteria for the returned jobs. The following request bodies are examples:

Filter by name: startsWith(name, 'myJob')
Filter by createdBy: eq(createdBy, 'myUserId')

Direct comparisons on values of results and jobRequest.properties are not guaranteed to work across all platforms. Use the contains function instead.

Responses

Status	Meaning	Description
200	OK	The request succeeded. The jobs (if any) are returned in a resource collection.	Schema
400	Bad Request	The request was invalid. An invalid request occurs in the following scenarios: A negative start value is provided. A negative limit value is provided. An unsupported field is specified in the sortBy parameter.	Schema
404	Not Found	No job request exists at the requested path.	Schema