Skip to content

SystemClassmarkAddRequest

Bases: OCIRequest

Add a Class Mark to system. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

classmark (str):

value (str):

web_display_key (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemClassmarkAddRequest(OCIRequest):
    """Add a Class Mark to system.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        classmark (str):

        value (str):

        web_display_key (Optional[str]):

    """

    classmark: str = field(metadata={"alias": "classmark"})

    value: str = field(metadata={"alias": "value"})

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 SystemClassmarkAddRequest

client = Client()

command = SystemClassmarkAddRequest(
    classmark=...,
    value=...,
    web_display_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemClassmarkAddRequest",
    classmark=...,
    value=...,
    web_display_key=...,
)

print(response)