SystemExportBroadCloudDataRequest

Bases: OCIRequest

Request to export all users that have BroadCloud services, such as user profile information and BroadCloud services related information for that user to a file so they can be uploaded to a Messaging Server/BroadCloud. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

file_name (str):

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

@dataclass(kw_only=True)
class SystemExportBroadCloudDataRequest(OCIRequest):
    """Request to export all users that have BroadCloud services, such as
        user profile information and BroadCloud services related information for that user
        to a file so they can be uploaded to a Messaging Server/BroadCloud.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        file_name (str):

    """

    file_name: str = field(metadata={"alias": "fileName"})

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 SystemExportBroadCloudDataRequest

client = Client()

command = SystemExportBroadCloudDataRequest(
    file_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemExportBroadCloudDataRequest",
    file_name=...,
)

print(response)