AAS HTTP Client Documentation
Loading...
Searching...
No Matches
implementations.experimental_implementation.ExperimentalImplementation Class Reference

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

Inheritance diagram for implementations.experimental_implementation.ExperimentalImplementation:
[legend]
Collaboration diagram for implementations.experimental_implementation.ExperimentalImplementation:
[legend]

Public Member Functions

 __init__ (self, "AasHttpClient" client)
 Initializes the ExperimentalImplementation with the given client.
 
 get_concept_descriptions (self, str id_short="", str is_case_of="", str data_specification_ref="", int limit=100, str cursor="")
 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 33 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 36 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_identifierThe unique identifier of the concept description
Returns
True if deletion was successful, False otherwise

Definition at line 165 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
Returns
True if deletion was successful, False otherwise

Definition at line 430 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_identifierThe unique identifier of the concept description
Returns
Concept description data as a dictionary or None if not found

Definition at line 99 of file experimental_implementation.py.

◆ get_concept_descriptions()

implementations.experimental_implementation.ExperimentalImplementation.get_concept_descriptions (   self,
str   id_short = "",
str   is_case_of = "",
str   data_specification_ref = "",
int   limit = 100,
str   cursor = "" 
)

Retrieves concept descriptions.

Experimental feature - may not be supported by all servers.

Parameters
id_shortFilter by idShort
is_case_ofFilter by isCaseOf
data_specification_refFilter by dataSpecificationRef
limitMaximum number of results to return
cursorCursor for pagination
Returns
List of concept descriptions as dictionaries or None if an error occurs

Definition at line 57 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
Returns
Attachment file data as bytes (octet-stream) or None if an error occurred

Definition at line 199 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_descriptionConcept description data as a dictionary
Returns
True if creation was successful, False otherwise

Definition at line 132 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
filePath to the file to upload as attachment
Returns
Attachment data as bytes or None if an error occurred

Definition at line 241 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
file_octet_streamFile content as a byte stream
Returns
Attachment data as bytes or None if an error occurred

Definition at line 289 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
filePath to the file to upload as attachment
Returns
Attachment data as bytes or None if an error occurred

Definition at line 336 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_identifierThe Submodels unique id
id_short_pathIdShort path to the submodel element (dot-separated)
file_octet_streamFile content as a byte stream
Returns
Attachment data as bytes or None if an error occurred

Definition at line 384 of file experimental_implementation.py.

Member Data Documentation

◆ _client

implementations.experimental_implementation.ExperimentalImplementation._client
protected

Definition at line 37 of file experimental_implementation.py.


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