UserExecutiveModifyFilteringRequest

Bases: OCIRequest

Modify the filtering setting for an executive user. Both executive and the executive assistant can run this command. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

enable_filtering (Optional[bool]):

filtering_mode (Optional[str]):

simple_filter_type (Optional[str]):

criteria_activation (Optional[List[CriteriaActivation]]):

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

@dataclass(kw_only=True)
class UserExecutiveModifyFilteringRequest(OCIRequest):
    """Modify the filtering setting for an executive user.
        Both executive and the executive assistant can run this command.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        enable_filtering (Optional[bool]):

        filtering_mode (Optional[str]):

        simple_filter_type (Optional[str]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

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

    filtering_mode: Optional[str] = field(
        default=None, metadata={"alias": "filteringMode"}
    )

    simple_filter_type: Optional[str] = field(
        default=None, metadata={"alias": "simpleFilterType"}
    )

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserExecutiveModifyFilteringRequest

client = Client()

command = UserExecutiveModifyFilteringRequest(
    user_id=...,
    enable_filtering=...,
    filtering_mode=...,
    simple_filter_type=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserExecutiveModifyFilteringRequest",
    user_id=...,
    enable_filtering=...,
    filtering_mode=...,
    simple_filter_type=...,
    criteria_activation=...,
)

print(response)