GET /elements/{id}/docs

GET /elements/{id}/docs

Retrieve the OpenAPI version 2 schema for an adapter by adapter id. Specify an operationId to return only a specific endpoint.

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.

Query Parameters

operationId
A unique string used that identifies a specific endpoint. For example, the OpenAPI specification for Salesforce Sales Cloud includes operationIDs like getAccountsActivities, createAccount, updateCampaignById, and many more.

Response Fields

For descriptions see the OpenAPI specification.

Example Request

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

Example Response

The response includes the OpenAPI specification file in the body.  The following example is an abbreviated version.


{  
  "basePath":"/elements/api-v2/hubs/crm",
  "paths":{  },
  "host":"console.cloud-elements.com",
  "schemes":[  ],
  "definitions":{  },
  "swagger":"2.0",
  "info":{  },
  "tags":[  ]
}