Create Resource Using Adapter Kind Using POST
This adapter kind (referred to as 'Push' adapter kind) will be created if it does not exist in the system and an instance of it will be associated with the Resource being created. This adapter kind if it already exists must of OPENAPI adapter kind type. The API will also create the missing Adapter Kind and Resource Kind contained within the ResourceKey of the Resource if they do 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.
The adapter kind key
Show optional properties
{
"creationTime": 0,
"identifier": "string",
"resourceHealth": "string",
"resourceHealthValue": "number",
"resourceKey": {
"adapterKindKey": "string",
"name": "string",
"resourceKindKey": "string"
},
"resourceStatusStates": [
{}
]
}
{
"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"
}
]
}
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.
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.
Credential instance identifier assigned to this Resource
Description of the Resource
DT calculation enabled or not. By default DT calculation for a resource is enabled (during its creation).
Identifier of the Resource (typically a UUID).
Minutes part of the monitoring Interval of the resource
monitoringIntervalMinutes
Seconds part of the monitoring Interval of the resource
Collection of related resource identifiers
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.
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.
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.
The created Resource
{
"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"
}
]
}
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.
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.
Credential instance identifier assigned to this Resource
Description of the Resource
DT calculation enabled or not. By default DT calculation for a resource is enabled (during its creation).
Identifier of the Resource (typically a UUID).
Minutes part of the monitoring Interval of the resource
monitoringIntervalMinutes
Seconds part of the monitoring Interval of the resource
Collection of related resource identifiers
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.
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.
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.
The 'Push' adapter kind specified already exists in the system and doesn't correspond to an Adapter Kind that is of OPENAPI type