Get Resources Of Adapter Instance Using GET

Get Resources Of Adapter Instance Using GET

Get all resources that are managed by specific Adapter Instance

Request
URI
GET
https://{api_host}/api/adapters/{adapterId}/resources
COPY
Path Parameters
string
adapterId
Required

The identifier of the adapter 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


Authentication
This operation uses the following authentication methods.
Responses
200

The list of resources reported by this adapter

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"
                }
            ]
        }
    ]
}
array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result

array of resource
resourceList
Optional

The Collection of Resources


404

No adapter instance is found with the specified identifier

Operation doesn't return any data structure