Download OpenAPI specification:Download
Attribution 1
Title: CX-0002 DIGITAL TWINS IN CATENA-X Version 2.0
Publisher: Catena-X Automotive Network e.V.
Attribution 2
Title: Discovery Service Specification Profile SSP-001 Version 3.0
Publisher: Industrial Digital Twin Association e.V.
Source: https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.0.1_SSP-001
License: CC BY 4.0
| tenantId required | string <uuid> Unique identifier of the owning tenant. |
| assetIds | Array of strings Example: assetIds=?assetIds=eyAibmFtZSI6ICJzb21lLWFzc2V0LWlkIiwgInZhbHVlIjogImh0dHA6Ly9leGFtcGxlLWNvbXBhbnkuY29tL215QXNzZXQiLCAiZXh0ZXJuYWxTdWJqZWN0SWQiOiB7ICJrZXlzIjogWyB7ICJ0eXBlIjogIkdsb2JhbFJlZmVyZW5jZSIsICJ2YWx1ZSI6ICJodHRwOi8vZXhhbXBsZS1jb21wYW55LmNvbS9leGFtcGxlLWNvbXBhbnlzLWFzc2V0LWtleXMiIH0gXSwgInR5cGUiOiAiR2xvYmFsUmVmZXJlbmNlIiB9IH0&assetIds=eyAibmFtZSI6ICJzb21lLW90aGVyLWFzc2V0LWlkIiwgInZhbHVlIjogIjEyMzQ1QUJDIiwgImV4dGVybmFsU3ViamVjdElkIjogeyAia2V5cyI6IFsgeyAidHlwZSI6ICJHbG9iYWxSZWZlcmVuY2UiLCAidmFsdWUiOiAiaHR0cDovL215LW93bi1jb21wYW55LmNvbS9rZXlzIiB9IF0sICJ0eXBlIjogIkdsb2JhbFJlZmVyZW5jZSIgfSB9 A list of specific Asset identifiers. Each Asset identifier is a base64-url-encoded SpecificAssetId |
| limit | integer >= 1 The maximum number of elements in the response array |
| cursor | string A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue |
| Edc-Bpn required | string The external subject id (bpn) indicates which tenant is allowed to see the specificAssetId and find a Shell. |
{- "paging_metadata": {
- "cursor": "wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#"
}, - "result": [
- "string"
]
}| tenantId required | string <uuid> Unique identifier of the owning tenant. |
| aasIdentifier required | string <byte> The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) |
| Edc-Bpn required | string The external subject id (bpn) indicates which tenant is allowed to see the specificAssetId and find a Shell. |
[- {
- "semanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}, - "supplementalSemanticIds": [
- {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
], - "name": "string",
- "value": "string",
- "externalSubjectId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
}
]| tenantId required | string <uuid> Unique identifier of the owning tenant. |
| aasIdentifier required | string <byte> The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) |
A list of specific Asset identifiers
object (Reference) | |
Array of objects (Reference) <= 50 items unique | |
| name required | string [ 1 .. 64 ] characters ^([\t\n\r \_\.\/\:\#\-a-zA-Z0-9]|[\ud800\udc0... |
| value required | string [ 1 .. 2000 ] characters ^([\t\n\r \_\.\/\:\#\-a-zA-Z0-9]|[\ud800\udc0... |
object (Reference) |
[- {
- "semanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}, - "supplementalSemanticIds": [
- {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
], - "name": "string",
- "value": "string",
- "externalSubjectId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
}
][- {
- "semanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}, - "supplementalSemanticIds": [
- {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
], - "name": "string",
- "value": "string",
- "externalSubjectId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
], - "referredSemanticId": {
- "type": "ExternalReference",
- "keys": [
- {
- "type": "AnnotatedRelationshipElement",
- "value": "string"
}
]
}
}
}
]| tenantId required | string <uuid> Unique identifier of the owning tenant. |
| aasIdentifier required | string <byte> The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded) |
{- "messages": [
- {
- "code": "string",
- "correlationId": "string",
- "messageType": "Undefined",
- "text": "string",
- "timestamp": "string"
}
]
}| tenantId required | string <uuid> Unique identifier of the owning tenant. |
"{\n \"profiles\": [\n \"https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002\",\n \"https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002\"\n ]\n}"