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

Inheritance diagram for implementations.experimental_implementation.ExperimentalImplementation:

Collaboration diagram for implementations.experimental_implementation.ExperimentalImplementation:

Public Member Functions
	__init__ (self, "AasHttpClient" client)
	Initializes the ExperimentalImplementation with the given client.

	get_concept_descriptions (self)
	Retrieves concept descriptions.

	get_concept_description_by_id (self, str concept_description_identifier)
	Retrieves a specific concept description by its identifier.

bool	post_concept_description (self, dict concept_description)
	Creates a new concept description.

bool	delete_concept_description_by_id (self, str concept_description_identifier)
	Deletes a specific concept description by its identifier.

bytes\|None	get_file_by_path_submodel_repo (self, str submodel_identifier, str id_short_path)
	Downloads file content from a specific submodel element from the Submodel at a specified path.

bool	post_file_by_path_submodel_repo (self, str submodel_identifier, str id_short_path, Path file)
	Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

bool	post_file_by_path_submodel_repo_stream (self, str submodel_identifier, str id_short_path, Any file_octet_stream, str mime_type="application/octet-stream")
	Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

bool	put_file_by_path_submodel_repo (self, str submodel_identifier, str id_short_path, Path file)
	Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

bool	put_file_by_path_submodel_repo_stream (self, str submodel_identifier, str id_short_path, Any file_octet_stream, str mime_type="application/octet-stream")
	Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

bool	delete_file_by_path_submodel_repo (self, str submodel_identifier, str id_short_path)
	Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy.

Protected Attributes
	_client

Detailed Description

Implementation of Asset Administration Shell Registry related API calls.

Definition at line 32 of file experimental_implementation.py.

Constructor & Destructor Documentation

◆ init()

implementations.experimental_implementation.ExperimentalImplementation.__init__	(		self,
		"AasHttpClient"	client
	)

Initializes the ExperimentalImplementation with the given client.

Definition at line 35 of file experimental_implementation.py.

Member Function Documentation

◆ delete_concept_description_by_id()

bool implementations.experimental_implementation.ExperimentalImplementation.delete_concept_description_by_id	(		self,
		str	concept_description_identifier
	)

Deletes a specific concept description by its identifier.

Experimental feature - may not be supported by all servers.

Parameters

concept_description_identifier The unique identifier of the concept description

Returns: True if deletion was successful, False otherwise

Definition at line 150 of file experimental_implementation.py.

◆ delete_file_by_path_submodel_repo()

bool implementations.experimental_implementation.ExperimentalImplementation.delete_file_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path
	)

Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)

Returns: True if deletion was successful, False otherwise

Definition at line 421 of file experimental_implementation.py.

◆ get_concept_description_by_id()

implementations.experimental_implementation.ExperimentalImplementation.get_concept_description_by_id	(		self,
		str	concept_description_identifier
	)

Retrieves a specific concept description by its identifier.

Experimental feature - may not be supported by all servers.

Parameters

concept_description_identifier The unique identifier of the concept description

Returns: Concept description data as a dictionary or None if not found

Definition at line 82 of file experimental_implementation.py.

◆ get_concept_descriptions()

implementations.experimental_implementation.ExperimentalImplementation.get_concept_descriptions ( self )

Retrieves concept descriptions.

Experimental feature - may not be supported by all servers.

Definition at line 48 of file experimental_implementation.py.

◆ get_file_by_path_submodel_repo()

bytes \| None implementations.experimental_implementation.ExperimentalImplementation.get_file_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path
	)

Downloads file content from a specific submodel element from the Submodel at a specified path.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)

Returns: Attachment file data as bytes (octet-stream) or None if an error occurred

Definition at line 185 of file experimental_implementation.py.

◆ post_concept_description()

bool implementations.experimental_implementation.ExperimentalImplementation.post_concept_description	(		self,
		dict	concept_description
	)

Creates a new concept description.

Experimental feature - may not be supported by all servers.

Parameters

concept_description Concept description data as a dictionary

Returns: True if creation was successful, False otherwise

Definition at line 116 of file experimental_implementation.py.

◆ post_file_by_path_submodel_repo()

bool implementations.experimental_implementation.ExperimentalImplementation.post_file_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		Path	file
	)

Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
file	Path to the file to upload as attachment

Returns: Attachment data as bytes or None if an error occurred

Definition at line 228 of file experimental_implementation.py.

◆ post_file_by_path_submodel_repo_stream()

bool implementations.experimental_implementation.ExperimentalImplementation.post_file_by_path_submodel_repo_stream	(		self,
		str	submodel_identifier,
		str	id_short_path,
		Any	file_octet_stream,
		str	mime_type = `"application/octet-stream"`
	)

Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
file_octet_stream	File content as a byte stream

Returns: Attachment data as bytes or None if an error occurred

Definition at line 277 of file experimental_implementation.py.

◆ put_file_by_path_submodel_repo()

bool implementations.experimental_implementation.ExperimentalImplementation.put_file_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		Path	file
	)

Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
file	Path to the file to upload as attachment

Returns: Attachment data as bytes or None if an error occurred

Definition at line 325 of file experimental_implementation.py.

◆ put_file_by_path_submodel_repo_stream()

bool implementations.experimental_implementation.ExperimentalImplementation.put_file_by_path_submodel_repo_stream	(		self,
		str	submodel_identifier,
		str	id_short_path,
		Any	file_octet_stream,
		str	mime_type = `"application/octet-stream"`
	)

Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy.

Experimental feature - may not be supported by all servers.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
file_octet_stream	File content as a byte stream

Returns: Attachment data as bytes or None if an error occurred

Definition at line 374 of file experimental_implementation.py.

Member Data Documentation

◆ _client

implementations.experimental_implementation.ExperimentalImplementation._client

protected

Definition at line 36 of file experimental_implementation.py.

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

aas_http_client/classes/client/implementations/experimental_implementation.py

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ delete_concept_description_by_id()

◆ delete_file_by_path_submodel_repo()

◆ get_concept_description_by_id()

◆ get_concept_descriptions()

◆ get_file_by_path_submodel_repo()

◆ post_concept_description()

◆ post_file_by_path_submodel_repo()

◆ post_file_by_path_submodel_repo_stream()

◆ put_file_by_path_submodel_repo()

◆ put_file_by_path_submodel_repo_stream()

Member Data Documentation

◆ _client

◆ init()