Search Types

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-types \
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       "name": "name",
6       "propertyConfigs": {
7         "propertyConfigs": {
8           "isRequired": true,
9           "description": "description"
10         }
11       },
12       "createdAt": "2024-01-15T09:30:00Z",
13       "description": "description"
14     },
15     {
16       "rid": "rid",
17       "name": "name",
18       "propertyConfigs": {
19         "propertyConfigs": {
20           "isRequired": true,
21           "description": "description"
22         }
23       },
24       "createdAt": "2024-01-15T09:30:00Z",
25       "description": "description"
26     }
27   ],
28   "nextPageToken": "nextPageToken"
29 }

Update Asset Attachments

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/search-types \
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	"name": "name",
6	"propertyConfigs": {
7	"propertyConfigs": {
8	"isRequired": true,
9	"description": "description"
10	}
11	},
12	"createdAt": "2024-01-15T09:30:00Z",
13	"description": "description"
14	},
15	{
16	"rid": "rid",
17	"name": "name",
18	"propertyConfigs": {
19	"propertyConfigs": {
20	"isRequired": true,
21	"description": "description"
22	}
23	},
24	"createdAt": "2024-01-15T09:30:00Z",
25	"description": "description"
26	}
27	],
28	"nextPageToken": "nextPageToken"
29	}