Get Resources With Adapter And Resource Kind Using GET

Optionally filter these resources based on resource name. The resource name (specified as a query parameter) will be used for doing a partial match. However, if the resource identifiers and their values are specified, name is ignored and the API enforces all the mandatory (both uniquely identifying and required) identifiers are specified. This allows for looking up a single resource using a ResourceKey and allows the translation between a ResourceKey and a Resource UUID.

Example how to use the identifiers parameter (currently it cannot be used in our Swagger documentation): /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/resources?identifiers[key1]=value1&identifiers[key2]=value2

Request

URI

GET

https://{api_host}/suite-api/api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/resources

COPY

Path Parameters

string

adapterKindKey

Required

The Adapter Kind Identifier

string

resourceKindKey

Required

The Resource Kind Identifier

Query Parameters

map[string,string]

identifiers

Optional

Key,value pairs representing the resource identifiers of a Resource

string

name

Optional

The Resource Name (partial match)

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.

CSPToken

Responses

200

The set of Resources

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

page-info

pageInfo

Optional

pageInfo

array of resource

resourceList

Optional

The Collection of Resources