Get a list of REST API definitions

get/restApiDefinitions

Returns a resource collection of all REST API definitions.

Request Samples

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/decisions/restApiDefinitions",
7      "uri": "/decisions/restApiDefinitions",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=2&limit=1",
14      "uri": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=2&limit=1",
15      "type": "application/vnd.sas.collection",
16      "itemType": "application/vnd.sas.summary"
17    },
18    {
19      "method": "GET",
20      "rel": "first",
21      "href": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=0&limit=1",
22      "uri": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=0&limit=1",
23      "type": "application/vnd.sas.collection",
24      "itemType": "application/vnd.sas.summary"
25    },
26    {
27      "method": "GET",
28      "rel": "prev",
29      "href": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=1&limit=1",
30      "uri": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=1&limit=1",
31      "type": "application/vnd.sas.collection",
32      "itemType": "application/vnd.sas.summary"
33    },
34    {
35      "method": "GET",
36      "rel": "next",
37      "href": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=3&limit=1",
38      "uri": "/decisions/restApiDefinitions?sortBy=creationTimeStamp:descending&start=3&limit=1",
39      "type": "application/vnd.sas.collection",
40      "itemType": "application/vnd.sas.summary"
41    },
42    {
43      "method": "POST",
44      "rel": "create",
45      "href": "/decisions/restApiDefinitions",
46      "uri": "/decisions/restApiDefinitions",
47      "type": "application/vnd.sas.decision.rest.api.definition",
48      "responseType": "application/vnd.sas.decision.rest.api.definition"
49    }
50  ],
51  "name": "restApiDefinitions",
52  "accept": "application/vnd.sas.summary",
53  "start": 0,
54  "items": [
55    {
56      "creationTimeStamp": "2023-01-15T10:30:00.000Z",
57      "modifiedTimeStamp": "2023-01-15T10:30:00.001Z",
58      "createdBy": "sasdemo",
59      "modifiedBy": "sasdemo",
60      "id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
61      "type": "decisionRESTAPIDefinition",
62      "name": "ExampleAPI",
63      "links": [
64        {
65          "method": "GET",
66          "rel": "up",
67          "href": "/decisions/restApiDefinitions",
68          "uri": "/decisions/restApiDefinitions",
69          "type": "application/vnd.sas.collection"
70        },
71        {
72          "method": "GET",
73          "rel": "self",
74          "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
75          "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
76          "type": "application/vnd.sas.decision.rest.api.definition"
77        }
78      ]
79    }
80  ]
81}

Query Parameters

NameTypeRequiredDescription
parentFolderUri
string</folders/folders/{parentFolderId}>
false

The folder in which the target REST API definitions are located.

filter
string<filter-criteria>
false

The criteria for filtering the REST API definitions. See Filtering in REST APIs.

The following properties support filtering:

  • createdBy
  • modifiedBy
  • creationTimeStamp
  • modifiedTimeStamp
  • id
  • name
  • description
  • majorRevision
  • minorRevision
  • signature.name
  • signature.description
  • signature.dataType
  • signature.length
  • signature.direction
limit
integer
false

The maximum number of items to return on this page of results. The actual number of returned items might be less if the collection has been exhausted.

Default:
10
sortBy
string<sort-criteria>
false

The criteria for sorting the REST API definitions. See Sorting in REST APIs. The following properties support sorting:

  • createdBy * modifiedBy * creationTimeStamp * modifiedTimeStamp * id * name * description * majorRevision * minorRevision
Default:
creationTimeStamp:descending
start
integer
false

The starting index for the first item on a page. The index is 0-based.

Default:
0

Header Parameters

NameTypeRequiredDescription
Accept-Item
string<media-type>
false

The desired item representation.

Allowed values:
application/vnd.sas.decision.rest.api.definition+jsonapplication/vnd.sas.summary+jsonapplication/vnd.sas.dcm.summary+json
Default:
application/vnd.sas.summary+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

HeadersSchema
406Not Acceptable

The request was not acceptable. An invalid media type was specified for the Accept-Item header value.

HeadersSchema