Search

POST

Results will be the latest commit on main for each checklist.

Request

This endpoint expects an object.

queryobjectRequired

sortByobjectOptional

If not present, will sort by LAST_USED in descending order.

nextPageTokenstringOptional

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1000.

archivedStatusesset of "ARCHIVED" or "NOT_ARCHIVED"Optional

Allowed values: ARCHIVEDNOT_ARCHIVED

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived checklists in search.

Response

This endpoint returns an object.

valueslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/checklists/search \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "query": {
6     "type": "and",
7     "and": [
8       {
9         "type": "and",
10         "and": [
11           {
12             "type": "and",
13             "and": [
14               {
15                 "type": "and",
16                 "and": [
17                   {
18                     "type": "and",
19                     "and": []
20                   },
21                   {
22                     "type": "and",
23                     "and": []
24                   }
25                 ]
26               },
27               {
28                 "type": "and",
29                 "and": [
30                   {
31                     "type": "and",
32                     "and": []
33                   },
34                   {
35                     "type": "and",
36                     "and": []
37                   }
38                 ]
39               }
40             ]
41           },
42           {
43             "type": "and",
44             "and": [
45               {
46                 "type": "and",
47                 "and": [
48                   {
49                     "type": "and",
50                     "and": []
51                   },
52                   {
53                     "type": "and",
54                     "and": []
55                   }
56                 ]
57               },
58               {
59                 "type": "and",
60                 "and": [
61                   {
62                     "type": "and",
63                     "and": []
64                   },
65                   {
66                     "type": "and",
67                     "and": []
68                   }
69                 ]
70               }
71             ]
72           }
73         ]
74       },
75       {
76         "type": "and",
77         "and": [
78           {
79             "type": "and",
80             "and": [
81               {
82                 "type": "and",
83                 "and": [
84                   {
85                     "type": "and",
86                     "and": []
87                   },
88                   {
89                     "type": "and",
90                     "and": []
91                   }
92                 ]
93               },
94               {
95                 "type": "and",
96                 "and": [
97                   {
98                     "type": "and",
99                     "and": []
100                   },
101                   {
102                     "type": "and",
103                     "and": []
104                   }
105                 ]
106               }
107             ]
108           },
109           {
110             "type": "and",
111             "and": [
112               {
113                 "type": "and",
114                 "and": [
115                   {
116                     "type": "and",
117                     "and": []
118                   },
119                   {
120                     "type": "and",
121                     "and": []
122                   }
123                 ]
124               },
125               {
126                 "type": "and",
127                 "and": [
128                   {
129                     "type": "and",
130                     "and": []
131                   },
132                   {
133                     "type": "and",
134                     "and": []
135                   }
136                 ]
137               }
138             ]
139           }
140         ]
141       }
142     ]
143   }
144 }'

200Successful

