Assign Shell labels

Shell labels are attributes for Asset Administration Shells within the Digital Twin Registry AAS V3.0. Use them to categorize Shells according to your needs.

Managing Shell labels

The relationship between a Shell and its labels is managed exclusively through the /shell-descriptorsexternallink 20 endpoint:

Restrictions

  • Shell labels are composed of any UTF-16 characters.

  • The size of a label must be a minimum of 1 character and a maximum of 256 characters.

  • A Shell can have up to 10 Shell labels, therefore Shell labels must be unique within a Shell.

Example

{
    "id": "341abebc-4222-4ab2-8296-c1943296a696",
    "idShort": "4408e40d-9e69-4e34-ab0c-10dd00949ebd",
    "labels": [
        "label_1",
        "label_2"
    ],
    "description": [
        {
            "language": "en",
            "text": "Example text"
        }
    ],
    "globalAssetId": "1bb2459a-0a7c-4f34-817e-15604199b2e4",
    "displayName": [
        {
            "language": "en",
            "text": "Example text"
        }
    ],
    "assetKind": "Instance",
    "assetType": "M67N8-9O/P1/011",
    "specificAssetIds": [
        {
            "name": "vin1",
            "value": "valueforvin1"
        }
    ],
    "submodelDescriptors": [
        {
            "id": "797d2f22-f691-4679-8661-93cc854f5e80",
            "endpoints": [
                {
                    "protocolInformation": {
                        "href": "https://localhost:1234",
                        "endpointProtocolVersion": [
                            "1.1"
                        ],
                        "securityAttributes": [
                            {
                                "type": "NONE",
                                "key": "securityKey",
                                "value": "securityValue"
                            }
                        ]
                    },
                    "interface": "AAS-1.0"
                },
                {
                    "protocolInformation": {
                        "href": "opc.tcp://localhost:4840",
                        "endpointProtocolVersion": [
                            "1.1"
                        ],
                        "securityAttributes": [
                            {
                                "type": "NONE",
                                "key": "securityKey",
                                "value": "securityValue"
                            }
                        ]
                    },
                    "interface": "AAS-1.0"
                }
            ]
        }
    ]
}