Get Adapter Type Using GET

Get Adapter Type Using GET

This API provides the Adapter Kinds by passing specified identifier

Request
URI
GET
https://{api_host}/suite-api/api/adapterkinds/{id}
COPY
Path Parameters
string
id
Required

The Adapter Kind Identifier

Query Parameters
boolean
retrieveResourceKindInfos
Optional

Optional param that specifies whether need to report resource-kind-keys


Authentication
This operation uses the following authentication methods.
Responses
200

The detailed information about the Adapter Kind

Returns adapter-kind of type(s) application/json
{
    "adapterKindType": "string",
    "describeVersion": 0,
    "description": "string",
    "identifiers": [
        "string"
    ],
    "key": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "resourceKinds": [
        "string"
    ]
}
string
adapterKindType
Required

The Adapter Kind Type

integer As int32 As int32
describeVersion
Optional

Adapter's Describe version This is not the version of the Adapter but the version number in the describe.xml file. For Adapter Kinds that are dynamically created and not based on a describe.xml file, the value will be null

string
description
Optional

The Description of the Adapter Kind

array of string
identifiers
Optional

The Adapter Kind identifiers

string
key
Required

The key which identifies an adapter kind uniquely in the system

array of link
links
Optional

links

string
name
Optional

The Localized name of the Adapter Kind

array of string
resourceKinds
Optional

Resource Kinds (keys) defined within this Adapter Kind