implementations.shell_registry_implementation.ShellRegistryImplementation Class Reference

Implementation of Asset Administration Shell Registry related API calls. More...

Inheritance diagram for implementations.shell_registry_implementation.ShellRegistryImplementation:

Collaboration diagram for implementations.shell_registry_implementation.ShellRegistryImplementation:

Public Member Functions
	__init__ (self, "AasHttpClient" client)
	Initializes the ShellRegistryImplementation with the given parameters.
dict|None	get_asset_administration_shell_descriptor_by_id (self, str aas_identifier)
	Returns a specific Asset Administration Shell Descriptor.
bool	put_asset_administration_shell_descriptor_by_id (self, str aas_identifier, dict request_body)
	Creates or updates an existing Asset Administration Shell Descriptor.
bool	delete_asset_administration_shell_descriptor_by_id (self, str aas_identifier)
	Deletes an Asset Administration Shell Descriptor, i.e.
dict|None	get_submodel_descriptor_by_id_through_superpath (self, str aas_identifier, str submodel_identifier)
	Returns a specific Submodel Descriptor.
bool	put_submodel_descriptor_by_id_through_superpath (self, str aas_identifier, str submodel_identifier, dict request_body)
	Creates or updates an existing Submodel Descriptor.
bool	delete_submodel_descriptor_by_id_through_superpath (self, str aas_identifier, str submodel_identifier)
	Deletes a Submodel Descriptor, i.e.
dict|None	get_all_asset_administration_shell_descriptors (self, int limit=100, str cursor="", str asset_kind="", str asset_type="")
	Returns all Asset Administration Shell Descriptors.
dict|None	post_asset_administration_shell_descriptor (self, dict request_body)
	Creates a new Asset Administration Shell Descriptor, i.e.
bool	delete_all_asset_administration_shell_descriptors (self)
	Deletes all Asset Administration Shell Descriptors.
dict|None	get_all_submodel_descriptors_through_superpath (self, str aas_identifier)
	Returns all Submodel Descriptors for a specific Asset Administration Shell.
dict|None	post_submodel_descriptor_through_superpath (self, str aas_identifier, dict request_body)
	Creates a new Submodel Descriptor, i.e.
dict|None	search (self, dict request_body)
	Searches for Asset Administration Shell Descriptors based on the provided query.
dict|None	get_self_description (self)
	Returns the self-describing information of a network resource (ServiceDescription).

Protected Attributes
	_client

Detailed Description

Implementation of Asset Administration Shell Registry related API calls.

Definition at line 29 of file shell_registry_implementation.py.

Constructor & Destructor Documentation

__init__()

implementations.shell_registry_implementation.ShellRegistryImplementation.__init__	(		self,
		"AasHttpClient"	client
	)

Initializes the ShellRegistryImplementation with the given parameters.

Definition at line 32 of file shell_registry_implementation.py.

Member Function Documentation

delete_all_asset_administration_shell_descriptors()

bool implementations.shell_registry_implementation.ShellRegistryImplementation.delete_all_asset_administration_shell_descriptors

(

self

)

Deletes all Asset Administration Shell Descriptors.

Returns

True if deletion was successful, False otherwise

Definition at line 323 of file shell_registry_implementation.py.

delete_asset_administration_shell_descriptor_by_id()

bool implementations.shell_registry_implementation.ShellRegistryImplementation.delete_asset_administration_shell_descriptor_by_id	(		self,
		str	aas_identifier
	)

Deletes an Asset Administration Shell Descriptor, i.e.

de-registers an AAS.

Parameters

aas_identifier

The Asset Administration Shells unique id

Returns

True if deletion was successful, False otherwise

Definition at line 117 of file shell_registry_implementation.py.

delete_submodel_descriptor_by_id_through_superpath()

bool implementations.shell_registry_implementation.ShellRegistryImplementation.delete_submodel_descriptor_by_id_through_superpath	(		self,
		str	aas_identifier,
		str	submodel_identifier
	)

Deletes a Submodel Descriptor, i.e.

de-registers a submodel.

Parameters

aas_identifier	The Asset Administration Shells unique id
submodel_identifier	The Submodels unique id

Returns

True if deletion was successful, False otherwise

Definition at line 223 of file shell_registry_implementation.py.

get_all_asset_administration_shell_descriptors()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.get_all_asset_administration_shell_descriptors	(		self,
		int	limit = 100,
		str	cursor = "",
		str	asset_kind = "",
		str	asset_type = ""
	)

