Get

GET

https://api.gov.nominal.io/api/scout/v1/checklists/:rid

GET

/api/scout/v1/checklists/:rid

1 curl https://api.gov.nominal.io/api/scout/v1/checklists/rid \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "rid": "rid",
3   "metadata": {
4     "authorRid": "authorRid",
5     "assigneeRid": "assigneeRid",
6     "title": "title",
7     "description": "description",
8     "createdAt": "2024-01-15T09:30:00Z",
9     "properties": {
10       "properties": "properties"
11     },
12     "labels": [
13       "labels"
14     ],
15     "isArchived": true,
16     "isPublished": true,
17     "lastUsed": "2024-01-15T09:30:00Z"
18   },
19   "commit": {
20     "id": "id",
21     "resourceRid": "resourceRid",
22     "message": "message",
23     "isWorkingState": true,
24     "committedBy": "committedBy",
25     "committedAt": "2024-01-15T09:30:00Z",
26     "parentCommit": "parentCommit",
27     "mergeParentCommit": "mergeParentCommit"
28   },
29   "functions": [
30     {
31       "rid": "rid",
32       "functionLineageRid": "functionLineageRid",
33       "title": "title",
34       "description": "description",
35       "functionNode": {
36         "type": "enum",
37         "enum": {
38           "type": "aggregate",
39           "aggregate": {
40             "input": {
41               "type": "aggregate",
42               "aggregate": {
43                 "input": {
44                   "type": "raw",
45                   "raw": {
46                     "name": "name"
47                   }
48                 },
49                 "function": "MIN"
50               }
51             },
52             "function": "MIN"
53           }
54         }
55       },
56       "autoGeneratedTitle": "autoGeneratedTitle",
57       "autoGeneratedDescription": "autoGeneratedDescription"
58     },
59     {
60       "rid": "rid",
61       "functionLineageRid": "functionLineageRid",
62       "title": "title",
63       "description": "description",
64       "functionNode": {
65         "type": "enum",
66         "enum": {
67           "type": "aggregate",
68           "aggregate": {
69             "input": {
70               "type": "aggregate",
71               "aggregate": {
72                 "input": {
73                   "type": "raw",
74                   "raw": {
75                     "name": "name"
76                   }
77                 },
78                 "function": "MIN"
79               }
80             },
81             "function": "MIN"
82           }
83         }
84       },
85       "autoGeneratedTitle": "autoGeneratedTitle",
86       "autoGeneratedDescription": "autoGeneratedDescription"
87     }
88   ],
89   "checks": [
90     {
91       "type": "check",
92       "check": {
93         "rid": "rid",
94         "checkLineageRid": "checkLineageRid",
95         "title": "title",
96         "description": "description",
97         "priority": "P0",
98         "autoGeneratedTitle": "autoGeneratedTitle",
99         "autoGeneratedDescription": "autoGeneratedDescription",
100         "chart": {
101           "rid": "rid",
102           "version": 1
103         },
104         "condition": {
105           "type": "numRanges",
106           "numRanges": {
107             "ranges": {
108               "type": "function",
109               "function": {
110                 "functionReference": "functionReference",
111                 "functionIdentifier": {
112                   "type": "variable",
113                   "variable": "functionIdentifier"
114                 }
115               }
116             },
117             "functionSpec": {
118               "key": "value"
119             },
120             "threshold": 1,
121             "operator": "GREATER_THAN",
122             "variables": {
123               "variables": {
124                 "dataSourceRef": "dataSourceRef",
125                 "channel": "channel",
126                 "tags": {
127                   "tags": "tags"
128                 }
129               }
130             }
131           }
132         }
133       }
134     },
135     {
136       "type": "check",
137       "check": {
138         "rid": "rid",
139         "checkLineageRid": "checkLineageRid",
140         "title": "title",
141         "description": "description",
142         "priority": "P0",
143         "autoGeneratedTitle": "autoGeneratedTitle",
144         "autoGeneratedDescription": "autoGeneratedDescription",
145         "chart": {
146           "rid": "rid",
147           "version": 1
148         },
149         "condition": {
150           "type": "numRanges",
151           "numRanges": {
152             "ranges": {
153               "type": "function",
154               "function": {
155                 "functionReference": "functionReference",
156                 "functionIdentifier": {
157                   "type": "variable",
158                   "variable": "functionIdentifier"
159                 }
160               }
161             },
162             "functionSpec": {
163               "key": "value"
164             },
165             "threshold": 1,
166             "operator": "GREATER_THAN",
167             "variables": {
168               "variables": {
169                 "dataSourceRef": "dataSourceRef",
170                 "channel": "channel",
171                 "tags": {
172                   "tags": "tags"
173                 }
174               }
175             }
176           }
177         }
178       }
179     }
180   ],
181   "checklistVariables": [
182     {
183       "name": "name",
184       "value": {
185         "type": "checklistVariable",
186         "checklistVariable": "value"
187       },
188       "displayName": "displayName"
189     },
190     {
191       "name": "name",
192       "value": {
193         "type": "checklistVariable",
194         "checklistVariable": "value"
195       },
196       "displayName": "displayName"
197     }
198   ]
199 }

Specify at most one of (branch, commit). If neither is specified, branch = “main” is the default.

Path parameters

ridstringRequired

Query parameters

branchstringOptional

commitstringOptional

40 hex character unique identifier.

Response

This endpoint returns an object.

ridstring

metadataobject

commitobject

functionslist of objects

A list of functions that are available to be used by checks in this checklist.

checkslist of objects

checklistVariableslist of objects

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.

Path parameters

Headers

Query parameters

Response