UserGetServiceInstanceListInServiceProviderRequest

Bases: OCIRequest

Request the list of Service Instances in a service provider or an enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider. The response is either a UserGetServiceInstanceListInServiceProviderResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_exact_service_type (Optional[SearchCriteriaExactServiceType]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

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

@dataclass(kw_only=True)
class UserGetServiceInstanceListInServiceProviderRequest(OCIRequest):
    """Request the list of Service Instances in a service provider or an enterprise.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider.
        The response is either a UserGetServiceInstanceListInServiceProviderResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_exact_service_type (Optional[SearchCriteriaExactServiceType]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

    """

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

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

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

    search_criteria_exact_service_type: Optional[SearchCriteriaExactServiceType] = (
        field(default=None, metadata={"alias": "SearchCriteriaExactServiceType"})
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

Responses

Bases: OCIDataResponse

Response to UserGetServiceInstanceListInServiceProviderRequest. Contains a table with column headings : "User Id", "Group Id", "Service Type", "Name", "Phone Number", "Extension", "Department" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums.

Attributes:

service_instance_table (OCITable):

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

@dataclass(kw_only=True)
class UserGetServiceInstanceListInServiceProviderResponse(OCIDataResponse):
    """Response to UserGetServiceInstanceListInServiceProviderRequest.
        Contains a table with column headings :  \"User Id\", \"Group Id\", \"Service Type\",
        \"Name\", \"Phone Number\", \"Extension\", \"Department\" in a row for each Service Instance.  Possible values for Service Type column are ServiceType enums.

    Attributes:

        service_instance_table (OCITable):

    """

    service_instance_table: OCITable = field(metadata={"alias": "serviceInstanceTable"})

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 UserGetServiceInstanceListInServiceProviderRequest

client = Client()

command = UserGetServiceInstanceListInServiceProviderRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_type=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGetServiceInstanceListInServiceProviderRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_type=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
)

print(response)