GroupGetListInServiceProviderRequest

Bases: OCIRequest

Request the list of groups in a service provider or enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a GroupGetListInServiceProviderResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

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

@dataclass(kw_only=True)
class GroupGetListInServiceProviderRequest(OCIRequest):
    """Request the list of groups in a service provider or enterprise.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        The response is either a GroupGetListInServiceProviderResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

    """

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

    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"}
    )

Responses

Bases: OCIDataResponse

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

Attributes:

group_table (OCITable):

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

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

    Attributes:

        group_table (OCITable):

    """

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

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 GroupGetListInServiceProviderRequest

client = Client()

command = GroupGetListInServiceProviderRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupGetListInServiceProviderRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
)

print(response)