Skip to content

GroupScheduleGetPagedSortedListRequest

Bases: OCIRequest

Get the list of schedules viewable by a group. The response is either a GroupScheduleGetPagedSortedListResponse or an ErrorResponse. If no sortOrder is included, the response is sorted by Name ascending by default. 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):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_schedule_name (Optional[SortByScheduleName]):

search_criteria_schedule_name (Optional[List[SearchCriteriaScheduleName]]):

search_criteria_exact_schedule_type (Optional[List[SearchCriteriaExactScheduleType]]):

search_criteria_exact_schedule_level (Optional[List[SearchCriteriaExactScheduleLevel]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupScheduleGetPagedSortedListRequest(OCIRequest):
    """Get the list of schedules viewable by a group.
        The response is either a GroupScheduleGetPagedSortedListResponse or an ErrorResponse.
        If no sortOrder is included, the response is sorted by Name ascending by default.
        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):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_schedule_name (Optional[SortByScheduleName]):

        search_criteria_schedule_name (Optional[List[SearchCriteriaScheduleName]]):

        search_criteria_exact_schedule_type (Optional[List[SearchCriteriaExactScheduleType]]):

        search_criteria_exact_schedule_level (Optional[List[SearchCriteriaExactScheduleLevel]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

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

    sort_by_schedule_name: Optional[SortByScheduleName] = field(
        default=None, metadata={"alias": "sortByScheduleName"}
    )

    search_criteria_schedule_name: Optional[List[SearchCriteriaScheduleName]] = field(
        default=None, metadata={"alias": "searchCriteriaScheduleName"}
    )

    search_criteria_exact_schedule_type: Optional[
        List[SearchCriteriaExactScheduleType]
    ] = field(default=None, metadata={"alias": "searchCriteriaExactScheduleType"})

    search_criteria_exact_schedule_level: Optional[
        List[SearchCriteriaExactScheduleLevel]
    ] = field(default=None, metadata={"alias": "searchCriteriaExactScheduleLevel"})

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

Responses

Bases: OCIDataResponse

Response to GroupScheduleGetPagedSortedListRequest. Contains a 3 column table with column headings: "Name", "Type", "Level" and a row for each schedule.

Attributes:

schedule_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupScheduleGetPagedSortedListResponse(OCIDataResponse):
    """Response to GroupScheduleGetPagedSortedListRequest.
        Contains a 3 column table with column headings: \"Name\", \"Type\", \"Level\"
        and a row for each schedule.

    Attributes:

        schedule_table (OCITable):

    """

    schedule_table: OCITable = field(metadata={"alias": "scheduleTable"})

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 GroupScheduleGetPagedSortedListRequest

client = Client()

command = GroupScheduleGetPagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_schedule_name=...,
    search_criteria_schedule_name=...,
    search_criteria_exact_schedule_type=...,
    search_criteria_exact_schedule_level=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupScheduleGetPagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_by_schedule_name=...,
    search_criteria_schedule_name=...,
    search_criteria_exact_schedule_type=...,
    search_criteria_exact_schedule_level=...,
    search_criteria_mode_or=...,
)

print(response)