Get module

get/modules/{moduleId}

For the specified module, returns detailed information including the steps that are contained in the module.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "up",
6      "href": "/microanalyticScore/modules",
7      "uri": "/microanalyticScore/modules",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.microanalytic.module"
10    },
11    {
12      "method": "GET",
13      "rel": "self",
14      "href": "/microanalyticScore/modules/samplemodule",
15      "uri": "/microanalyticScore/modules/samplemodule",
16      "type": "application/vnd.sas.microanalytic.module"
17    },
18    {
19      "method": "GET",
20      "rel": "source",
21      "href": "/microanalyticScore/modules/samplemodule/source",
22      "uri": "/microanalyticScore/modules/samplemodule/source",
23      "type": "application/vnd.sas.microanalytic.module.source"
24    },
25    {
26      "method": "GET",
27      "rel": "steps",
28      "href": "/microanalyticScore/modules/samplemodule/steps",
29      "uri": "/microanalyticScore/modules/samplemodule/steps",
30      "type": "application/vnd.sas.collection",
31      "itemType": "application/vnd.sas.microanalytic.module.step"
32    },
33    {
34      "method": "GET",
35      "rel": "submodules",
36      "href": "/microanalyticScore/modules/samplemodule/submodules",
37      "uri": "/microanalyticScore/modules/samplemodule/submodules",
38      "type": "application/vnd.sas.collection",
39      "itemType": "application/vnd.sas.microanalytic.submodule"
40    },
41    {
42      "method": "PUT",
43      "rel": "update",
44      "href": "/microanalyticScore/modules/samplemodule",
45      "uri": "/microanalyticScore/modules/samplemodule",
46      "type": "application/vnd.sas.microanalytic.module",
47      "responseType": "application/vnd.sas.microanalytic.module"
48    },
49    {
50      "method": "DELETE",
51      "rel": "delete",
52      "href": "/microanalyticScore/modules/samplemodule",
53      "uri": "/microanalyticScore/modules/samplemodule"
54    }
55  ],
56  "version": 2,
57  "createdBy": "sasdemo",
58  "creationTimeStamp": "2022-03-15T21:19:04.062Z",
59  "modifiedBy": "sasdemo",
60  "modifiedTimeStamp": "2022-03-15T21:19:04.062Z",
61  "id": "samplemodule",
62  "name": "sampleModule",
63  "revision": 0,
64  "description": "Sample module",
65  "scope": "public",
66  "language": "ds2",
67  "stepIds": [
68    "copy_charn_array",
69    "copy_varchar_array",
70    "copy_int_array",
71    "copy_float_array",
72    "copy_bigint_array",
73    "copy_arrays"
74  ],
75  "warnings": []
76}

Path Parameters

NameTypeRequiredDescription
moduleId
string
true

The identifier of the module to retrieve.

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The Etag that is returned from a GET, POST, or PUT of this module.

If-Unmodified-Since
string
false

The value of the 'lastModified' date of the module. If the module has been updated since this time, the update will fail.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
404Not Found

The requested module could not be found.

Schema