Get Instance schema.

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.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
project
required
string

The project name.

query Parameters
conflictMode
string

conflict mode of the transformation. One of the following conflictMode types can be provided: upsert, delete

Enum: "abort" "upsert" "update" "delete"
viewSpace
string non-empty

Space of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.

viewExternalId
string non-empty

External id of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.

viewVersion
string non-empty

Version of the View. Not required if isConnectionDefinition is true. Relevant for View centric schema.

instanceType
string

Instance type to deal with

Enum: "nodes" "edges"
withInstanceSpace
boolean

Is instance space set at the transformation config or not

isConnectionDefinition
boolean

If the edge is a connection definition or not

dataModelSpace
string non-empty

Space of the Data Model. Relevant for Data Model centric schema.

dataModelExternalId
string non-empty

External id of the Data Model. Relevant for Data Model centric schema.

dataModelVersion
string non-empty

Version of the Data Model. Relevant for Data Model centric schema.

type
string non-empty

External id of the View in the Data model. Relevant for Data Model centric schema.

relationshipFromType
string non-empty

Property Identifier of Connection Definition in type. Relevant for Data Model centric schema.

Responses
200

Response with the schema columns of the target schema type

400

The response for a failed request.

403

The response for a forbidden request.

get/transformations/schema/instances
Request samples
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}