GroupAccessDeviceCustomTagGetListRequest

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 GroupAccessDeviceCustomTagGetListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

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

@dataclass(kw_only=True)
class GroupAccessDeviceCustomTagGetListRequest(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 GroupAccessDeviceCustomTagGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

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

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceCustomTagGetListRequest. 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", "Actual Tag Value" if request is invoked by an admin without system privileges. "Tag Name", "Tag Value", "Is Encrypted", "Actual Tag Value" if request is invoked by an admin with system privileges.

Attributes:

device_custom_tags_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAccessDeviceCustomTagGetListResponse(OCIDataResponse):
    """Response to GroupAccessDeviceCustomTagGetListRequest.
        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\", \"Actual Tag Value\" if request is invoked by an admin without system privileges.
          \"Tag Name\", \"Tag Value\", \"Is Encrypted\", \"Actual Tag Value\" if request is invoked by an admin with system privileges.

    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 GroupAccessDeviceCustomTagGetListRequest

client = Client()

command = GroupAccessDeviceCustomTagGetListRequest(
    service_provider_id=...,
    group_id=...,
    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("GroupAccessDeviceCustomTagGetListRequest",
    service_provider_id=...,
    group_id=...,
    device_name=...,
)

print(response)