digital-twin-registry/provider

Step	Summary
digital-twin-registry/provider/create_shell_descriptor	Create an AAS shell descriptor in the Digital Twin Registry.
digital-twin-registry/provider/create_submodel_descriptor	Create a submodel descriptor under an AAS shell.
digital-twin-registry/provider/delete_shell_descriptor	Delete an AAS shell descriptor.
digital-twin-registry/provider/get_shell_descriptor	Retrieve an AAS shell descriptor by ID.
digital-twin-registry/provider/lookup_shells	Search the run's own registry for shells matching specific asset IDs.

digital-twin-registry/provider/create_shell_descriptor

Create an AAS shell descriptor in the Digital Twin Registry.

Inputs

Parameter	Type	Required	Default	Also accepts	Description
bpn	string	no	None	—	BPN the registry request is made on behalf of.
shell_descriptor	object	yes	—	—	The AAS shell descriptor document to register.

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/create_submodel_descriptor

Create a submodel descriptor under an AAS shell.

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.
submodel_descriptor	object	yes	—	—	The submodel descriptor document to register under the shell.

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/delete_shell_descriptor

Delete an AAS shell descriptor.

The status the registry answered with is published as status_code, so a teardown can assert that the twin was really there (204) rather than already gone (404).

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.

Output — the value assertions and returns: read

What a delete step publishes: the status the server answered it with.

Field	Type	Description
status_code	integer	HTTP status the delete was answered with.

digital-twin-registry/provider/get_shell_descriptor

Retrieve an AAS shell descriptor by ID.

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.

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/lookup_shells

Search the run's own registry for shells matching specific asset IDs.

digital-twin-registry/consumer/dataplane/lookup_shell re-addressed at the registry the engine is seeded with: the same GET /lookup/shells, the same base64url-encoded criteria, the same answer, reached over the service's own lookup URL rather than through a data plane. That is what a setup phase needs — it has no EDR token, and no reason to obtain one to search a registry it operates. The lookup answers with identifiers, so each is read back as a descriptor from the registry API; a test that only needs the identifiers reads shell_ids and ignores the rest.

Inputs

Parameter	Type	Required	Default	Also accepts	Description
bpn	string	no	None	—	BPN the registry request is made on behalf of.
specific_asset_ids	list of SpecificAssetId	yes	—	—	Criteria the shell must match; all of them have to.

Output — the value assertions and returns: read

Shells a registry read returned.

Field	Type	Description
shell_ids	list of string	Identifiers of the shells that matched.
shell_descriptors	list of object	The descriptor document of each matching shell.

Nested objects

SpecificAssetId

One specificAssetIds criterion a shell is searched by.

Field	Type	Required	Default	Also accepts	Description
name	string	yes	—	—	Name of the asset identifier, e.g. 'partInstanceId'.
value	string	yes	—	—	Value that identifier must have.

Additional keys sent by the counterpart are passed through unchanged.