Skip to content

Add column to Submodel Element List with specified idShortPath. Column is itself a Submodel Element.

POST
/passports/:id/submodels/:submodelId/submodel-elements/:idShortPath/columns

Parameters

Path Parameters

id*

The id

Type
string
Required
Example"958b741c-c2ef-4366-a134-fafd30210ed4"
submodelId*

The submodel id

Type
string
Required
Example"032a7e62-29e2-4530-8f4b-765e32514a56"
idShortPath*

IdShort path to the submodel element (dot-separated)

Type
string
Required
Example"path1.path2.path3"
Pattern
"^[^./]+(?:\\.[^./]+)*$"

Query Parameters

position

The position of the element in the result listing. The first element has position 0.

Type
number
Example1

Request Body

application/json
JSON
{
  
"category": "string",
  
"idShort": "string",
  
"displayName": [
  
  
{
  
  
  
"language": "string",
  
  
  
"text": "string"
  
  
}
  
],
  
"description": [
  
  
{
  
  
  
"language": "string",
  
  
  
"text": "string"
  
  
}
  
],
  
"semanticId": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"supplementalSemanticIds": [
  
  
{
  
  
  
"type": "string",
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
"keys": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"value": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"qualifiers": [
  
  
{
  
  
  
"type": "string",
  
  
  
"valueType": "string",
  
  
  
"semanticId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
},
  
  
  
"supplementalSemanticIds": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"kind": "string",
  
  
  
"value": "string",
  
  
  
"valueId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
}
  
],
  
"embeddedDataSpecifications": [
  
  
{
  
  
  
"dataSpecification": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
}
  
],
  
"first": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"second": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"extensions": [
  
  
{
  
  
  
"name": "string",
  
  
  
"semanticId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
},
  
  
  
"supplementalSemanticIds": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"valueType": "string",
  
  
  
"value": "string",
  
  
  
"refersTo": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"annotations": [
  
  
{
  
  
}
  
],
  
"modelType": "AnnotatedRelationshipElement"
}

Responses

application/json
JSON
{
  
"category": "string",
  
"idShort": "string",
  
"displayName": [
  
  
{
  
  
  
"language": "string",
  
  
  
"text": "string"
  
  
}
  
],
  
"description": [
  
  
{
  
  
  
"language": "string",
  
  
  
"text": "string"
  
  
}
  
],
  
"semanticId": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"supplementalSemanticIds": [
  
  
{
  
  
  
"type": "string",
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
"keys": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"value": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"qualifiers": [
  
  
{
  
  
  
"type": "string",
  
  
  
"valueType": "string",
  
  
  
"semanticId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
},
  
  
  
"supplementalSemanticIds": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"kind": "string",
  
  
  
"value": "string",
  
  
  
"valueId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
}
  
],
  
"embeddedDataSpecifications": [
  
  
{
  
  
  
"dataSpecification": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
}
  
],
  
"first": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"second": {
  
  
"type": "string",
  
  
"referredSemanticId": "[Circular Reference]",
  
  
"keys": [
  
  
  
{
  
  
  
  
"type": "string",
  
  
  
  
"value": "string"
  
  
  
}
  
  
]
  
},
  
"extensions": [
  
  
{
  
  
  
"name": "string",
  
  
  
"semanticId": {
  
  
  
  
"type": "string",
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
"keys": [
  
  
  
  
  
{
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
},
  
  
  
"supplementalSemanticIds": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"valueType": "string",
  
  
  
"value": "string",
  
  
  
"refersTo": [
  
  
  
  
{
  
  
  
  
  
"type": "string",
  
  
  
  
  
"referredSemanticId": "[Circular Reference]",
  
  
  
  
  
"keys": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"annotations": [
  
  
{
  
  
}
  
],
  
"modelType": "AnnotatedRelationshipElement"
}

Playground

Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI