Get a list of job requests

get/jobRequests

Returns a collection of application/vnd.sas.job.execution.job.request resources. Standard paging, filtering, and sorting options are specified in the Query Parameters section.

Request Samples

Response Samples


1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/jobExecution/jobRequests",
7      "uri": "/jobExecution/jobRequests",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.job.execution.job.request"
10    },
11    {
12      "method": "GET",
13      "rel": "self",
14      "href": "/jobExecution/jobRequests?sortBy=name:ascending&start=0&limit=10",
15      "uri": "/jobExecution/jobRequests?sortBy=name:ascending&start=0&limit=10",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.job.execution.job.request"
18    },
19    {
20      "method": "GET",
21      "rel": "next",
22      "href": "/jobExecution/jobRequests?sortBy=name:ascending&start=10&limit=10",
23      "uri": "/jobExecution/jobRequests?sortBy=name:ascending&start=10&limit=10",
24      "type": "application/vnd.sas.collection",
25      "itemType": "application/vnd.sas.job.execution.job.request"
26    },
27    {
28      "method": "GET",
29      "rel": "up",
30      "href": "/jobExecution",
31      "uri": "/jobExecution",
32      "type": "application/vnd.sas.api"
33    },
34    {
35      "method": "POST",
36      "rel": "createJobRequest",
37      "href": "/jobExecution/jobRequests",
38      "uri": "/jobExecution/jobRequests",
39      "type": "application/vnd.sas.job.execution.job.request"
40    },
41    {
42      "method": "POST",
43      "rel": "import",
44      "href": "/jobExecution/jobRequests",
45      "uri": "/jobExecution/jobRequests",
46      "type": "application/vnd.sas.transfer.object",
47      "responseType": "application/vnd.sas.summary"
48    }
49  ],
50  "name": "jobRequests",
51  "accept": "application/vnd.sas.job.execution.job.request",
52  "start": 0,
53  "count": 2,
54  "items": [
55    {
56      "creationTimeStamp": "2022-04-06T22:09:12.929Z",
57      "modifiedTimeStamp": "2022-04-06T22:09:12.929Z",
58      "createdBy": "sas.catalog",
59      "modifiedBy": "sas.catalog",
60      "version": 3,
61      "id": "fe697677-15a8-4d33-807c-6c34b743bb8b",
62      "name": "List Catalogs",
63      "jobDefinition": {
64        "creationTimeStamp": "0001-01-01T00:00:00.000Z",
65        "modifiedTimeStamp": "0001-01-01T00:00:00.000Z",
66        "version": 1,
67        "name": "List Catalogs",
68        "type": "Compute",
69        "parameters": [],
70        "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",
71        "properties": []
72      },
73      "arguments": {
74        "_contextName": "SAS Job Execution compute context"
75      },
76      "properties": [],
77      "links": [
78        {
79          "method": "GET",
80          "rel": "self",
81          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
82          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
83          "type": "application/vnd.sas.job.execution.job.request"
84        },
85        {
86          "method": "GET",
87          "rel": "alternate",
88          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
89          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
90          "type": "application/vnd.sas.summary"
91        },
92        {
93          "method": "GET",
94          "rel": "export",
95          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
96          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
97          "type": "application/vnd.sas.transfer.object"
98        },
99        {
100          "method": "DELETE",
101          "rel": "delete",
102          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
103          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b"
104        },
105        {
106          "method": "PUT",
107          "rel": "update",
108          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
109          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
110          "type": "application/vnd.sas.job.execution.job.request"
111        },
112        {
113          "method": "PUT",
114          "rel": "import",
115          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
116          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b",
117          "type": "application/vnd.sas.transfer.object",
118          "responseType": "application/vnd.sas.summary"
119        },
120        {
121          "method": "GET",
122          "rel": "up",
123          "href": "/jobExecution/jobRequests",
124          "uri": "/jobExecution/jobRequests",
125          "type": "application/vnd.sas.collection",
126          "itemType": "application/vnd.sas.job.execution.job.request"
127        },
128        {
129          "method": "GET",
130          "rel": "jobs",
131          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b/jobs",
132          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b/jobs",
133          "type": "application/vnd.sas.collection",
134          "itemType": "application/vnd.sas.job.execution.job"
135        },
136        {
137          "method": "POST",
138          "rel": "submitJob",
139          "href": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b/jobs",
140          "uri": "/jobExecution/jobRequests/fe697677-15a8-4d33-807c-6c34b743bb8b/jobs",
141          "responseType": "application/vnd.sas.job.execution.job"
142        }
143      ]
144    },
145    {
146      "creationTimeStamp": "2022-04-06T22:09:32.844Z",
147      "modifiedTimeStamp": "2022-04-06T22:09:32.844Z",
148      "createdBy": "sas.dataFlows",
149      "modifiedBy": "sas.dataFlows",
150      "version": 3,
151      "id": "1af4342a-41ef-4d70-bbfc-a2ef96687890",
152      "name": "Rebuild Catalog index \"dataflows\"",
153      "description": "Rebuild Information Catalog Index \"dataflows\"",
154      "jobDefinition": {
155        "creationTimeStamp": "0001-01-01T00:00:00.000Z",
156        "modifiedTimeStamp": "0001-01-01T00:00:00.000Z",
157        "version": 0,
158        "name": "indexMaintenance",
159        "type": "CATALOG",
160        "parameters": [],
161        "code": "{\"index\":\"dataflows\"}",
162        "properties": []
163      },
164      "arguments": {},
165      "properties": [],
166      "links": [
167        {
168          "method": "GET",
169          "rel": "self",
170          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
171          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
172          "type": "application/vnd.sas.job.execution.job.request"
173        },
174        {
175          "method": "GET",
176          "rel": "alternate",
177          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
178          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
179          "type": "application/vnd.sas.summary"
180        },
181        {
182          "method": "GET",
183          "rel": "export",
184          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
185          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
186          "type": "application/vnd.sas.transfer.object"
187        },
188        {
189          "method": "DELETE",
190          "rel": "delete",
191          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
192          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890"
193        },
194        {
195          "method": "PUT",
196          "rel": "update",
197          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
198          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
199          "type": "application/vnd.sas.job.execution.job.request"
200        },
201        {
202          "method": "PUT",
203          "rel": "import",
204          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
205          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890",
206          "type": "application/vnd.sas.transfer.object",
207          "responseType": "application/vnd.sas.summary"
208        },
209        {
210          "method": "GET",
211          "rel": "up",
212          "href": "/jobExecution/jobRequests",
213          "uri": "/jobExecution/jobRequests",
214          "type": "application/vnd.sas.collection",
215          "itemType": "application/vnd.sas.job.execution.job.request"
216        },
217        {
218          "method": "GET",
219          "rel": "jobs",
220          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890/jobs",
221          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890/jobs",
222          "type": "application/vnd.sas.collection",
223          "itemType": "application/vnd.sas.job.execution.job"
224        },
225        {
226          "method": "POST",
227          "rel": "submitJob",
228          "href": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890/jobs",
229          "uri": "/jobExecution/jobRequests/1af4342a-41ef-4d70-bbfc-a2ef96687890/jobs",
230          "responseType": "application/vnd.sas.job.execution.job"
231        }
232      ]
233    }
234  ],
235  "limit": 2,
236  "version": 2
237}

