Implementation of Submodel related API calls. More...

Inheritance diagram for implementations.sm_implementation.SubmodelRepoImplementation:

Collaboration diagram for implementations.sm_implementation.SubmodelRepoImplementation:

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

dict\|None	get_submodel_by_id (self, str submodel_identifier, str level="", str extent="")
	Returns a specific Submodel.

bool	put_submodels_by_id (self, str submodel_identifier, dict request_body)
	Updates a existing Submodel.

bool	delete_submodel_by_id (self, str submodel_identifier)
	Deletes a Submodel.

dict\|None	get_submodel_element_by_path_submodel_repo (self, str submodel_identifier, str id_short_path, str level="", str extent="")
	Returns a specific submodel element from the Submodel at a specified path.

bool	put_submodel_element_by_path_submodel_repo (self, str submodel_identifier, str id_short_path, dict request_body, str level="")
	Creates or updates an existing submodel element at a specified path within submodel elements hierarchy.

dict\|None	post_submodel_element_by_path_submodel_repo (self, str submodel_identifier, str id_short_path, dict request_body, str level="", str extent="")
	Creates a new submodel element at a specified path within submodel elements hierarchy.

bool	delete_submodel_element_by_path_submodel_repo (self, str submodel_identifier, str id_short_path)
	Deletes a submodel element at a specified path within the submodel elements hierarchy.

dict\|None	get_all_submodels (self, str semantic_id="", str id_short="", int limit=0, str cursor="", str level="", str extent="")
	Returns all Submodels.

dict\|None	post_submodel (self, dict request_body)
	Creates a new Submodel.

dict\|None	get_all_submodel_elements_submodel_repository (self, str submodel_identifier, int limit=100, str cursor="", str level="", str extent="")
	Returns all submodel elements including their hierarchy.

dict\|None	post_submodel_element_submodel_repo (self, str submodel_identifier, dict request_body)
	Creates a new submodel element.

dict\|None	invoke_operation_submodel_repo (self, str submodel_identifier, str id_short_path, dict request_body, str async_="async")
	Synchronously invokes an Operation at a specified path.

str\|None	get_submodel_element_by_path_value_only_submodel_repo (self, str submodel_identifier, str id_short_path)
	Retrieves the value of a specific SubmodelElement.

bool	patch_submodel_element_by_path_value_only_submodel_repo (self, str submodel_identifier, str id_short_path, str value, str level="")
	Updates the value of an existing SubmodelElement.

dict\|None	get_submodel_by_id_value_only (self, str submodel_identifier, str level="", str extent="")
	Returns a specific Submodel in the ValueOnly representation.

bool	patch_submodel_by_id_value_only (self, str submodel_identifier, dict request_body, str level="")
	Updates the values of an existing Submodel.

dict\|None	get_submodel_by_id_metadata (self, str submodel_identifier, str level="")
	Returns the metadata attributes of a specific Submodel.

bool	patch_submodel_by_id (self, str submodel_identifier, dict submodel_data)
	Updates an existing Submodel.

Protected Attributes
	_client

Detailed Description

Implementation of Submodel related API calls.

Definition at line 29 of file sm_implementation.py.

Constructor & Destructor Documentation

◆ init()

implementations.sm_implementation.SubmodelRepoImplementation.__init__	(		self,
		"AasHttpClient"	client
	)

Initializes the SmImplementation with the given parameters.

Definition at line 32 of file sm_implementation.py.

Member Function Documentation

◆ delete_submodel_by_id()

bool implementations.sm_implementation.SubmodelRepoImplementation.delete_submodel_by_id	(		self,
		str	submodel_identifier
	)

Deletes a Submodel.

Parameters

submodel_identifier The Submodels unique id

Returns: True if the deletion was successful, False otherwise

Definition at line 125 of file sm_implementation.py.

◆ delete_submodel_element_by_path_submodel_repo()

bool implementations.sm_implementation.SubmodelRepoImplementation.delete_submodel_element_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path
	)

Deletes a submodel element at a specified path within the submodel elements hierarchy.

Parameters

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

Returns: True if the deletion was successful, False otherwise

