Update Resources Functionalities

Request

URI

PATCH

https://{api_host}/v1/resource-functionalities

COPY

Request Body

ResourceFunctionalitiesUpdateSpec of type(s) application/json

Required

Show optional properties

{
    "serviceId": "string",
    "operationName": "string",
    "operationId": "string",
    "resourceFunctionalities": [
        {
            "resourceType": "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER"
        }
    ]
}

{
    "serviceId": "string",
    "operationName": "string",
    "operationId": "string",
    "resourceFunctionalities": [
        {
            "resourceType": "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER",
            "resourceId": "string",
            "functionalities": [
                {
                    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
                    "isAllowed": true,
                    "errorMessage": "string"
                }
            ]
        }
    ]
}

string

serviceId

Required

The identifier of the service associated with the resource functionalities

string

operationName

Required

The name of the operation associated with the resource functionalities

string

operationId

Required

The identifier of the operation associated with the resource functionalities

array of ResourceFunctionalities

resourceFunctionalities

Required

List of resource functionalities associated with the caller

Responses

200

Returns ResourceFunctionalitiesCaller of type(s) application/json

{
    "operationId": "string",
    "operationName": "string",
    "serviceId": "string",
    "resourceFunctionalities": [
        {
            "resourceType": "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER",
            "resourceId": "string",
            "functionalities": [
                {
                    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
                    "isAllowed": true,
                    "errorMessage": "string"
                }
            ]
        }
    ]
}

string

operationId

Optional

The identifier of the operation associated with the resource functionalities

string

operationName

Optional

The name of the operation associated with the resource functionalities

string

serviceId

Optional

The identifier of the service associated with the resource functionalities

array of ResourceFunctionalities

resourceFunctionalities

Optional

List of resource functionalities associated with the caller

400

Bad Request

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

Internal Server Error

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.