Search Datasets By Text

POST

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.

includeArchivedbooleanOptionalDefaults to false

Defaults to false if not specified.

Response

This endpoint returns an object.

resultslist of objects

pageResponseobject

POST

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 '{}'

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       "description": "description",
46       "metadata": {
47         "metadata": "metadata"
48       },
49       "handle": {
50         "type": "s3",
51         "s3": {
52           "bucket": "bucket",
53           "key": "key"
54         }
55       },
56       "ingestStatus": "IN_PROGRESS",
57       "source": "source",
58       "bounds": {
59         "start": {
60           "seconds": 1000000,
61           "nanos": 1000000,
62           "picos": 1
63         },
64         "end": {
65           "seconds": 1000000,
66           "nanos": 1000000,
67           "picos": 1
68         },
69         "type": "ABSOLUTE"
70       }
71     },
72     {
73       "rid": "rid",
74       "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
75       "name": "name",
76       "displayName": "displayName",
77       "ingestDate": "2024-01-15T09:30:00Z",
78       "originMetadata": {
79         "path": "path",
80         "xSeriesIsAbsolute": true,
81         "schemaDirectivePath": "schemaDirectivePath",
82         "xSeriesColumnName": "xSeriesColumnName",
83         "xSeriesTimeUnit": "DAYS",
84         "timestampMetadata": {
85           "seriesName": "seriesName",
86           "timestampType": {
87             "type": "relative",
88             "relative": {
89               "timeUnit": "DAYS",
90               "offset": "2024-01-15T09:30:00Z"
91             }
92           }
93         },
94         "channelConfig": {
95           "prefixTreeDelimiter": "prefixTreeDelimiter"
96         }
97       },
98       "lastIngestStatus": {
99         "type": "success",
100         "success": {}
101       },
102       "retentionPolicy": {
103         "type": "KEEP_UNTIL_EXPIRY",
104         "expiryDays": 1
105       },
106       "timestampType": "ABSOLUTE",
107       "labels": [
108         "labels"
109       ],
110       "properties": {
111         "properties": "properties"
112       },
113       "granularity": "PICOSECONDS",
114       "description": "description",
115       "metadata": {
116         "metadata": "metadata"
117       },
118       "handle": {
119         "type": "s3",
120         "s3": {
121           "bucket": "bucket",
122           "key": "key"
123         }
124       },
125       "ingestStatus": "IN_PROGRESS",
126       "source": "source",
127       "bounds": {
128         "start": {
129           "seconds": 1000000,
130           "nanos": 1000000,
131           "picos": 1
132         },
133         "end": {
134           "seconds": 1000000,
135           "nanos": 1000000,
136           "picos": 1
137         },
138         "type": "ABSOLUTE"
139       }
140     }
141   ],
142   "pageResponse": {
143     "nextPageToken": "nextPageToken"
144   }
145 }

Search Datasets

Up Next

Built with

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 '{}'

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	"description": "description",
46	"metadata": {
47	"metadata": "metadata"
48	},
49	"handle": {
50	"type": "s3",
51	"s3": {
52	"bucket": "bucket",
53	"key": "key"
54	}
55	},
56	"ingestStatus": "IN_PROGRESS",
57	"source": "source",
58	"bounds": {
59	"start": {
60	"seconds": 1000000,
61	"nanos": 1000000,
62	"picos": 1
63	},
64	"end": {
65	"seconds": 1000000,
66	"nanos": 1000000,
67	"picos": 1
68	},
69	"type": "ABSOLUTE"
70	}
71	},
72	{
73	"rid": "rid",
74	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
75	"name": "name",
76	"displayName": "displayName",
77	"ingestDate": "2024-01-15T09:30:00Z",
78	"originMetadata": {
79	"path": "path",
80	"xSeriesIsAbsolute": true,
81	"schemaDirectivePath": "schemaDirectivePath",
82	"xSeriesColumnName": "xSeriesColumnName",
83	"xSeriesTimeUnit": "DAYS",
84	"timestampMetadata": {
85	"seriesName": "seriesName",
86	"timestampType": {
87	"type": "relative",
88	"relative": {
89	"timeUnit": "DAYS",
90	"offset": "2024-01-15T09:30:00Z"
91	}
92	}
93	},
94	"channelConfig": {
95	"prefixTreeDelimiter": "prefixTreeDelimiter"
96	}
97	},
98	"lastIngestStatus": {
99	"type": "success",
100	"success": {}
101	},
102	"retentionPolicy": {
103	"type": "KEEP_UNTIL_EXPIRY",
104	"expiryDays": 1
105	},
106	"timestampType": "ABSOLUTE",
107	"labels": [
108	"labels"
109	],
110	"properties": {
111	"properties": "properties"
112	},
113	"granularity": "PICOSECONDS",
114	"description": "description",
115	"metadata": {
116	"metadata": "metadata"
117	},
118	"handle": {
119	"type": "s3",
120	"s3": {
121	"bucket": "bucket",
122	"key": "key"
123	}
124	},
125	"ingestStatus": "IN_PROGRESS",
126	"source": "source",
127	"bounds": {
128	"start": {
129	"seconds": 1000000,
130	"nanos": 1000000,
131	"picos": 1
132	},
133	"end": {
134	"seconds": 1000000,
135	"nanos": 1000000,
136	"picos": 1
137	},
138	"type": "ABSOLUTE"
139	}
140	}
141	],
142	"pageResponse": {
143	"nextPageToken": "nextPageToken"
144	}
145	}