GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest

Bases: OCIRequest

Request to get a list of active group level call center reporting scheduled reports. The response is either a GroupCallCenterEnhancedReportingScheduledReportGetActiveListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

search_criteria_exact_call_center_report_template_key (Optional[SearchCriteriaExactCallCenterReportTemplateKey]):

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

@dataclass(kw_only=True)
class GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest):
    """Request to get a list of active group level call center reporting scheduled reports.
        The response is either a GroupCallCenterEnhancedReportingScheduledReportGetActiveListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

        search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

        search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

        search_criteria_exact_call_center_report_template_key (Optional[SearchCriteriaExactCallCenterReportTemplateKey]):

    """

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

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

    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_exact_call_center_scheduled_report_created_by_supervisor: Optional[
        SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor
    ] = field(
        default=None,
        metadata={
            "alias": "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor"
        },
    )

    search_criteria_exact_call_center_report_template_key: Optional[
        SearchCriteriaExactCallCenterReportTemplateKey
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaExactCallCenterReportTemplateKey"},
    )

Responses

Bases: OCIDataResponse

Response to GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest Contains a table with column headings : "Schedule Name", "Description", "Created By", "Is Supervisor Report", "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 "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". The possible values for "Report Template Level" are "System" and "Group".

Attributes:

scheduled_report_table (OCITable):

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

@dataclass(kw_only=True)
class GroupCallCenterEnhancedReportingScheduledReportGetActiveListResponse(
    OCIDataResponse
):
    """Response to GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest
        Contains a table with column headings : \"Schedule Name\", \"Description\", \"Created By\",
        \"Is Supervisor Report\", \"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 \"Recurring\" are \"None\", \"Daily\", \"Weekly\", \"Monthly\" and \"Yearly\".
        The possible values for \"Report Template Level\" are \"System\" and \"Group\".

    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 GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest

client = Client()

command = GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_exact_call_center_report_template_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest",
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_exact_call_center_report_template_key=...,
)

print(response)