API reference (20230101-alpha)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/preview/download \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "my.known.id"
}
'"<string>"Download preview result
Required capabilities:
hostedExtractors:READ
Download the raw, binary result of a preview job, before it is passed throguh any transformations. Note that this endpoint will return 404 if there is no raw data.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/preview/download \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "my.known.id"
}
'"<string>"Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
External ID of preview job to get result for.
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
Response
Raw result from the preview.
The response is of type file.
Was this page helpful?