set_config_payload.SetConfigPayload Class Reference

Defines the model class of the payload for the add_or_update_config (URL /add-config) endpoint of this application using Pydantic. More...

Inheritance diagram for set_config_payload.SetConfigPayload:

Collaboration diagram for set_config_payload.SetConfigPayload:

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

Static Public Attributes
dict	aid_dict = Field(..., alias="Aid", exclude=True)

Protected Attributes
	_aid_sm

Static Protected Attributes
Submodel	_aid_sm = PrivateAttr(default=None)

Detailed Description

Defines the model class of the payload for the add_or_update_config (URL /add-config) endpoint of this application using Pydantic.

The JSON payload must contain exactly the following fields:

• Aid

Inside the Aid-field, a properly serialized AID submodel according to the AAS JSON serialization must be provided. Will be parsed as basyx.aas.model.Submodel.

Example

{ "Aid": { "idShort": "AssetInterfacesDescription", "id": "https://example.com/ids/sm/1234_5678_90", "kind": "Instance", // ... } }

Definition at line 30 of file set_config_payload.py.

Constructor & Destructor Documentation

__init__()

set_config_payload.SetConfigPayload.__init__	(		self,
		**Any	data
	)

Definition at line 36 of file set_config_payload.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_aid_sm [1/2]

Submodel set_config_payload.SetConfigPayload._aid_sm = PrivateAttr(default=None)

staticprotected

Definition at line 34 of file set_config_payload.py.

_aid_sm [2/2]

set_config_payload.SetConfigPayload._aid_sm

protected

Definition at line 39 of file set_config_payload.py.

aid_dict

dict set_config_payload.SetConfigPayload.aid_dict = Field(..., alias="Aid", exclude=True)

static

Definition at line 32 of file set_config_payload.py.

---

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

• python_connector/models/set_config_payload.py