Trigger Ingest

Triggers an ingest job for the given data source. The ingest job will be processed asynchronously.

Request

This endpoint expects an object.

sourceobjectRequired

propertiesmap from strings to stringsRequired

labelsset of stringsRequired

datasetNamestringOptional

datasetDescriptionstringOptional

timestampMetadataobjectOptional

channelConfigobjectOptional

If absent, will default to a channel config that constructs a prefix tree with . as the delimiter.

workspacestringOptional

The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

Response

This endpoint returns an object.

datasetRidstring

datasetFileIdUUIDOptional

asyncHandleobjectOptional

1	curl -X POST https://api.gov.nominal.io/api/ingest/v1/trigger-ingest-v2 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"source": {
6	"type": "s3",
7	"s3": {
8	"path": "path"
9	}
10	},
11	"properties": {
12	"properties": "properties"
13	},
14	"labels": [
15	"labels"
16	]
17	}'

1	{
2	"datasetRid": "datasetRid",
3	"datasetFileId": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4	"asyncHandle": {
5	"rid": "rid"
6	}
7	}

Headers

Request

Response