GET /hubs/{hubName}/objects/{objectName}/docs

GET /hubs/{hubName}/objects/{objectName}/docs

Retrieve the Open API Specifications (API docs) for an adapter object. The returned specifications are in the Version 2.0 OpenAPI Specification format.

Path Parameters

hubNameThe name of hub that the adapter is in.
objectNameThe name of the adapter object.

Query Parameters

discoveryInclude discoverable vendor metadata in the definitions object true. The default is false.boolean
resolveReferencesOptionally resolve swagger references for an inline object definition true. The default is false.boolean
basicInclude only OpenAPI / Swagger properties in definitions true. The default is false which include specification extensions.boolean

Header Parameters

Required: Authorization including User Secret, Organization Secret, and Adapter Instance Token

 

Response Fields

The response is a Version 2.0 OpenAPI Specification.

Example Request

curl -X GET \
  https://api-us.integrate.sugarapps.com/elements/api-v2/hubs/crm/objects/opportunities/docs?discovery=true&resolveReferences=false&basic=false" \ 
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2, Element yCCtl7Pqx0E4Qf6MBFXxT+/QcbogS1q1Deyw+1vSW=A3' \
  -H 'Content-Type: application/json' \

Example Response

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