Definition at line 290 of file sm_implementation.py.

◆ get_all_submodel_elements_submodel_repository()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_all_submodel_elements_submodel_repository	(		self,
		str	submodel_identifier,
		int	limit = `100`,
		str	cursor = `""`,
		str	level = `""`,
		str	extent = `""`
	)

Returns all submodel elements including their hierarchy.

Parameters

submodel_identifier	The Submodels unique id
limit	The maximum number of elements in the response array
cursor	A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: List of Submodel element data or None if an error occurred

Definition at line 399 of file sm_implementation.py.

◆ get_all_submodels()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_all_submodels	(		self,
		str	semantic_id = `""`,
		str	id_short = `""`,
		int	limit = `0`,
		str	cursor = `""`,
		str	level = `""`,
		str	extent = `""`
	)

Returns all Submodels.

Parameters

semantic_id	The value of the semantic id reference (UTF8-BASE64-URL-encoded)
id_short	The Submodels IdShort
limit	The maximum number of elements in the response array
cursor	A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: List of Submodel data or None if an error occurred

Definition at line 327 of file sm_implementation.py.

◆ get_submodel_by_id()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_submodel_by_id	(		self,
		str	submodel_identifier,
		str	level = `""`,
		str	extent = `""`
	)

Returns a specific Submodel.

Parameters

submodel_identifier	The Submodels unique id
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: Submodel data or None if an error occurred

Definition at line 51 of file sm_implementation.py.

◆ get_submodel_by_id_metadata()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_submodel_by_id_metadata	(		self,
		str	submodel_identifier,
		str	level = `""`
	)

Returns the metadata attributes of a specific Submodel.

Parameters

submodel_identifier	The Submodels unique id
level	Determines the structural depth of the respective resource content. Available values : deep, core

Returns: Metadata attributes of the Submodel as dict or None if an error occurred

Definition at line 656 of file sm_implementation.py.

◆ get_submodel_by_id_value_only()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_submodel_by_id_value_only	(		self,
		str	submodel_identifier,
		str	level = `""`,
		str	extent = `""`
	)

Returns a specific Submodel in the ValueOnly representation.

Parameters

submodel_identifier	The Submodels unique id
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: Submodel value as dict or None if an error occurred

Definition at line 576 of file sm_implementation.py.

◆ get_submodel_element_by_path_submodel_repo()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.get_submodel_element_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		str	level = `""`,
		str	extent = `""`
	)

Returns a specific submodel element from the Submodel at a specified path.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: Submodel element data or None if an error occurred

Definition at line 161 of file sm_implementation.py.

Here is the caller graph for this function:

◆ get_submodel_element_by_path_value_only_submodel_repo()

str \| None implementations.sm_implementation.SubmodelRepoImplementation.get_submodel_element_by_path_value_only_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path
	)

Retrieves the value of a specific SubmodelElement.

Parameters

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

Returns: Submodel element value or None if an error occurred

Definition at line 503 of file sm_implementation.py.

◆ invoke_operation_submodel_repo()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.invoke_operation_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		dict	request_body,
		str	async_ = `"async"`
	)

Synchronously invokes an Operation at a specified path.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the operation element (dot-separated)
request_body	Input parameters for the operation
async_	Determines whether an operation invocation is performed asynchronously or synchronously

Returns: Operation result or None if an error occurred

Definition at line 473 of file sm_implementation.py.

◆ patch_submodel_by_id()

bool implementations.sm_implementation.SubmodelRepoImplementation.patch_submodel_by_id	(		self,
		str	submodel_identifier,
		dict	submodel_data
	)

Updates an existing Submodel.

Parameters

submodel_identifier The Submodels unique id

Returns: True if the patch was successful, False otherwise

Definition at line 696 of file sm_implementation.py.

◆ patch_submodel_by_id_value_only()

bool implementations.sm_implementation.SubmodelRepoImplementation.patch_submodel_by_id_value_only	(		self,
		str	submodel_identifier,
		dict	request_body,
		str	level = `""`
	)

Updates the values of an existing Submodel.

Parameters

submodel_identifier	The Submodels unique id
request_body	Submodel values to update as dict
level	Determines the structural depth of the respective resource content. Available values : deep, core

