Get jobs

get/jobs

Internal-Use Only

Retrieves the collection of jobs that have been submitted to the service. Standard paging options are supported.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/microanalyticScore/jobs",
7      "uri": "/microanalyticScore/jobs",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/microanalyticScore/jobs?start=0&limit=20",
14      "uri": "/microanalyticScore/jobs?start=0&limit=20",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "POST",
19      "rel": "createJob",
20      "href": "/microanalyticScore/jobs",
21      "uri": "/microanalyticScore/jobs",
22      "type": "application/vnd.sas.microanalytic.module.definition",
23      "responseType": "application/vnd.sas.microanalytic.job"
24    }
25  ],
26  "name": "jobs",
27  "accept": "application/vnd.sas.microanalytic.job",
28  "start": 0,
29  "count": 1,
30  "items": [
31    {
32      "links": [
33        {
34          "method": "GET",
35          "rel": "up",
36          "href": "/microanalyticScore/jobs",
37          "uri": "/microanalyticScore/jobs",
38          "type": "application/vnd.sas.collection",
39          "itemType": "application/vnd.sas.microanalytic.job"
40        },
41        {
42          "method": "GET",
43          "rel": "self",
44          "href": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9",
45          "uri": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9",
46          "type": "application/vnd.sas.microanalytic.job"
47        },
48        {
49          "method": "GET",
50          "rel": "source",
51          "href": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9/source",
52          "uri": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9/source",
53          "type": "application/vnd.sas.microanalytic.module.source"
54        },
55        {
56          "method": "GET",
57          "rel": "submodules",
58          "href": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9/submodules",
59          "uri": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9/submodules",
60          "type": "application/vnd.sas.collection",
61          "itemType": "application/vnd.sas.microanalytic.submodule"
62        },
63        {
64          "method": "DELETE",
65          "rel": "delete",
66          "href": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9",
67          "uri": "/microanalyticScore/jobs/8418e47f-0593-4fdf-9bc8-407242e4d6b9"
68        },
69        {
70          "method": "GET",
71          "rel": "module",
72          "href": "/microanalyticScore/modules/driverpackage_job",
73          "uri": "/microanalyticScore/modules/driverpackage_job",
74          "type": "application/vnd.sas.microanalytic.module"
75        }
76      ],
77      "version": 1,
78      "createdBy": "sasdemo",
79      "creationTimeStamp": "2022-05-10T20:16:21.416Z",
80      "modifiedBy": "sasdemo",
81      "modifiedTimeStamp": "2022-05-10T20:16:27.336Z",
82      "id": "8418e47f-0593-4fdf-9bc8-407242e4d6b9",
83      "description": "driver package",
84      "moduleId": "driverpackage_job",
85      "operation": "create",
86      "state": "completed",
87      "errors": []
88    }
89  ],
90  "limit": 20,
91  "version": 2
92}

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The criteria for filtering the modules. See Filtering in REST APIs.
limit	integer	false	The maximum number of jobs to return. Default: 20
sortBy	string<sort-criteria>	false	The criteria for sorting the modules. See Sorting in REST APIs.
start	integer<int64>	false	The index of the first job to return. Default: 0

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema