Skip to content

UserScheduleGetPagedSortedListRequest

Bases: OCIRequest

Get the list of schedules viewable by a User. The list can be filtered by schedule name, schedule type, and schedule level. The response is either a UserScheduleGetPagedSortedListResponse or an ErrorResponse. This command is authorized to user who is Executive-Assistant of the Executive. 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:

user_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 UserScheduleGetPagedSortedListRequest(OCIRequest):
    """Get the list of schedules viewable by a User. The list can be filtered by schedule name,
        schedule type, and schedule level.
        The response is either a UserScheduleGetPagedSortedListResponse or an ErrorResponse.
        This command is authorized to user who is Executive-Assistant of the Executive.
        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:

        user_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]):

    """

    user_id: str = field(metadata={"alias": "userId"})

    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 UserScheduleGetPagedSortedListRequest. 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 UserScheduleGetPagedSortedListResponse(OCIDataResponse):
    """Response to UserScheduleGetPagedSortedListRequest.
        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 UserScheduleGetPagedSortedListRequest

client = Client()

command = UserScheduleGetPagedSortedListRequest(
    user_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("UserScheduleGetPagedSortedListRequest",
    user_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)