Jump to

• Request
• Response

Modify the PcaSystem object.

put

https://{host}:{port}/{basePath}/PcaSystem/

modify the PcaSystem object.

Request

Path Parameters

• PcaSystemId(required):
  PcaSystemId to modify the associated PcaSystem.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• pcaSystem: object PcaSystem
  The PcaSystem object represents the PCA product system.

{
    "properties":{
        "pcaSystem":{
            "$ref":"#/components/schemas/PcaSystem",
            "type":"object"
        }
    }
}

Nested Schema : PcaSystem

Type: object

The PcaSystem object represents the PCA product system.

Show Source

• asrReminder(required): boolean
• availabilityDomain: string
  Maximum Length: 24
• configState: string
  Allowed Values: [ "CONFIG_USER", "CONFIG_SYSTEM_PARAMS", "WAIT_FOR_NETWORKING_SERVICE", "CONFIG_NETWORK_PARAMS", "CHECK_FOR_NETWORK_COMPLETION", "TEST_NETWORK_PARAMS", "CHECK_FOR_NETWORK_LOCK_COMPLETION", "COMPLETE" ]
• connectedState: boolean
• day0ConfigDetails: string
  Maximum Length: 512
• description(required): string
  Maximum Length: 1000
• domainName: string
  Maximum Length: 67
• faultIds: array faultIds
• generation: integer
• initialHwDiscoveryDetails: string
  Maximum Length: 1000
• initialHwDiscoveryStatus: string
  Allowed Values: [ "DISCOVERSUCCESS", "RESYNCSUCCESS", "PARTIALSUCCESS", "FAILURE", "UNKNOWN" ]
• initialHwDiscoveryTime: timestamp
• isDay0Running: boolean
• name(required): string
  Maximum Length: 256
• ociInfrastructureId: string
  Maximum Length: 256
• ociTenancyId: string
  Maximum Length: 256
• productType: string
  Allowed Values: [ "PCA", "RED2", "ULTRA" ]
• proxyEnabled: string
  Maximum Length: 64
• proxyHost: string
  Maximum Length: 256
• proxyName: string
  Maximum Length: 256
• proxyPassword: string
  Maximum Length: 256
• proxyPort: integer
• proxyUsername: string
  Maximum Length: 256
• rackType: string
  Allowed Values: [ "C3", "PCA" ]
• realm: string
  Maximum Length: 64
• realmDomainComponent: string
  Maximum Length: 64
• region: string
  Maximum Length: 64
• regionKey: string
  Maximum Length: 64
• reSyncHwDetails: string
  Maximum Length: 1000
• reSyncHwStatus: string
  Allowed Values: [ "SUCCESS", "FAILURE", "PARTIALSUCCESS", "UNKNOWN" ]
• reSyncHwTime: timestamp
• systemMode: string
  Allowed Values: [ "STANDALONE", "LINKED" ]
• systemName: string
  Maximum Length: 24
• systemStateIsLocked: string
  Maximum Length: 64
• timeNetworkConfigCreated: timestamp
• timeNetworkConfigLocked: timestamp
• vmHighAvailability: boolean
• workState: string

{
    "properties":{
        "productType":{
            "description":"",
            "enum":[
                "PCA",
                "RED2",
                "ULTRA"
            ],
            "type":"string"
        },
        "systemMode":{
            "description":"",
            "enum":[
                "STANDALONE",
                "LINKED"
            ],
            "type":"string"
        },
        "connectedState":{
            "description":"",
            "type":"boolean"
        },
        "configState":{
            "description":"",
            "enum":[
                "CONFIG_USER",
                "CONFIG_SYSTEM_PARAMS",
                "WAIT_FOR_NETWORKING_SERVICE",
                "CONFIG_NETWORK_PARAMS",
                "CHECK_FOR_NETWORK_COMPLETION",
                "TEST_NETWORK_PARAMS",
                "CHECK_FOR_NETWORK_LOCK_COMPLETION",
                "COMPLETE"
            ],
            "type":"string"
        },
        "initialHwDiscoveryTime":{
            "description":"",
            "type":"timestamp"
        },
        "initialHwDiscoveryStatus":{
            "description":"",
            "enum":[
                "DISCOVERSUCCESS",
                "RESYNCSUCCESS",
                "PARTIALSUCCESS",
                "FAILURE",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "initialHwDiscoveryDetails":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "reSyncHwTime":{
            "description":"",
            "type":"timestamp"
        },
        "reSyncHwStatus":{
            "description":"",
            "enum":[
                "SUCCESS",
                "FAILURE",
                "PARTIALSUCCESS",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "reSyncHwDetails":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "day0ConfigDetails":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "systemName":{
            "description":"",
            "maxLength":24,
            "type":"string"
        },
        "domainName":{
            "description":"",
            "maxLength":67,
            "type":"string"
        },
        "ociTenancyId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "ociInfrastructureId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"",
            "maxLength":24,
            "type":"string"
        },
        "realm":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "region":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "regionKey":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "realmDomainComponent":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "proxyName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "proxyHost":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "proxyPort":{
            "description":"",
            "type":"integer"
        },
        "proxyUsername":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "proxyPassword":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "asrReminder":{
            "description":"",
            "type":"boolean"
        },
        "proxyEnabled":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "vmHighAvailability":{
            "description":"",
            "type":"boolean"
        },
        "systemStateIsLocked":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "rackType":{
            "description":"",
            "enum":[
                "C3",
                "PCA"
            ],
            "type":"string"
        },
        "isDay0Running":{
            "description":"",
            "type":"boolean"
        },
        "timeNetworkConfigCreated":{
            "description":"",
            "type":"timestamp"
        },
        "timeNetworkConfigLocked":{
            "description":"",
            "type":"timestamp"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "asrReminder",
        "description",
        "name"
    ],
    "type":"object",
    "description":"The PcaSystem object represents the PCA product system."
}

Nested Schema : faultIds

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workItemIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top