Get contents of a REST API definition

get/restApiDefinitions/{restApiDefinitionId}

Retrieves the contents of a REST API definition.

Request Samples

Response Samples

1{
2 "creationTimeStamp": "2023-01-15T10:30:00.000Z",
3 "modifiedTimeStamp": "2023-01-15T10:30:00.001Z",
4 "createdBy": "sasdemo",
5 "modifiedBy": "sasdemo",
6 "id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
7 "name": "ExampleAPI",
8 "description": "Get items",
9 "majorRevision": 1,
10 "minorRevision": 0,
11 "signature": [
12 {
13 "name": "responseBody",
14 "dataType": "string",
15 "direction": "output"
16 },
17 {
18 "name": "responseStatusCode",
19 "dataType": "integer",
20 "direction": "output"
21 }
22 ],
23 "queryParams": [],
24 "requestHeaders": [],
25 "responseHeaders": [],
26 "method": "GET",
27 "uriTemplate": "https://example.com/items",
28 "authorization": {
29 "authorizationType": "NONE"
30 },
31 "folderType": "myFolder",
32 "checkout": false,
33 "locked": false,
34 "revisionId": "e5f6a7b8-c9d0-1234-ef01-23456789abcd",
35 "revisionUri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901/revisions/e5f6a7b8-c9d0-1234-ef01-23456789abcd",
36 "links": [
37 {
38 "method": "GET",
39 "rel": "up",
40 "href": "/decisions/restApiDefinitions",
41 "uri": "/decisions/restApiDefinitions",
42 "type": "application/vnd.sas.collection"
43 },
44 {
45 "method": "GET",
46 "rel": "self",
47 "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
48 "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
49 "type": "application/vnd.sas.decision.rest.api.definition"
50 },
51 {
52 "method": "GET",
53 "rel": "alternate",
54 "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
55 "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
56 "type": "application/vnd.sas.summary"
57 },
58 {
59 "method": "DELETE",
60 "rel": "delete",
61 "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
62 "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901"
63 },
64 {
65 "method": "PUT",
66 "rel": "update",
67 "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
68 "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901",
69 "type": "application/vnd.sas.decision.rest.api.definition",
70 "responseType": "application/vnd.sas.decision.rest.api.definition"
71 },
72 {
73 "method": "GET",
74 "rel": "revisions",
75 "href": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901/revisions",
76 "uri": "/decisions/restApiDefinitions/c3d4e5f6-a7b8-9012-cdef-012345678901/revisions",
77 "type": "application/vnd.sas.collection"
78 }
79 ],
80 "version": 1
81}

Path Parameters

NameTypeRequiredDescription
restApiDefinitionId
string
true

The identifier for the REST API definition.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
404Not Found

No REST API definition exists at the requested path.

HeadersSchema