API docs by Redocly

Discovery Service Specification Profile SSP-001 Version 3.0 (V3.0.2_SSP-001)

Download OpenAPI specification:Download

License: CC BY 4.0

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.2_SSP-001

License: CC BY 4.0

Asset Administration Shell Basic Discovery

Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content

path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

aasIdentifier
required
string

The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)

header Parameters
Edc-Bpn
string

The external subject id (bpn) indicates which tenant is allowed to see the specificAssetId and find a Shell. Using this header requires separate OAuth2 role 'AAS EDC BPN Viewer', consult the docs for more information.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content

path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

aasIdentifier
required
string

The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)

Request Body schema: application/json
required

A list of specific Asset identifiers

Array
object (Reference)
Array of objects (Reference) <= 50 items unique
name
required
string [ 1 .. 64 ] characters ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud8...
value
required
string [ 1 .. 2000 ] characters ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud8...
object (Reference)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes all specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content

path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

aasIdentifier
required
string

The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

Description

Returns the self-describing information of a network resource (ServiceDescription)

path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

Responses

Response samples

Content type
application/json
"{\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}"