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/commands/commands.py
114071 114072 114073 114074 114075 114076 114077 114078 114079 114080 114081 114082 114083 114084 114085 114086 114087 114088 114089 114090 114091 114092 114093 114094 114095 114096 114097 114098 114099 114100 114101 114102 114103 114104 114105 114106 114107 114108 114109 114110 114111 114112 114113 114114 114115 114116 114117 114118 114119 114120 114121 114122 114123 114124 114125 114126 | |
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/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.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.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)