get_value_payload.GetValuePayload Class Reference

Defines the model class of the payload for the get_value (URL /get-value) endpoint of this application using Pydantic. More...

Inheritance diagram for get_value_payload.GetValuePayload:

Collaboration diagram for get_value_payload.GetValuePayload:

Public Member Functions
	__init__ (self, **Any data)

Static Public Attributes
dict	aid_ref_dict = Field(..., alias="Reference")

Protected Member Functions
ModelReference	_build_model_reference (self)
KeyTypes	_get_key_type (self, str key_str)

Protected Attributes
	_aid_ref

Static Protected Attributes
ModelReference	_aid_ref = PrivateAttr(default=None)

Detailed Description

Defines the model class of the payload for the get_value (URL /get-value) endpoint of this application using Pydantic.

The JSON payload must contain exactly the following fields:

• Reference

Inside the Reference-field, a properly serialized AAS reference according to the AAS JSON serialization must be provided. Will be parsed as basyx.aas.model.ModelReference. The reference shall point to a SME in an AID submodel known to this application (refer to add_or_update_config).

Example

{ "Reference": { "type": "ModelReference", "keys": [ { "type": "Submodel", "value": "https://fluid40.de/ids/sm/4757_4856_8464_1441" }, { "type": "SubmodelElementCollection", "value": "Interface_MQTT" }, { "type": "SubmodelElementCollection", "value": "InteractionMetadata" }, { "type": "SubmodelElementCollection", "value": "properties" }, { "type": "SubmodelElementCollection", "value": "my_endpoint" } ] } }

Definition at line 55 of file get_value_payload.py.

Constructor & Destructor Documentation

__init__()

get_value_payload.GetValuePayload.__init__	(		self,
		**Any	data
	)

Definition at line 60 of file get_value_payload.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

_build_model_reference()

ModelReference get_value_payload.GetValuePayload._build_model_reference (   self )

protected

Definition at line 66 of file get_value_payload.py.

Here is the call graph for this function:

Here is the caller graph for this function:

_get_key_type()

KeyTypes get_value_payload.GetValuePayload._get_key_type (   self, str  key_str  )

protected

Definition at line 73 of file get_value_payload.py.

Here is the caller graph for this function:

Member Data Documentation

_aid_ref [1/2]

ModelReference get_value_payload.GetValuePayload._aid_ref = PrivateAttr(default=None)

staticprotected

Definition at line 58 of file get_value_payload.py.

_aid_ref [2/2]

get_value_payload.GetValuePayload._aid_ref

protected

Definition at line 71 of file get_value_payload.py.

aid_ref_dict

dict get_value_payload.GetValuePayload.aid_ref_dict = Field(..., alias="Reference")

static

Definition at line 57 of file get_value_payload.py.

---

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

• python_connector/models/get_value_payload.py