Search Datasets By Text

POST

https://api.gov.nominal.io/api/catalog/v1/search-datasets

POST

/api/catalog/v1/search-datasets

1 curl -X POST https://api.gov.nominal.io/api/catalog/v1/search-datasets \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6       "name": "name",
7       "displayName": "displayName",
8       "ingestDate": "2024-01-15T09:30:00Z",
9       "originMetadata": {
10         "path": "path",
11         "xSeriesIsAbsolute": true,
12         "schemaDirectivePath": "schemaDirectivePath",
13         "xSeriesColumnName": "xSeriesColumnName",
14         "xSeriesTimeUnit": "DAYS",
15         "timestampMetadata": {
16           "seriesName": "seriesName",
17           "timestampType": {
18             "type": "relative",
19             "relative": {
20               "timeUnit": "DAYS",
21               "offset": "2024-01-15T09:30:00Z"
22             }
23           }
24         },
25         "channelConfig": {
26           "prefixTreeDelimiter": "prefixTreeDelimiter"
27         }
28       },
29       "lastIngestStatus": {
30         "type": "success",
31         "success": {}
32       },
33       "retentionPolicy": {
34         "type": "KEEP_UNTIL_EXPIRY",
35         "expiryDays": 1
36       },
37       "timestampType": "ABSOLUTE",
38       "labels": [
39         "labels"
40       ],
41       "properties": {
42         "properties": "properties"
43       },
44       "granularity": "PICOSECONDS",
45       "allowStreaming": true,
46       "description": "description",
47       "metadata": {
48         "metadata": "metadata"
49       },
50       "handle": {
51         "type": "s3",
52         "s3": {
53           "bucket": "bucket",
54           "key": "key"
55         }
56       },
57       "ingestStatus": "IN_PROGRESS",
58       "source": "source",
59       "bounds": {
60         "start": {
61           "seconds": 1000000,
62           "nanos": 1000000,
63           "picos": 1
64         },
65         "end": {
66           "seconds": 1000000,
67           "nanos": 1000000,
68           "picos": 1
69         },
70         "type": "ABSOLUTE"
71       }
72     },
73     {
74       "rid": "rid",
75       "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
76       "name": "name",
77       "displayName": "displayName",
78       "ingestDate": "2024-01-15T09:30:00Z",
79       "originMetadata": {
80         "path": "path",
81         "xSeriesIsAbsolute": true,
82         "schemaDirectivePath": "schemaDirectivePath",
83         "xSeriesColumnName": "xSeriesColumnName",
84         "xSeriesTimeUnit": "DAYS",
85         "timestampMetadata": {
86           "seriesName": "seriesName",
87           "timestampType": {
88             "type": "relative",
89             "relative": {
90               "timeUnit": "DAYS",
91               "offset": "2024-01-15T09:30:00Z"
92             }
93           }
94         },
95         "channelConfig": {
96           "prefixTreeDelimiter": "prefixTreeDelimiter"
97         }
98       },
99       "lastIngestStatus": {
100         "type": "success",
101         "success": {}
102       },
103       "retentionPolicy": {
104         "type": "KEEP_UNTIL_EXPIRY",
105         "expiryDays": 1
106       },
107       "timestampType": "ABSOLUTE",
108       "labels": [
109         "labels"
110       ],
111       "properties": {
112         "properties": "properties"
113       },
114       "granularity": "PICOSECONDS",
115       "allowStreaming": true,
116       "description": "description",
117       "metadata": {
118         "metadata": "metadata"
119       },
120       "handle": {
121         "type": "s3",
122         "s3": {
123           "bucket": "bucket",
124           "key": "key"
125         }
126       },
127       "ingestStatus": "IN_PROGRESS",
128       "source": "source",
129       "bounds": {
130         "start": {
131           "seconds": 1000000,
132           "nanos": 1000000,
133           "picos": 1
134         },
135         "end": {
136           "seconds": 1000000,
137           "nanos": 1000000,
138           "picos": 1
139         },
140         "type": "ABSOLUTE"
141       }
142     }
143   ],
144   "pageResponse": {
145     "nextPageToken": "nextPageToken"
146   }
147 }

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

searchTextstringOptional

includeFilterslist of objectsOptional

excludeFilterslist of objectsOptional

pageRequestobjectOptional

The PageRequest.pageToken must be an integer offset. If a PageRequest.pageSize is not provided, the default page size (100) will be used.

includeArchivedbooleanOptional

Defaults to false if not specified.

Response

This endpoint returns an object.

resultslist of objects

pageResponseobject