Get Resource Functionalities

Get Resource Functionalities

Get Resource Functionalities

Request
URI
GET
https://{api_host}/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

OK

Returns PageOfResourceFunctionalities of type(s) application/json
{
    "elements": [
        {
            "resourceType": "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER",
            "resourceId": "string",
            "functionalities": [
                {
                    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
                    "isAllowed": true,
                    "errorMessage": "string"
                }
            ]
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
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 object
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
"Error Object"
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 object
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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/resource-functionalities