Search Filtered Channels

POST

Returns channels that match the search criteria. Results are sorted by similarity score.

Request

This endpoint expects an object.

fuzzySearchTextstringRequired

exactMatchset of stringsRequired

Will return only channels that contain all strings specified as exact matches (case insensitive).

dataSourcesset of stringsRequired

tagsmap from strings to maps from strings to stringsRequired

For each data source specified as a key, search will only return channels containing a superset of the tags specified for that given datasource. If a data source is present in the dataSources field but not in this map, or if a data source points to an empty map of tags, it will be searched without tag filters.

previouslySelectedChannelsmap from strings to sets of stringsOptional

resultSizeintegerOptional

Defaults to 10000. Will throw if larger than 10000.

minDataUpdatedTimeobjectOptional

If specified, search will only return channels that have had new data after the specified time.

maxDataStartTimeobjectOptional

If specified, search will only return channels that have data before the specified time.

Response

This endpoint returns an object.

resultslist of objects

POST

1 curl -X POST https://api.gov.nominal.io/api/data-source/v1/data-sources/search-filtered-channels \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "fuzzySearchText": "fuzzySearchText",
6   "exactMatch": [
7     "exactMatch"
8   ],
9   "dataSources": [
10     "dataSources"
11   ],
12   "tags": {
13     "tags": {
14       "tags": "tags"
15     }
16   }
17 }'

200Successful

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

Search Hierarchical Channels

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/data-source/v1/data-sources/search-filtered-channels \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"fuzzySearchText": "fuzzySearchText",
6	"exactMatch": [
7	"exactMatch"
8	],
9	"dataSources": [
10	"dataSources"
11	],
12	"tags": {
13	"tags": {
14	"tags": "tags"
15	}
16	}
17	}'

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