Get Resource Using GET

Get the Resource for the specified identifier

Request

URI

GET

https://{api_host}/api/resources/{id}

COPY

Path Parameters

string

Required

The Resource identifier

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The Resource for the specified UUID

Returns resource of type(s) application/json

{
    "badges": [
        {
            "color": "string",
            "score": "number",
            "type": "string"
        }
    ],
    "creationTime": 0,
    "credentialInstanceId": "string",
    "description": "string",
    "dtEnabled": false,
    "extension": {
        "anyObjects": [
            {}
        ]
    },
    "geoLocation": {
        "latitude": "number",
        "longitude": "number"
    },
    "identifier": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "monitoringInterval": 0,
    "monitoringIntervalMinutes": 0,
    "monitoringIntervalSeconds": 0,
    "relatedResources": [
        "string"
    ],
    "resourceHealth": "string",
    "resourceHealthValue": "number",
    "resourceKey": {
        "adapterKindKey": "string",
        "extension": {
            "anyObjects": [
                {}
            ]
        },
        "links": [
            {
                "description": "string",
                "href": "string",
                "name": "string",
                "rel": "string"
            }
        ],
        "name": "string",
        "resourceIdentifiers": [
            {
                "identifierType": {
                    "dataType": "string",
                    "extension": {
                        "anyObjects": [
                            {}
                        ]
                    },
                    "isPartOfUniqueness": false,
                    "links": [
                        {
                            "description": "string",
                            "href": "string",
                            "name": "string",
                            "rel": "string"
                        }
                    ],
                    "name": "string"
                },
                "key": "string",
                "links": [
                    {
                        "description": "string",
                        "href": "string",
                        "name": "string",
                        "rel": "string"
                    }
                ],
                "name": "string",
                "uniquelyIdentifying": false,
                "value": "string"
            }
        ],
        "resourceKindKey": "string"
    },
    "resourceStatusStates": [
        {
            "adapterInstanceId": "string",
            "resourceState": "string",
            "resourceStatus": "string",
            "statusMessage": "string"
        }
    ]
}

array of badge

badges

Optional

The various major and minor badges and their values for a Resource. If certain badges are not present in the list then either those badges are not applicable to this resource or the calculation of those badges has been disabled for this resource.

integer As int64 As int64

creationTime

Required

Time the Resource was created in the system. This is a 'read-only' property and is system generated.The server ignores any changes to this field when trying to update a resource.

string As uuid As uuid

credentialInstanceId

Optional

Credential instance identifier assigned to this Resource

string

description

Optional

Description of the Resource

boolean

dtEnabled

Optional

DT calculation enabled or not. By default DT calculation for a resource is enabled (during its creation).

extension

Optional

extension

geo-location

geoLocation

Optional

Represents a geographical location on planet earth.

string As uuid As uuid

identifier

Required

Identifier of the Resource (typically a UUID).

array of link

links

Optional

links

integer As int32 As int32

monitoringInterval

Optional

Minutes part of the monitoring Interval of the resource

integer As int32 As int32

monitoringIntervalMinutes

Optional

monitoringIntervalMinutes

integer As int32 As int32

monitoringIntervalSeconds

Optional

Seconds part of the monitoring Interval of the resource

array of string

relatedResources

Optional

Collection of related resource identifiers

string

resourceHealth

Required

Health of the Resource. This is a 'read-only' property and its value is computed by the system. The server ignores any changes to this field when trying to update a resource.

Possible values are : GREEN, YELLOW, ORANGE, RED, GREY,

number As double As double

resourceHealthValue

Required

Resource Health Score. This is a 'read-only' property and its value is computed by the system. The server ignores any changes to this field when trying to update a resource.

resource-key

resourceKey

Required

Represents a composite key for uniquely identifying a Resource.

array of resource-status-state

resourceStatusStates

Required

The resource status and resource state for this resource as reported by one or more adapter instances. The server ignores any changes to this field when trying to update a resource.

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Resource Operations

POST

Add Properties Using POST

POST

Add Properties Using Push Adapter Kind Using POST