SystemAccessDeviceGetAvailableCustomTagListRequest

Bases: OCIRequest

Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis. The response is either SystemAccessDeviceGetAvailableCustomTagListResponse or ErrorResponse. The following elements are used in AS mode and ignored in XS data mode: tagSetName

Attributes:

device_name (str):

tag_set_name (Optional[str]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class SystemAccessDeviceGetAvailableCustomTagListRequest(OCIRequest):
    """Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
        The response is either SystemAccessDeviceGetAvailableCustomTagListResponse or ErrorResponse.
        The following elements are used in AS mode and ignored in XS data mode:
          tagSetName

    Attributes:

        device_name (str):

        tag_set_name (Optional[str]):

    """

    device_name: str = field(metadata={"alias": "deviceName"})

    tag_set_name: Optional[str] = field(default=None, metadata={"alias": "tagSetName"})

Responses

Bases: OCIDataResponse

Response to SystemAccessDeviceGetAvailableCustomTagListRequest. Contains a table of all available custom tags managed by the Device Management System on a per-device profile basis.

In AS data mode, the column headings are: "Tag Name", "Tag Value", "Tag Level", "Tag Set Name", "Region Name".

In XS data mode, the column headings are: "Tag Name", "Tag Value", "Tag Level", "Tag Set Name", "Is Encrypted".

"Tag Level" can take the value: "System Default", "System", "Service Provider", "Group" or "Device Profile".

Attributes:

device_available_custom_tags_table (OCITable):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class SystemAccessDeviceGetAvailableCustomTagListResponse(OCIDataResponse):
    """Response to SystemAccessDeviceGetAvailableCustomTagListRequest.
        Contains a table of all available custom tags managed by the Device Management System on a per-device profile basis.

        In AS data mode, the column headings are: \"Tag Name\", \"Tag Value\", \"Tag Level\", \"Tag Set Name\", \"Region Name\".

        In XS data mode, the column headings are: \"Tag Name\", \"Tag Value\", \"Tag Level\", \"Tag Set Name\", \"Is Encrypted\".

        \"Tag Level\" can take the value: \"System Default\", \"System\", \"Service Provider\", \"Group\" or \"Device Profile\".

    Attributes:

        device_available_custom_tags_table (OCITable):

    """

    device_available_custom_tags_table: OCITable = field(
        metadata={"alias": "deviceAvailableCustomTagsTable"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import SystemAccessDeviceGetAvailableCustomTagListRequest

client = Client()

command = SystemAccessDeviceGetAvailableCustomTagListRequest(
    device_name=...,
    tag_set_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemAccessDeviceGetAvailableCustomTagListRequest",
    device_name=...,
    tag_set_name=...,
)

print(response)