Verify external data source usability

Required capabilities: transformationsExternalDataSourcesAcl:USE

Check whether an external data source can be used by a transformation.

Returns the external id and the latest usableVersion of the data source. If usableVersion is not present in the response, the resource is missing or inaccessible.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
externalId
required
string (CogniteExternalId) <= 255 characters

The external ID provided by the client. Must be unique for the resource type.

Responses
200

Usability status for the external data source.

400

The response for a bad request.

403

The response for a forbidden request.

409

The response for a conflict.

post/transformations/externaldata/usability
Request samples
application/json
{
  • "externalId": "my.known.id"
}
Response samples
application/json
{
  • "externalId": {
    • "externalId": "my-onelake-source"
    },
  • "usableVersion": "550e8400-e29b-41d4-a716-446655440000"
}