Search Templates

POST

https://api.gov.nominal.io/api/scout/v1/template/search

POST

/api/scout/v1/template/search

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/template/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 }'

Try it

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "metadata": {
6         "title": "title",
7         "description": "description",
8         "labels": [
9           "labels"
10         ],
11         "properties": {
12           "properties": "properties"
13         },
14         "isArchived": true,
15         "isPublished": true,
16         "createdBy": "createdBy",
17         "createdAt": "2024-01-15T09:30:00Z",
18         "updatedAt": "2024-01-15T09:30:00Z",
19         "editedAt": "2024-01-15T09:30:00Z"
20       }
21     },
22     {
23       "rid": "rid",
24       "metadata": {
25         "title": "title",
26         "description": "description",
27         "labels": [
28           "labels"
29         ],
30         "properties": {
31           "properties": "properties"
32         },
33         "isArchived": true,
34         "isPublished": true,
35         "createdBy": "createdBy",
36         "createdAt": "2024-01-15T09:30:00Z",
37         "updatedAt": "2024-01-15T09:30:00Z",
38         "editedAt": "2024-01-15T09:30:00Z"
39       }
40     }
41   ],
42   "nextPageToken": "nextPageToken"
43 }

Request

This endpoint expects an object.

queryobjectRequired

sortByobjectOptional

EDITED_AT descending by default

nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1_000.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

Headers

Request

Response