Get Resources With Adapter And Resource Kind

Get Resources With Adapter And Resource Kind

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
string
name
Optional

The Resource Name (partial match)

object
identifiers
Optional

Key,value pairs representing the resource identifiers of a Resource

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page


Authentication
This operation uses the following authentication methods.
Responses
200

The set of Resources

Returns resources of type(s) application/json
"No Custom Example is Available"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
resourceList
Optional

The Collection of Resources


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/resources