1 {
2   "values": [
3     {
4       "rid": "rid",
5       "metadata": {
6         "authorRid": "authorRid",
7         "assigneeRid": "assigneeRid",
8         "title": "title",
9         "description": "description",
10         "createdAt": "2024-01-15T09:30:00Z",
11         "properties": {
12           "properties": "properties"
13         },
14         "labels": [
15           "labels"
16         ],
17         "isArchived": true,
18         "isPublished": true,
19         "lastUsed": "2024-01-15T09:30:00Z"
20       },
21       "commit": {
22         "id": "id",
23         "resourceRid": "resourceRid",
24         "message": "message",
25         "isWorkingState": true,
26         "committedBy": "committedBy",
27         "committedAt": "2024-01-15T09:30:00Z",
28         "parentCommit": "parentCommit",
29         "mergeParentCommit": "mergeParentCommit"
30       },
31       "functions": [
32         {
33           "rid": "rid",
34           "functionLineageRid": "functionLineageRid",
35           "title": "title",
36           "description": "description",
37           "functionNode": {
38             "type": "enum",
39             "enum": {
40               "type": "aggregate",
41               "aggregate": {
42                 "input": {
43                   "type": "raw",
44                   "raw": {
45                     "name": "name"
46                   }
47                 },
48                 "function": "MIN"
49               }
50             }
51           },
52           "autoGeneratedTitle": "autoGeneratedTitle",
53           "autoGeneratedDescription": "autoGeneratedDescription"
54         },
55         {
56           "rid": "rid",
57           "functionLineageRid": "functionLineageRid",
58           "title": "title",
59           "description": "description",
60           "functionNode": {
61             "type": "enum",
62             "enum": {
63               "type": "aggregate",
64               "aggregate": {
65                 "input": {
66                   "type": "raw",
67                   "raw": {
68                     "name": "name"
69                   }
70                 },
71                 "function": "MIN"
72               }
73             }
74           },
75           "autoGeneratedTitle": "autoGeneratedTitle",
76           "autoGeneratedDescription": "autoGeneratedDescription"
77         }
78       ],
79       "checks": [
80         {
81           "type": "check",
82           "check": {
83             "rid": "rid",
84             "checkLineageRid": "checkLineageRid",
85             "title": "title",
86             "description": "description",
87             "priority": "P0",
88             "autoGeneratedTitle": "autoGeneratedTitle",
89             "autoGeneratedDescription": "autoGeneratedDescription",
90             "chart": {
91               "rid": "rid",
92               "version": 1
93             }
94           }
95         },
96         {
97           "type": "check",
98           "check": {
99             "rid": "rid",
100             "checkLineageRid": "checkLineageRid",
101             "title": "title",
102             "description": "description",
103             "priority": "P0",
104             "autoGeneratedTitle": "autoGeneratedTitle",
105             "autoGeneratedDescription": "autoGeneratedDescription",
106             "chart": {
107               "rid": "rid",
108               "version": 1
109             }
110           }
111         }
112       ],
113       "checklistVariables": [
114         {
115           "name": "name",
116           "value": {
117             "type": "checklistVariable",
118             "checklistVariable": "value"
119           },
120           "displayName": "displayName"
121         },
122         {
123           "name": "name",
124           "value": {
125             "type": "checklistVariable",
126             "checklistVariable": "value"
127           },
128           "displayName": "displayName"
129         }
130       ]
131     },
132     {
133       "rid": "rid",
134       "metadata": {
135         "authorRid": "authorRid",
136         "assigneeRid": "assigneeRid",
137         "title": "title",
138         "description": "description",
139         "createdAt": "2024-01-15T09:30:00Z",
140         "properties": {
141           "properties": "properties"
142         },
143         "labels": [
144           "labels"
145         ],
146         "isArchived": true,
147         "isPublished": true,
148         "lastUsed": "2024-01-15T09:30:00Z"
149       },
150       "commit": {
151         "id": "id",
152         "resourceRid": "resourceRid",
153         "message": "message",
154         "isWorkingState": true,
155         "committedBy": "committedBy",
156         "committedAt": "2024-01-15T09:30:00Z",
157         "parentCommit": "parentCommit",
158         "mergeParentCommit": "mergeParentCommit"
159       },
160       "functions": [
161         {
162           "rid": "rid",
163           "functionLineageRid": "functionLineageRid",
164           "title": "title",
165           "description": "description",
166           "functionNode": {
167             "type": "enum",
168             "enum": {
169               "type": "aggregate",
170               "aggregate": {
171                 "input": {
172                   "type": "raw",
173                   "raw": {
174                     "name": "name"
175                   }
176                 },
177                 "function": "MIN"
178               }
179             }
180           },
181           "autoGeneratedTitle": "autoGeneratedTitle",
182           "autoGeneratedDescription": "autoGeneratedDescription"
183         },
184         {
185           "rid": "rid",
186           "functionLineageRid": "functionLineageRid",
187           "title": "title",
188           "description": "description",
189           "functionNode": {
190             "type": "enum",
191             "enum": {
192               "type": "aggregate",
193               "aggregate": {
194                 "input": {
195                   "type": "raw",
196                   "raw": {
197                     "name": "name"
198                   }
199                 },
200                 "function": "MIN"
201               }
202             }
203           },
204           "autoGeneratedTitle": "autoGeneratedTitle",
205           "autoGeneratedDescription": "autoGeneratedDescription"
206         }
207       ],
208       "checks": [
209         {
210           "type": "check",
211           "check": {
212             "rid": "rid",
213             "checkLineageRid": "checkLineageRid",
214             "title": "title",
215             "description": "description",
216             "priority": "P0",
217             "autoGeneratedTitle": "autoGeneratedTitle",
218             "autoGeneratedDescription": "autoGeneratedDescription",
219             "chart": {
220               "rid": "rid",
221               "version": 1
222             }
223           }
224         },
225         {
226           "type": "check",
227           "check": {
228             "rid": "rid",
229             "checkLineageRid": "checkLineageRid",
230             "title": "title",
231             "description": "description",
232             "priority": "P0",
233             "autoGeneratedTitle": "autoGeneratedTitle",
234             "autoGeneratedDescription": "autoGeneratedDescription",
235             "chart": {
236               "rid": "rid",
237               "version": 1
238             }
239           }
240         }
241       ],
242       "checklistVariables": [
243         {
244           "name": "name",
245           "value": {
246             "type": "checklistVariable",
247             "checklistVariable": "value"
248           },
249           "displayName": "displayName"
250         },
251         {
252           "name": "name",
253           "value": {
254             "type": "checklistVariable",
255             "checklistVariable": "value"
256           },
257           "displayName": "displayName"
258         }
259       ]
260     }
261   ],
262   "nextPageToken": "nextPageToken"
263 }

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/checklists/search \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"query": {
6	"type": "and",
7	"and": [
8	{
9	"type": "and",
10	"and": [
11	{
12	"type": "and",
13	"and": [
14	{
15	"type": "and",
16	"and": [
17	{
18	"type": "and",
19	"and": []
20	},
21	{
22	"type": "and",
23	"and": []
24	}
25	]
26	},
27	{
28	"type": "and",
29	"and": [
30	{
31	"type": "and",
32	"and": []
33	},
34	{
35	"type": "and",
36	"and": []
37	}
38	]
39	}
40	]
41	},
42	{
43	"type": "and",
44	"and": [
45	{
46	"type": "and",
47	"and": [
48	{
49	"type": "and",
50	"and": []
51	},
52	{
53	"type": "and",
54	"and": []
55	}
56	]
57	},
58	{
59	"type": "and",
60	"and": [
61	{
62	"type": "and",
63	"and": []
64	},
65	{
66	"type": "and",
67	"and": []
68	}
69	]
70	}
71	]
72	}
73	]
74	},
75	{
76	"type": "and",
77	"and": [
78	{
79	"type": "and",
80	"and": [
81	{
82	"type": "and",
83	"and": [
84	{
85	"type": "and",
86	"and": []
87	},
88	{
89	"type": "and",
90	"and": []
91	}
92	]
93	},
94	{
95	"type": "and",
96	"and": [
97	{
98	"type": "and",
99	"and": []
100	},
101	{
102	"type": "and",
103	"and": []
104	}
105	]
106	}
107	]
108	},
109	{
110	"type": "and",
111	"and": [
112	{
113	"type": "and",
114	"and": [
115	{
116	"type": "and",
117	"and": []
118	},
119	{
120	"type": "and",
121	"and": []
122	}
123	]
124	},
125	{
126	"type": "and",
127	"and": [
128	{
129	"type": "and",
130	"and": []
131	},
132	{
133	"type": "and",
134	"and": []
135	}
136	]
137	}
138	]
139	}
140	]
141	}
142	]
143	}
144	}'

