resource

resource
resource

Represents the external representation of a Resource.

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

Description of the 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.

resource-key
resourceKey
Required

Represents a composite key for uniquely identifying a Resource.

string As uuid As uuid
credentialInstanceId
Optional

Credential instance identifier assigned to this Resource, applicable only for adapter instances.

geo-location
geoLocation
Optional

Represents a geographical location on planet earth.

array of resource-status-state
resourceStatusStates
Required
Constraints: minItems: 0 maxItems: 0

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.

string
resourceHealth
Required

Enumeration that identifies the health of 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.

boolean
dtEnabled
Optional

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

integer As int32 As int32
monitoringInterval
Optional
Constraints: minimum: 0

Minutes part of the monitoring Interval of the resource, applicable only for adapter instances.

integer As int32 As int32
monitoringIntervalSeconds
Optional
Constraints: minimum: 0

Seconds part of the monitoring Interval of the resource, applicable only for adapter instances.

array of badge
badges
Optional
Constraints: minItems: 0 maxItems: 0

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.

array of string
relatedResources
Optional
Constraints: minItems: 0 maxItems: 0

Collection of related resource identifiers

extension
extension
Optional

extension

array of link
links
Optional

links

string As uuid As uuid
identifier
Optional

Identifier of the Resource (typically a UUID).

Property Of
Parameter To
Returned By