GET /elements/{id}/metadata

GET /elements/{id}/metadata

Retrieve the metadata of a specific adapter by adapter id.

Path Parameters

idThe adapter id is a unique numeric identifier for the adapter, distinct from the adapter key, which is alphanumeric. In our documentation, the placeholder {elementId} should be replaced with an adapter id value.

Response Fields

The table below shows an abbreviated list of response fields.

idThe adapter id is a unique numeric identifier for the adapter, distinct from the adapter key, which is alphanumeric. In our documentation, the placeholder {elementId} should be replaced with an adapter id value.
nameThe display name of the adapter.
keyThe key is a unique alphanumeric identifier for the , distinct from the id which is numeric.
descriptionA brief description of the adapter.
authenticationType
Identifies the type of authentication used.
eventsAn object that identifies whether events are supported and, if so, what kind (webhooks or polling).

Example Request

curl -X GET \
  https://api-us.integrate.sugarapps.com/elements/api-v2/elements/23/metadata \
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \ \
  -H 'Content-Type: application/json' \

Example Response


{
    "id": 23,
    "name": "Salesforce Sales Cloud",
    "key": "sfdc",
    "displayOrder": 100,
    "active": false,
    "beta": false,
    "description": "Add a Salesforce Instance to connect your existing Salesforce account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple CRM adapters or your other Salesforce services. You will need your Salesforce account information to add an instance.",
    "transformations": false,
    "churros": false,
    "normalizedPaging": false,
    "swaggerValidated": false,
    "cloneable": false,
    "authenticationType": "custom",
    "events": {
        "supported": true,
        "methods": [
            "polling"
        ]
    },
    "resources": []
}