Get Resources Using Credential Using GET
Gets the Objects using the Credential Instance specified by the identifier.
Request
URI
GET
https://{api_host}/api/credentials/{id}/resources
COPY
Path Parameters
string
id
Required
The identifier of the specific Credential Instance
Query Parameters
integer
page
Optional
Page number from which data needs to be displayed (0-based)
integer
pageSize
Optional
Expected number of entries per page
Responses
200
A list of Objects using the Credential Instance
Returns resources of type(s) application/json
{
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"pageInfo": {
"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "string",
"totalCount": 0
},
"resourceList": [
{
"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"
}
]
}
]
}
404
The Credential Instance does not exist
Operation doesn't return any data structure
On This Page
Credentials Operations
POST
Create Credential Using POST
DELETE
Delete Credential Using DELETE
GET
Get Adapter Instances Using Credential Using GET
GET
Get Credential Kinds Using GET
GET
Get Credentials Using GET
GET
Get Credential Using GET
GET
Get Resources Using Credential Using GET
PATCH
Partial Update Credential Using PATCH
PUT
Update Credential Using PUT