Returns all Asset Administration Shell Descriptors.

Parameters

limit	Maximum number of Submodels to return
cursor	Cursor for pagination
asset_kind	The Asset's kind (Instance or Type). Available values : Instance, NotApplicable, Type
asset_type	The Asset's type (UTF8-BASE64-URL-encoded)

Returns

Asset Administration Shell Descriptors data or None if an error occurred

Definition at line 260 of file shell_registry_implementation.py.

get_all_submodel_descriptors_through_superpath()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.get_all_submodel_descriptors_through_superpath	(		self,
		str	aas_identifier
	)

Returns all Submodel Descriptors for a specific Asset Administration Shell.

Parameters

aas_identifier

The Asset Administration Shells unique id

Returns

Submodel Descriptors data or None if an error occurred

Definition at line 348 of file shell_registry_implementation.py.

get_asset_administration_shell_descriptor_by_id()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.get_asset_administration_shell_descriptor_by_id	(		self,
		str	aas_identifier
	)

Returns a specific Asset Administration Shell Descriptor.

Parameters

aas_identifier

The Asset Administration Shells unique id

Returns

Asset Administration Shell Descriptor data or None if an error occurred

Definition at line 49 of file shell_registry_implementation.py.

get_self_description()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.get_self_description

(

self

)

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

Returns

self-describing information of a network resource

Definition at line 442 of file shell_registry_implementation.py.

get_submodel_descriptor_by_id_through_superpath()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.get_submodel_descriptor_by_id_through_superpath	(		self,
		str	aas_identifier,
		str	submodel_identifier
	)

Returns a specific Submodel Descriptor.

Parameters

aas_identifier	The Asset Administration Shells unique id
submodel_identifier	The Submodels unique id

Returns

Submodel Descriptor data or None if an error occurred

Definition at line 151 of file shell_registry_implementation.py.

post_asset_administration_shell_descriptor()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.post_asset_administration_shell_descriptor	(		self,
		dict	request_body
	)

Creates a new Asset Administration Shell Descriptor, i.e.

registers an AAS.

Parameters

request_body

Asset Administration Shell Descriptor object

Returns

Created Asset Administration Shell Descriptor data or None if an error occurred

Definition at line 298 of file shell_registry_implementation.py.

post_submodel_descriptor_through_superpath()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.post_submodel_descriptor_through_superpath	(		self,
		str	aas_identifier,
		dict	request_body
	)

Creates a new Submodel Descriptor, i.e.

registers a submodel.

Parameters

aas_identifier	The Asset Administration Shells unique id
request_body	Asset Administration Shell Descriptor object

Returns

Created Asset Administration Shell Descriptor data or None if an error occurred

Definition at line 383 of file shell_registry_implementation.py.

put_asset_administration_shell_descriptor_by_id()

bool implementations.shell_registry_implementation.ShellRegistryImplementation.put_asset_administration_shell_descriptor_by_id	(		self,
		str	aas_identifier,
		dict	request_body
	)

Creates or updates an existing Asset Administration Shell Descriptor.

Parameters

aas_identifier	The Asset Administration Shells unique id
request_body	Asset Administration Shell Descriptor object

Returns

Created or updated Asset Administration Shell Descriptor data or None if an error occurred

Definition at line 84 of file shell_registry_implementation.py.

put_submodel_descriptor_by_id_through_superpath()

bool implementations.shell_registry_implementation.ShellRegistryImplementation.put_submodel_descriptor_by_id_through_superpath	(		self,
		str	aas_identifier,
		str	submodel_identifier,
		dict	request_body
	)

Creates or updates an existing Submodel Descriptor.

Parameters

aas_identifier	The Asset Administration Shells unique id
submodel_identifier	The Submodels unique id
request_body	Submodel Descriptor object

Returns

True if creation or update was successful, False otherwise

Definition at line 188 of file shell_registry_implementation.py.

search()

dict | None implementations.shell_registry_implementation.ShellRegistryImplementation.search	(		self,
		dict	request_body
	)

Searches for Asset Administration Shell Descriptors based on the provided query.

Parameters

request_body

query as a dictionary

Returns

Search results as a dictionary or None if an error occurred

Definition at line 417 of file shell_registry_implementation.py.

Member Data Documentation

_client

implementations.shell_registry_implementation.ShellRegistryImplementation._client

protected

Definition at line 33 of file shell_registry_implementation.py.

---

The documentation for this class was generated from the following file:

• aas_http_client/classes/client/implementations/shell_registry_implementation.py