API reference (20230101-alpha)
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schema/instances \
--header 'Authorization: Bearer <token>'{
"items": [
{
"name": "<string>",
"sqlType": "<string>",
"type": {
"type": "<string>"
},
"nullable": true
}
]
}Get Instance schema.
Required capabilities:
transformationsAcl:READ
For View centric schema, viewSpace, viewExternalId, viewVersion need to be specified while withInstanceSpace, isConnectionDefinition, instanceType are optional . For Data Model centric schema, dataModelSpace, dataModelExternalId, dataModelVersion, type need to be specified and relationshipFromType is optional. For Both scenarios conflictMode is required.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/schema/instances \
--header 'Authorization: Bearer <token>'{
"items": [
{
"name": "<string>",
"sqlType": "<string>",
"type": {
"type": "<string>"
},
"nullable": true
}
]
}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.
Query Parameters
conflict mode of the transformation.
One of the following conflictMode types can be provided:
upsert, delete
abort, upsert, update, delete Space of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.
1External id of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.
1Version of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.
1Instance type to deal with
nodes, edges Is instance space set at the transformation config or not
If the edge is a connection definition or not
Space of the Data Model. Relevant for Data Model centric schema.
1External id of the Data Model. Relevant for Data Model centric schema.
1Version of the Data Model. Relevant for Data Model centric schema.
1External id of the View in the Data model. Relevant for Data Model centric schema.
1Property Identifier of Connection Definition in type. Relevant for Data Model centric schema.
1Response
Response with the schema columns of the target schema type
Show child attributes
Show child attributes
Was this page helpful?