Batch Get

POST

Returns the pinned commit for each provided checklist reference.

Request

This endpoint expects a set of objects.

ridstringRequired

commitstringRequired

40 hex character unique identifier.

Response

This endpoint returns a set of objects.

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.

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/checklists/batch-get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   {
6     "rid": "rid",
7     "commit": "commit"
8   }
9 ]'

200Successful

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

Batch Get Metadata

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/checklists/batch-get \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"rid": "rid",
7	"commit": "commit"
8	}
9	]'

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