SystemDeviceFamilyGetListRequest

Bases: OCIRequest

Request to get the list of device family managed by the Device Management System. If includeSystemLevel is specified, all system level device families and the reseller device families matching search criteria are returned even when searchCriteriaResellerId is specified. If reseller administrator sends the request, searchCriteriaResellerId is ignored and automatically set to the administrator's reseller.

The response is either SystemDeviceFamilyGetListResponse or ErrorResponse.

Attributes:

include_system_level (Optional[bool]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

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

@dataclass(kw_only=True)
class SystemDeviceFamilyGetListRequest(OCIRequest):
    """Request to get the list of device family managed by the Device Management System.
        If includeSystemLevel is specified, all system level device families and the reseller device families matching search criteria
        are returned even when searchCriteriaResellerId is specified.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored and automatically set to the administrator's reseller.

        The response is either SystemDeviceFamilyGetListResponse or ErrorResponse.

    Attributes:

        include_system_level (Optional[bool]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    include_system_level: Optional[bool] = field(
        default=None, metadata={"alias": "includeSystemLevel"}
    )

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to SystemDeviceFamilyGetListRequest. The response includes a table of device family defined in the system. Column headings are: "Device Family Name", "Reseller Id".

The following columns are only returned in AS data mode:
  "Reseller Id"

Attributes:

device_family_table (OCITable):

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

@dataclass(kw_only=True)
class SystemDeviceFamilyGetListResponse(OCIDataResponse):
    """Response to SystemDeviceFamilyGetListRequest.
        The response includes a table of device family defined in the system.
        Column headings are: \"Device Family Name\", \"Reseller Id\".

        The following columns are only returned in AS data mode:
          \"Reseller Id\"

    Attributes:

        device_family_table (OCITable):

    """

    device_family_table: OCITable = field(metadata={"alias": "deviceFamilyTable"})

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 SystemDeviceFamilyGetListRequest

client = Client()

command = SystemDeviceFamilyGetListRequest(
    include_system_level=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemDeviceFamilyGetListRequest",
    include_system_level=...,
    search_criteria_reseller_id=...,
)

print(response)