Skip to content

SystemCallCenterEnhancedReportingScheduledReportGetListRequest

Bases: OCIRequest

Request to get the list of all call center reporting scheduled reports in the system. The response is either an SystemCallCenterEnhancedReportingScheduledReportGetListResponse or an ErrorResponse.

Attributes:

response_size_limit (Optional[int]):

search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_exact_call_center_scheduled_report_service_provider (Optional[SearchCriteriaExactCallCenterScheduledReportServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

search_criteria_call_center_report_template_name (Optional[List[SearchCriteriaCallCenterReportTemplateName]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest):
    """Request to get the list of all call center reporting scheduled reports in the system.
        The response is either an SystemCallCenterEnhancedReportingScheduledReportGetListResponse or an ErrorResponse.

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_exact_call_center_scheduled_report_service_provider (Optional[SearchCriteriaExactCallCenterScheduledReportServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

        search_criteria_call_center_report_template_name (Optional[List[SearchCriteriaCallCenterReportTemplateName]]):

    """

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_call_center_scheduled_report_name: Optional[
        List[SearchCriteriaCallCenterScheduledReportName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaCallCenterScheduledReportName"}
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_exact_call_center_scheduled_report_service_provider: Optional[
        SearchCriteriaExactCallCenterScheduledReportServiceProvider
    ] = field(
        default=None,
        metadata={
            "alias": "searchCriteriaExactCallCenterScheduledReportServiceProvider"
        },
    )

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_exact_call_center_scheduled_report_created_by_supervisor: Optional[
        SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor
    ] = field(
        default=None,
        metadata={
            "alias": "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor"
        },
    )

    search_criteria_call_center_report_template_name: Optional[
        List[SearchCriteriaCallCenterReportTemplateName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaCallCenterReportTemplateName"}
    )

Responses

Bases: OCIDataResponse

Response to SystemCallCenterEnhancedReportingScheduledReportGetListRequest. Contains a table with column headings : "Scheduled Report Name", "Description", "Service Provider Id", "Is Enterprise", "Group Id", "Created By", "Is Supervisor Report", "Status", "Report Template Name", "Report Template Level" and "Recurring". The "Created By" can be either "Administrator" or user id if created by supervisor. The possible values for "Status" are "Active", and "Completed". The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". The possible values for "Report Template Level" are "System", "Enterprise" and "Group". For the rows with "Is Enterprise" column value "true", the "Group Id" column will be empty.

Attributes:

scheduled_report_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCallCenterEnhancedReportingScheduledReportGetListResponse(OCIDataResponse):
    """Response to SystemCallCenterEnhancedReportingScheduledReportGetListRequest.
        Contains a table with column headings : \"Scheduled Report Name\", \"Description\",
        \"Service Provider Id\", \"Is Enterprise\", \"Group Id\", \"Created By\", \"Is Supervisor Report\",  \"Status\",
        \"Report Template Name\", \"Report Template Level\" and \"Recurring\".
        The \"Created By\" can be either \"Administrator\" or user id if created by supervisor.
        The possible values for \"Status\" are \"Active\", and \"Completed\".
        The possible values for \"Recurring\" are \"None\", \"Daily\", \"Weekly\", \"Monthly\" and \"Yearly\".
        The possible values for \"Report Template Level\" are \"System\", \"Enterprise\" and \"Group\".
        For the rows with \"Is Enterprise\" column value \"true\", the \"Group Id\" column will be empty.

    Attributes:

        scheduled_report_table (OCITable):

    """

    scheduled_report_table: OCITable = field(metadata={"alias": "scheduledReportTable"})

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 SystemCallCenterEnhancedReportingScheduledReportGetListRequest

client = Client()

command = SystemCallCenterEnhancedReportingScheduledReportGetListRequest(
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_group_id=...,
    search_criteria_exact_call_center_scheduled_report_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_call_center_report_template_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemCallCenterEnhancedReportingScheduledReportGetListRequest",
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_group_id=...,
    search_criteria_exact_call_center_scheduled_report_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_call_center_report_template_name=...,
)

print(response)