1	{
2	"values": [
3	{
4	"rid": "rid",
5	"metadata": {
6	"authorRid": "authorRid",
7	"assigneeRid": "assigneeRid",
8	"title": "title",
9	"description": "description",
10	"createdAt": "2024-01-15T09:30:00Z",
11	"properties": {
12	"properties": "properties"
13	},
14	"labels": [
15	"labels"
16	],
17	"isArchived": true,
18	"isPublished": true,
19	"lastUsed": "2024-01-15T09:30:00Z"
20	},
21	"commit": {
22	"id": "id",
23	"resourceRid": "resourceRid",
24	"message": "message",
25	"isWorkingState": true,
26	"committedBy": "committedBy",
27	"committedAt": "2024-01-15T09:30:00Z",
28	"parentCommit": "parentCommit",
29	"mergeParentCommit": "mergeParentCommit"
30	},
31	"functions": [
32	{
33	"rid": "rid",
34	"functionLineageRid": "functionLineageRid",
35	"title": "title",
36	"description": "description",
37	"functionNode": {
38	"type": "enum",
39	"enum": {
40	"type": "aggregate",
41	"aggregate": {
42	"input": {
43	"type": "raw",
44	"raw": {
45	"name": "name"
46	}
47	},
48	"function": "MIN"
49	}
50	}
51	},
52	"autoGeneratedTitle": "autoGeneratedTitle",
53	"autoGeneratedDescription": "autoGeneratedDescription"
54	},
55	{
56	"rid": "rid",
57	"functionLineageRid": "functionLineageRid",
58	"title": "title",
59	"description": "description",
60	"functionNode": {
61	"type": "enum",
62	"enum": {
63	"type": "aggregate",
64	"aggregate": {
65	"input": {
66	"type": "raw",
67	"raw": {
68	"name": "name"
69	}
70	},
71	"function": "MIN"
72	}
73	}
74	},
75	"autoGeneratedTitle": "autoGeneratedTitle",
76	"autoGeneratedDescription": "autoGeneratedDescription"
77	}
78	],
79	"checks": [
80	{
81	"type": "check",
82	"check": {
83	"rid": "rid",
84	"checkLineageRid": "checkLineageRid",
85	"title": "title",
86	"description": "description",
87	"priority": "P0",
88	"autoGeneratedTitle": "autoGeneratedTitle",
89	"autoGeneratedDescription": "autoGeneratedDescription",
90	"chart": {
91	"rid": "rid",
92	"version": 1
93	}
94	}
95	},
96	{
97	"type": "check",
98	"check": {
99	"rid": "rid",
100	"checkLineageRid": "checkLineageRid",
101	"title": "title",
102	"description": "description",
103	"priority": "P0",
104	"autoGeneratedTitle": "autoGeneratedTitle",
105	"autoGeneratedDescription": "autoGeneratedDescription",
106	"chart": {
107	"rid": "rid",
108	"version": 1
109	}
110	}
111	}
112	],
113	"checklistVariables": [
114	{
115	"name": "name",
116	"value": {
117	"type": "checklistVariable",
118	"checklistVariable": "value"
119	},
120	"displayName": "displayName"
121	},
122	{
123	"name": "name",
124	"value": {
125	"type": "checklistVariable",
126	"checklistVariable": "value"
127	},
128	"displayName": "displayName"
129	}
130	]
131	},
132	{
133	"rid": "rid",
134	"metadata": {
135	"authorRid": "authorRid",
136	"assigneeRid": "assigneeRid",
137	"title": "title",
138	"description": "description",
139	"createdAt": "2024-01-15T09:30:00Z",
140	"properties": {
141	"properties": "properties"
142	},
143	"labels": [
144	"labels"
145	],
146	"isArchived": true,
147	"isPublished": true,
148	"lastUsed": "2024-01-15T09:30:00Z"
149	},
150	"commit": {
151	"id": "id",
152	"resourceRid": "resourceRid",
153	"message": "message",
154	"isWorkingState": true,
155	"committedBy": "committedBy",
156	"committedAt": "2024-01-15T09:30:00Z",
157	"parentCommit": "parentCommit",
158	"mergeParentCommit": "mergeParentCommit"
159	},
160	"functions": [
161	{
162	"rid": "rid",
163	"functionLineageRid": "functionLineageRid",
164	"title": "title",
165	"description": "description",
166	"functionNode": {
167	"type": "enum",
168	"enum": {
169	"type": "aggregate",
170	"aggregate": {
171	"input": {
172	"type": "raw",
173	"raw": {
174	"name": "name"
175	}
176	},
177	"function": "MIN"
178	}
179	}
180	},
181	"autoGeneratedTitle": "autoGeneratedTitle",
182	"autoGeneratedDescription": "autoGeneratedDescription"
183	},
184	{
185	"rid": "rid",
186	"functionLineageRid": "functionLineageRid",
187	"title": "title",
188	"description": "description",
189	"functionNode": {
190	"type": "enum",
191	"enum": {
192	"type": "aggregate",
193	"aggregate": {
194	"input": {
195	"type": "raw",
196	"raw": {
197	"name": "name"
198	}
199	},
200	"function": "MIN"
201	}
202	}
203	},
204	"autoGeneratedTitle": "autoGeneratedTitle",
205	"autoGeneratedDescription": "autoGeneratedDescription"
206	}
207	],
208	"checks": [
209	{
210	"type": "check",
211	"check": {
212	"rid": "rid",
213	"checkLineageRid": "checkLineageRid",
214	"title": "title",
215	"description": "description",
216	"priority": "P0",
217	"autoGeneratedTitle": "autoGeneratedTitle",
218	"autoGeneratedDescription": "autoGeneratedDescription",
219	"chart": {
220	"rid": "rid",
221	"version": 1
222	}
223	}
224	},
225	{
226	"type": "check",
227	"check": {
228	"rid": "rid",
229	"checkLineageRid": "checkLineageRid",
230	"title": "title",
231	"description": "description",
232	"priority": "P0",
233	"autoGeneratedTitle": "autoGeneratedTitle",
234	"autoGeneratedDescription": "autoGeneratedDescription",
235	"chart": {
236	"rid": "rid",
237	"version": 1
238	}
239	}
240	}
241	],
242	"checklistVariables": [
243	{
244	"name": "name",
245	"value": {
246	"type": "checklistVariable",
247	"checklistVariable": "value"
248	},
249	"displayName": "displayName"
250	},
251	{
252	"name": "name",
253	"value": {
254	"type": "checklistVariable",
255	"checklistVariable": "value"
256	},
257	"displayName": "displayName"
258	}
259	]
260	}
261	],
262	"nextPageToken": "nextPageToken"
263	}