GroupGetListInServiceProviderPagedSortedListRequest

Bases: OCIRequest

Request the list of groups in a service provider or enterprise. If no sortOrder is included, the response is sorted by Group Id ascending by default. The response is either a GroupGetListInServiceProviderPagedSortedListResponse or an ErrorResponse. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.

Attributes:

service_provider_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupGetListInServiceProviderPagedSortedList]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

search_criteria_mode_or (Optional[bool]):

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

@dataclass(kw_only=True)
class GroupGetListInServiceProviderPagedSortedListRequest(OCIRequest):
    """Request the list of groups in a service provider or enterprise.
        If no sortOrder is included, the response is sorted by Group Id ascending by default.
        The response is either a GroupGetListInServiceProviderPagedSortedListResponse or an ErrorResponse.
        If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by
        default, and the responsePageSize will be set to the maximum responsePageSize by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is
        included. Then the search criteria are logically ORed together.

    Attributes:

        service_provider_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupGetListInServiceProviderPagedSortedList]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[
        List[SortOrderGroupGetListInServiceProviderPagedSortedList]
    ] = field(default=None, metadata={"alias": "sortOrder"})

    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_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

Responses

Bases: OCIDataResponse

Response to GroupGetListInServiceProviderPagedSortedListRequest. Contains a table with column headings: "Group Id", "Group Name", "User Limit" and "Group External Id" and a row for each group.

The following columns are only populated in AS data mode:
  "Group External Id".

Attributes:

group_table (OCITable):

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

@dataclass(kw_only=True)
class GroupGetListInServiceProviderPagedSortedListResponse(OCIDataResponse):
    """Response to GroupGetListInServiceProviderPagedSortedListRequest.
        Contains a table with column headings: \"Group Id\", \"Group Name\", \"User Limit\" and \"Group External Id\"
        and a row for each group.

        The following columns are only populated in AS data mode:
          \"Group External 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 GroupGetListInServiceProviderPagedSortedListRequest

client = Client()

command = GroupGetListInServiceProviderPagedSortedListRequest(
    service_provider_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupGetListInServiceProviderPagedSortedListRequest",
    service_provider_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_mode_or=...,
)

print(response)