Get Resource Functionalities

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/resource-functionalities

COPY

Query Parameters

string

resourceType

Optional

Resource type

string

functionalityType

Optional

Functionality type

string of array

resourceIds

Optional

Resource IDs

boolean

isAllowed

Optional

Allowed or disallowed resource functionalities

string

parentResourceType

Optional

Parent resource type

Responses

200

Returns PageOfResourceFunctionalities of type(s) application/json

{
    "elements": [
        {
            "functionalities": [
                {
                    "errorMessage": "string",
                    "isAllowed": "True",
                    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
                }
            ],
            "resourceId": "string",
            "resourceType": "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of ResourceFunctionalities

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

400

Bad Request

Returns Error of type(s) application/json

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

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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.

string

remediationMessage

Optional

The localized remediation error message

500

Internal Server Error

Returns Error of type(s) application/json

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

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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