Search Assets

POST

Request

This endpoint expects an object.

sortobjectRequired

queryobjectRequired

pageSizeintegerOptional

Page sizes greater than 10_000 will be rejected. Default pageSize is 100.

nextPageTokenstringOptional

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 assets in search.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/search-assets \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "sort": {
6     "isDescending": true,
7     "field": "CREATED_AT"
8   },
9   "query": {
10     "type": "searchText",
11     "searchText": "query"
12   }
13 }'

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "title": "title",
6       "properties": {
7         "properties": "properties"
8       },
9       "labels": [
10         "labels"
11       ],
12       "links": [
13         {
14           "url": "url",
15           "title": "title"
16         },
17         {
18           "url": "url",
19           "title": "title"
20         }
21       ],
22       "dataScopes": [
23         {
24           "dataScopeName": "dataScopeName",
25           "dataSource": {
26             "type": "dataset",
27             "dataset": "dataSource"
28           },
29           "timestampType": "ABSOLUTE",
30           "seriesTags": {
31             "seriesTags": "seriesTags"
32           },
33           "offset": {
34             "seconds": 1000000,
35             "nanos": 1000000,
36             "picos": 1
37           }
38         },
39         {
40           "dataScopeName": "dataScopeName",
41           "dataSource": {
42             "type": "dataset",
43             "dataset": "dataSource"
44           },
45           "timestampType": "ABSOLUTE",
46           "seriesTags": {
47             "seriesTags": "seriesTags"
48           },
49           "offset": {
50             "seconds": 1000000,
51             "nanos": 1000000,
52             "picos": 1
53           }
54         }
55       ],
56       "createdAt": "2024-01-15T09:30:00Z",
57       "updatedAt": "2024-01-15T09:30:00Z",
58       "attachments": [
59         "attachments"
60       ],
61       "description": "description",
62       "createdBy": "createdBy",
63       "type": "type"
64     },
65     {
66       "rid": "rid",
67       "title": "title",
68       "properties": {
69         "properties": "properties"
70       },
71       "labels": [
72         "labels"
73       ],
74       "links": [
75         {
76           "url": "url",
77           "title": "title"
78         },
79         {
80           "url": "url",
81           "title": "title"
82         }
83       ],
84       "dataScopes": [
85         {
86           "dataScopeName": "dataScopeName",
87           "dataSource": {
88             "type": "dataset",
89             "dataset": "dataSource"
90           },
91           "timestampType": "ABSOLUTE",
92           "seriesTags": {
93             "seriesTags": "seriesTags"
94           },
95           "offset": {
96             "seconds": 1000000,
97             "nanos": 1000000,
98             "picos": 1
99           }
100         },
101         {
102           "dataScopeName": "dataScopeName",
103           "dataSource": {
104             "type": "dataset",
105             "dataset": "dataSource"
106           },
107           "timestampType": "ABSOLUTE",
108           "seriesTags": {
109             "seriesTags": "seriesTags"
110           },
111           "offset": {
112             "seconds": 1000000,
113             "nanos": 1000000,
114             "picos": 1
115           }
116         }
117       ],
118       "createdAt": "2024-01-15T09:30:00Z",
119       "updatedAt": "2024-01-15T09:30:00Z",
120       "attachments": [
121         "attachments"
122       ],
123       "description": "description",
124       "createdBy": "createdBy",
125       "type": "type"
126     }
127   ],
128   "nextPageToken": "nextPageToken"
129 }

Search Types

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/search-assets \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"sort": {
6	"isDescending": true,
7	"field": "CREATED_AT"
8	},
9	"query": {
10	"type": "searchText",
11	"searchText": "query"
12	}
13	}'

1	{
2	"results": [
3	{
4	"rid": "rid",
5	"title": "title",
6	"properties": {
7	"properties": "properties"
8	},
9	"labels": [
10	"labels"
11	],
12	"links": [
13	{
14	"url": "url",
15	"title": "title"
16	},
17	{
18	"url": "url",
19	"title": "title"
20	}
21	],
22	"dataScopes": [
23	{
24	"dataScopeName": "dataScopeName",
25	"dataSource": {
26	"type": "dataset",
27	"dataset": "dataSource"
28	},
29	"timestampType": "ABSOLUTE",
30	"seriesTags": {
31	"seriesTags": "seriesTags"
32	},
33	"offset": {
34	"seconds": 1000000,
35	"nanos": 1000000,
36	"picos": 1
37	}
38	},
39	{
40	"dataScopeName": "dataScopeName",
41	"dataSource": {
42	"type": "dataset",
43	"dataset": "dataSource"
44	},
45	"timestampType": "ABSOLUTE",
46	"seriesTags": {
47	"seriesTags": "seriesTags"
48	},
49	"offset": {
50	"seconds": 1000000,
51	"nanos": 1000000,
52	"picos": 1
53	}
54	}
55	],
56	"createdAt": "2024-01-15T09:30:00Z",
57	"updatedAt": "2024-01-15T09:30:00Z",
58	"attachments": [
59	"attachments"
60	],
61	"description": "description",
62	"createdBy": "createdBy",
63	"type": "type"
64	},
65	{
66	"rid": "rid",
67	"title": "title",
68	"properties": {
69	"properties": "properties"
70	},
71	"labels": [
72	"labels"
73	],
74	"links": [
75	{
76	"url": "url",
77	"title": "title"
78	},
79	{
80	"url": "url",
81	"title": "title"
82	}
83	],
84	"dataScopes": [
85	{
86	"dataScopeName": "dataScopeName",
87	"dataSource": {
88	"type": "dataset",
89	"dataset": "dataSource"
90	},
91	"timestampType": "ABSOLUTE",
92	"seriesTags": {
93	"seriesTags": "seriesTags"
94	},
95	"offset": {
96	"seconds": 1000000,
97	"nanos": 1000000,
98	"picos": 1
99	}
100	},
101	{
102	"dataScopeName": "dataScopeName",
103	"dataSource": {
104	"type": "dataset",
105	"dataset": "dataSource"
106	},
107	"timestampType": "ABSOLUTE",
108	"seriesTags": {
109	"seriesTags": "seriesTags"
110	},
111	"offset": {
112	"seconds": 1000000,
113	"nanos": 1000000,
114	"picos": 1
115	}
116	}
117	],
118	"createdAt": "2024-01-15T09:30:00Z",
119	"updatedAt": "2024-01-15T09:30:00Z",
120	"attachments": [
121	"attachments"
122	],
123	"description": "description",
124	"createdBy": "createdBy",
125	"type": "type"
126	}
127	],
128	"nextPageToken": "nextPageToken"
129	}