Create Resource Using Adapter Instance Using POST

Create Resource Using Adapter Instance Using POST

The API will create the missing Adapter Kind and Resource Kind contained within the ResourceKey of the Resource if they do not exist. The API will return an error if the adapter instance specified does not exist. Additional implementation notes:

  • When creating a Resource, if the Resource Identifiers that are unique and required are not specified, the API would return an error with HTTP status code of 500 and an error message indicating the set of missing Resource Identifiers.
  • When creating a Resource, if the Resource Identifiers that are unique but not required are not specified, the Resource is created where the uniquely identifying Resource Identifiers that were not specified will have their value as an empty string.
Request
URI
POST
https://{api_host}/suite-api/api/resources/adapters/{adapterInstanceId}
COPY
Path Parameters
string
adapterInstanceId
Required

The adapter instance id

Request Body
resource of type(s) application/json
Optional 
{
    "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
extension
Optional

extension

geo-location
geoLocation
Optional

geoLocation

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

resourceKey

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.

Authentication
This operation uses the following authentication methods.
Responses
201

The created Resource

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
extension
Optional

extension

geo-location
geoLocation
Optional

geoLocation

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

resourceKey

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.


404

No Adapter Instance is found in the system corresponding to the Path Parameter that was specified

Operation doesn't return any data structure

500

The ResourceKey of the Resource is missing the uniquely identifying and required Resource Identifiers

Operation doesn't return any data structure

On This Page
Resources Operations
POST
Add Group Type Using POST
POST
Add Stats For Resources Using POST
POST
Add Stats For Resources Using Push Adapter Kind Using POST
POST
Create Custom Group Using POST
POST
Create Custom Profile Using POST
POST
Create Resource Using Adapter Instance Using POST
POST
Create Resource Using Adapter Kind Using POST
DELETE
Delete Custom Group Using DELETE
DELETE
Delete Custom Profile Using DELETE
DELETE
Delete Group Type Using DELETE
DELETE
Delete Resources Using DELETE
GET
Get Custom Group Members Using GET
GET
Get Custom Groups Using GET
GET
Get Custom Group Using GET
GET
Get Custom Profiles Using GET
GET
Get Custom Profile Using GET
GET
Get Group Types Using GET
GET
Get Latest Stats Of Resources Using GET
POST
Get Matching Resources Using POST
GET
Get Resource Properties List Using GET
POST
Get Resources Relationships Using POST
GET
Get Resources Using GET
GET
Get Stat Keys Of Resources Using GET
POST
Get Stats And DT For Resources Using POST
POST
Get Stats For Resources Using POST
GET
Get Stats Of Resources Using GET
GET
Get Top N Stats Of Resources Using GET
PUT
Mark Resources As Being Maintained Using PUT
PUT
Modify Custom Group Using PUT
PUT
Modify Custom Profile Using PUT
POST
Query Latest Properties Of Resources Using POST
POST
Query Latest Stats Of Resources Using POST
PUT
Start Monitoring Resources Using PUT
PUT
Stop Monitoring Resources Using PUT
DELETE
Unmark Resources As Being Maintained Using DELETE
PUT
Update Resource Using PUT