Skip to content

UserGetServiceInstanceListInSystemRequest

Bases: OCIRequest

Request the list of Service Instances in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the service instances in the administrator's reseller meeting the search criteria are returned.

The response is either a UserGetServiceInstanceListInSystemResponse or an ErrorResponse.

The following data elements are only used in AS data mode:
  searchCriteriaResellerId

Attributes:

response_size_limit (Optional[int]):

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_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserGetServiceInstanceListInSystemRequest(OCIRequest):
    """Request the list of Service Instances in the system.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the service
        instances in the administrator's reseller meeting the search criteria are returned.

        The response is either a UserGetServiceInstanceListInSystemResponse or an ErrorResponse.

        The following data elements are only used in AS data mode:
          searchCriteriaResellerId

    Attributes:

        response_size_limit (Optional[int]):

        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_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

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

    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_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_exact_service_provider: Optional[
        SearchCriteriaExactServiceProvider
    ] = field(default=None, metadata={"alias": "searchCriteriaExactServiceProvider"})

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

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to UserGetServiceInstanceListInSystemRequest. Contains a table with column headings : "User Id", "Group Id", "Service Provider Id", "Service Type", "Name", "Phone Number", "Extension", "Reseller Id" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums. The following columns are only returned in AS data mode: "Reseller Id"

Attributes:

service_instance_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserGetServiceInstanceListInSystemResponse(OCIDataResponse):
    """Response to UserGetServiceInstanceListInSystemRequest.
        Contains a table with column headings : \"User Id\", \"Group Id\", \"Service Provider Id\", \"Service Type\", \"Name\", \"Phone Number\",
        \"Extension\", \"Reseller Id\" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums.
        The following columns are only returned in AS data mode:
          \"Reseller Id\"

    Attributes:

        service_instance_table (OCITable):

    """

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

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserGetServiceInstanceListInSystemRequest

client = Client()

command = UserGetServiceInstanceListInSystemRequest(
    response_size_limit=...,
    search_criteria_exact_service_type=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserGetServiceInstanceListInSystemRequest",
    response_size_limit=...,
    search_criteria_exact_service_type=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

print(response)