Search Channels

POST

Path parameters

ridstringRequired

Request

This endpoint expects an object.

searchTextstringRequired

previouslySelectedChannelsmap from strings to sets of stringsRequired

refNameFilterset of stringsOptional

If not empty, will filter to channels from the selected DataSourceRefNames.

nextPageTokenstringOptional

pageSizeintegerOptional

Defaults to 1000. Will throw if larger than 10000.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/run/rid/search-channels \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "searchText": "searchText",
6   "previouslySelectedChannels": {
7     "previouslySelectedChannels": [
8       "previouslySelectedChannels"
9     ]
10   }
11 }'

200Successful

1 {
2   "results": [
3     {
4       "name": "name",
5       "dataSource": {
6         "type": "dataset",
7         "dataset": "dataSource"
8       },
9       "unit": {
10         "symbol": "symbol",
11         "name": "name"
12       },
13       "description": "description",
14       "dataType": "DOUBLE"
15     },
16     {
17       "name": "name",
18       "dataSource": {
19         "type": "dataset",
20         "dataset": "dataSource"
21       },
22       "unit": {
23         "symbol": "symbol",
24         "name": "name"
25       },
26       "description": "description",
27       "dataType": "DOUBLE"
28     }
29   ],
30   "nextPageToken": "nextPageToken"
31 }

Get Events

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/run/rid/search-channels \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"searchText": "searchText",
6	"previouslySelectedChannels": {
7	"previouslySelectedChannels": [
8	"previouslySelectedChannels"
9	]
10	}
11	}'

1	{
2	"results": [
3	{
4	"name": "name",
5	"dataSource": {
6	"type": "dataset",
7	"dataset": "dataSource"
8	},
9	"unit": {
10	"symbol": "symbol",
11	"name": "name"
12	},
13	"description": "description",
14	"dataType": "DOUBLE"
15	},
16	{
17	"name": "name",
18	"dataSource": {
19	"type": "dataset",
20	"dataset": "dataSource"
21	},
22	"unit": {
23	"symbol": "symbol",
24	"name": "name"
25	},
26	"description": "description",
27	"dataType": "DOUBLE"
28	}
29	],
30	"nextPageToken": "nextPageToken"
31	}