SystemAccessDeviceCustomTagGetListRequest

Bases: OCIRequest

Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis. The response is either SystemAccessDeviceCustomTagGetListResponse or ErrorResponse.

Attributes:

device_name (str):

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

@dataclass(kw_only=True)
class SystemAccessDeviceCustomTagGetListRequest(OCIRequest):
    """Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
        The response is either SystemAccessDeviceCustomTagGetListResponse or ErrorResponse.

    Attributes:

        device_name (str):

    """

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

Responses

Bases: OCIDataResponse

Response to SystemAccessDeviceCustomTagGetListRequest. Contains a table of custom configuration 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", "Actual Tag Value".
In XS data mode, the column headings are: "Tag Name", "Tag Value", "Is Encrypted", "Actual Tag Value".

Attributes:

device_custom_tags_table (OCITable):

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

@dataclass(kw_only=True)
class SystemAccessDeviceCustomTagGetListResponse(OCIDataResponse):
    """Response to SystemAccessDeviceCustomTagGetListRequest.
        Contains a table of custom configuration 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\", \"Actual Tag Value\".
        In XS data mode, the column headings are: \"Tag Name\", \"Tag Value\", \"Is Encrypted\", \"Actual Tag Value\".

    Attributes:

        device_custom_tags_table (OCITable):

    """

    device_custom_tags_table: OCITable = field(
        metadata={"alias": "deviceCustomTagsTable"}
    )

Bases: OCIResponse

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

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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemAccessDeviceCustomTagGetListRequest

client = Client()

command = SystemAccessDeviceCustomTagGetListRequest(
    device_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemAccessDeviceCustomTagGetListRequest",
    device_name=...,
)

print(response)