implementations.experimental_implementation.ExperimentalImplementation Class Reference

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.
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	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	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 Member Functions
	_post_multipart (self, url, files)

Protected Attributes
	_client

Detailed Description

Implementation of Asset Administration Shell Registry related API calls.

Definition at line 29 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 32 of file experimental_implementation.py.

Member Function Documentation

_post_multipart()

implementations.experimental_implementation.ExperimentalImplementation._post_multipart (   self,   url,   files  )

protected

Definition at line 202 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 176 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 50 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 87 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 132 of file experimental_implementation.py.

Member Data Documentation

_client

implementations.experimental_implementation.ExperimentalImplementation._client

protected

Definition at line 33 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