digital-twin-registry/provider/wizard
| Step | Summary |
|---|---|
digital-twin-registry/provider/wizard/create_shell_descriptor |
Register a shell descriptor described field by field. |
digital-twin-registry/provider/wizard/create_submodel_descriptor |
Attach a submodel descriptor described field by field. |
digital-twin-registry/provider/wizard/create_shell_descriptor
Register a shell descriptor described field by field.
The guided sibling of digital-twin-registry/provider/create_shell_descriptor, registering through the same call.
Inputs
| Parameter | Type | Required | Default | Also accepts | Description |
|---|---|---|---|---|---|
bpn |
string | no | None |
— | BPN the registry request is made on behalf of. |
id |
string | no | '' |
— | Shell identifier; a fresh URN UUID when omitted. |
id_short |
string | yes | — | — | Short, human-readable name for the shell. |
global_asset_id |
string | no | '' |
— | Global asset ID the twin represents, as a URN. |
specific_asset_ids |
list of object | no | [] |
— | Identifiers the shell can be looked up by, as {name, value} pairs. |
submodel_descriptors |
list of object | no | [] |
— | Submodel descriptors to attach as the shell is created. |
Output — the value assertions and returns: read
An AAS descriptor as the registry returned it.
| Field | Type | Description |
|---|---|---|
id |
string | Identifier of the descriptor. |
idShort |
string | Short, human-readable name. |
Additional keys sent by the counterpart are passed through unchanged.
digital-twin-registry/provider/wizard/create_submodel_descriptor
Attach a submodel descriptor described field by field.
The guided sibling of digital-twin-registry/provider/create_submodel_descriptor, registering through the same call.
Inputs
| Parameter | Type | Required | Default | Also accepts | Description |
|---|---|---|---|---|---|
bpn |
string | no | None |
— | BPN the registry request is made on behalf of. |
aas_identifier |
string | yes | — | — | Identifier of the AAS shell descriptor. |
id |
string | no | '' |
— | Submodel identifier; a fresh URN UUID when omitted. |
id_short |
string | no | '' |
— | Short, human-readable name for the submodel. CX-0002 does not require one, so an omitted name is left out of the descriptor. |
semantic_id |
string | yes | — | — | URN of the aspect model the submodel follows. |
href |
string | yes | — | — | URL the submodel's data is served from, written to the endpoint's 'href'. Give the bare data URL: the '$'-suffix the chosen interface calls for is this step's to write. |
asset_id |
string | yes | — | — | Asset ID the submodel is offered as — the subprotocol body's 'id'. |
dsp_endpoint |
string | yes | — | — | DSP URL of the provider control plane the asset is negotiated through — the subprotocol body's 'dspEndpoint'. |
interface |
string | no | 'SUBMODEL-3.0' |
— | AAS interface the endpoint implements — SUBMODEL-3.X, or SUBMODEL-VALUE-3.X when the href is directly callable as given. |
Output — the value assertions and returns: read
An AAS descriptor as the registry returned it.
| Field | Type | Description |
|---|---|---|
id |
string | Identifier of the descriptor. |
idShort |
string | Short, human-readable name. |
Additional keys sent by the counterpart are passed through unchanged.