Skip to content

GroupGetListInSystemRequest

Bases: OCIRequest

Request the list of groups in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the groups in the administrator's reseller meeting the search criteria are returned.

The response is either a GroupGetListInSystemResponse or an ErrorResponse.

The following data elements are only used in AS data mode:
  searchCriteriaResellerId

Attributes:

response_size_limit (Optional[int]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupGetListInSystemRequest(OCIRequest):
    """Request the list of groups in the system.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the groups
        in the administrator's reseller meeting the search criteria are returned.

        The response is either a GroupGetListInSystemResponse or an ErrorResponse.

        The following data elements are only used in AS data mode:
          searchCriteriaResellerId

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

        search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_group_name: Optional[List[SearchCriteriaGroupName]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupName"}
    )

    search_criteria_exact_service_provider: Optional[
        SearchCriteriaExactServiceProvider
    ] = field(default=None, metadata={"alias": "searchCriteriaExactServiceProvider"})

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

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

Responses

Bases: OCIDataResponse

Response to GroupGetListInSystemRequest. Contains a table with column headings: "Group Id", "Group Name", "User Limit", "Organization Id", "Organization Type", "Reseller Id" and a row for each group. The "Organization Id" column is populated with either a service provider Id or an enterprise Id. The "Organization Type" column is populated with one of the enumerated strings defined in the OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType.

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

Attributes:

group_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupGetListInSystemResponse(OCIDataResponse):
    """Response to GroupGetListInSystemRequest.
        Contains a table with column headings: \"Group Id\", \"Group Name\", \"User Limit\", \"Organization Id\", \"Organization Type\", \"Reseller Id\"
        and a row for each group.
        The \"Organization Id\" column is populated with either a service provider Id or an enterprise Id.
        The \"Organization Type\" column is populated with one of the enumerated strings defined in the
        OrganizationType OCI data type.  Please see OCISchemaDataTypes.xsd for details on OrganizationType.

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

    Attributes:

        group_table (OCITable):

    """

    group_table: OCITable = field(metadata={"alias": "groupTable"})

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 GroupGetListInSystemRequest

client = Client()

command = GroupGetListInSystemRequest(
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupGetListInSystemRequest",
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

print(response)