Get the collection of types

get/types

Returns a collection of types.

Request Samples

1

Response Samples

1{
2 "value": {
3 "links": [
4 {
5 "method": "GET",
6 "rel": "self",
7 "href": "/clinicalRepository/types?start=0&limit=41",
8 "uri": "/clinicalRepository/types?start=0&limit=41",
9 "type": "application/vnd.sas.collection",
10 "itemType": "application/vnd.sas.clinical.type+json"
11 },
12 {
13 "method": "GET",
14 "rel": "collection",
15 "href": "/clinicalRepository/types",
16 "uri": "/clinicalRepository/types",
17 "type": "application/vnd.sas.collection",
18 "itemType": "application/vnd.sas.clinical.type+json"
19 }
20 ],
21 "name": "types",
22 "accept": "application/vnd.sas.clinical.type+json",
23 "start": 0,
24 "count": 4,
25 "items": [
26 {
27 "version": 1,
28 "id": "name",
29 "name": "Name",
30 "attributeType": "STRING",
31 "required": true,
32 "searchable": true
33 },
34 {
35 "version": 1,
36 "id": "description",
37 "name": "Description",
38 "attributeType": "STRING",
39 "logicalType": "MULTILINE",
40 "required": false,
41 "searchable": true
42 },
43 {
44 "version": 1,
45 "id": "createdBy",
46 "name": "Created by",
47 "attributeType": "STRING",
48 "logicalType": "USER",
49 "required": true,
50 "searchable": true
51 },
52 {
53 "version": 1,
54 "id": "created",
55 "name": "Date created",
56 "attributeType": "DATE",
57 "logicalType": "DATETIME",
58 "required": true,
59 "searchable": true
60 }
61 ],
62 "limit": 100,
63 "version": 2
64 }
65}

Query Parameters

NameTypeRequiredDescription
auditable
boolean
false

Filter criteria based on whether it is auditable.

searchable
boolean
false

Filter criteria based on whether it is searchable.

Responses

StatusMeaningDescription
200OK

The request succeeded and matching types are returned.

Schema