Query Parameters


filter	string<filter-criteria>	false	The criteria for filtering the returned job requests. The supported functions are: and, or, not, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. The following queries are examples: Search by name starting with the following: /jobExecution/jobRequests?filter=startsWith(name, 'myJobRe') Search by name: /jobExecution/jobRequests?filter=eq(name, 'myJobRequest1') Search for multiple job requests: /jobExecution/jobRequests?filter=in(name, 'myJobRequest1', 'myJobRequest2', 'myJobRequest3') Direct comparisons on values of `arguments` and `properties` are not guaranteed to work across all platforms. Use the `contains` function instead.
limit	integer	false	The maximum number of job requests to return in this page of results. The actual number of returned job requests might be less if the collection has been exhausted. The default is 10.
sortBy	string<sort-criteria>	false	Specifies how to sort the returned job requests. The sort criteria supports all job requests in either ascending or descending order except for jobDefinition, links, or version. The following sorts are examples: Sort ascending by name: /jobExecution/jobRequests?sortBy=name:ascending Sort descending by name: /jobExecution/jobRequests?sortBy=name:descending The default sort is by name in ascending order.
start	integer	false	The starting index of the first job request in a page. The default is 0 (zero).

Responses

Status	Meaning	Description
200	OK	The request succeeded. The job requests (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