Returns: True if the patch was successful, False otherwise

Definition at line 618 of file sm_implementation.py.

◆ patch_submodel_element_by_path_value_only_submodel_repo()

bool implementations.sm_implementation.SubmodelRepoImplementation.patch_submodel_element_by_path_value_only_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		str	value,
		str	level = `""`
	)

Updates the value of an existing SubmodelElement.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
value	Submodel element value to update as string
level	Determines the structural depth of the respective resource content. Available values : deep, core

Returns: True if the patch was successful, False otherwise

Definition at line 535 of file sm_implementation.py.

◆ post_submodel()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.post_submodel	(		self,
		dict	request_body
	)

Creates a new Submodel.

Parameters

request_body Json data of the Submodel to post

Returns: Submodel data or None if an error occurred

Definition at line 369 of file sm_implementation.py.

◆ post_submodel_element_by_path_submodel_repo()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.post_submodel_element_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		dict	request_body,
		str	level = `""`,
		str	extent = `""`
	)

Creates a new submodel element at a specified path within submodel elements hierarchy.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
request_body	Data for the new Submodel element
level	Determines the structural depth of the respective resource content. Available values : deep, core
extent	Determines to which extent the resource is being serialized. Available values : withBlobValue, withoutBlobValue

Returns: Submodel element data or None if an error occurred

Definition at line 247 of file sm_implementation.py.

◆ post_submodel_element_submodel_repo()

dict \| None implementations.sm_implementation.SubmodelRepoImplementation.post_submodel_element_submodel_repo	(		self,
		str	submodel_identifier,
		dict	request_body
	)

Creates a new submodel element.

Parameters

submodel_identifier	The Submodels unique id
request_body	Data for the new Submodel element

Returns: Submodel element data or None if an error occurred

Definition at line 441 of file sm_implementation.py.

◆ put_submodel_element_by_path_submodel_repo()

bool implementations.sm_implementation.SubmodelRepoImplementation.put_submodel_element_by_path_submodel_repo	(		self,
		str	submodel_identifier,
		str	id_short_path,
		dict	request_body,
		str	level = `""`
	)

Creates or updates an existing submodel element at a specified path within submodel elements hierarchy.

Parameters

submodel_identifier	The Submodels unique id
id_short_path	IdShort path to the submodel element (dot-separated)
request_body	Data for the submodel element
level	Determines the structural depth of the respective resource content. Available values : deep, core

Returns: True if the operation was successful, False otherwise

Definition at line 206 of file sm_implementation.py.

◆ put_submodels_by_id()

bool implementations.sm_implementation.SubmodelRepoImplementation.put_submodels_by_id	(		self,
		str	submodel_identifier,
		dict	request_body
	)

Updates a existing Submodel.

Parameters

submodel_identifier	The Submodels unique id
request_body	Json data of the Submodel to update

Returns: True if the update was successful, False otherwise

Definition at line 92 of file sm_implementation.py.

Member Data Documentation

◆ _client

implementations.sm_implementation.SubmodelRepoImplementation._client

protected

Definition at line 33 of file sm_implementation.py.

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

aas_http_client/classes/client/implementations/sm_implementation.py

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ delete_submodel_by_id()

◆ delete_submodel_element_by_path_submodel_repo()

◆ get_all_submodel_elements_submodel_repository()

◆ get_all_submodels()

◆ get_submodel_by_id()

◆ get_submodel_by_id_metadata()

◆ get_submodel_by_id_value_only()

◆ get_submodel_element_by_path_submodel_repo()

◆ get_submodel_element_by_path_value_only_submodel_repo()

◆ invoke_operation_submodel_repo()

◆ patch_submodel_by_id()

◆ patch_submodel_by_id_value_only()

◆ patch_submodel_element_by_path_value_only_submodel_repo()

◆ post_submodel()

◆ post_submodel_element_by_path_submodel_repo()

◆ post_submodel_element_submodel_repo()

◆ put_submodel_element_by_path_submodel_repo()

◆ put_submodels_by_id()

Member Data Documentation

◆ _client

◆ init()