GET /hubs/{hubName}/objects (v2)

GET hubs/{hubName}/objects (v2)

Retrieve a list of all data objects in an adapter and their source (the vendor, a Common Resource, or Sugar Integrate library). For version 2, pass Elements-Version: Helium in the request header.

Path Parameters

hubNameThe name of hub that the adapter is in.

Header Parameters

Required: 

  • Authorization including User Secret, Organization Secret, and Adapter Instance Token
  • Elements-Version: Helium. The Elements-Version header specifies the version of the API request, with Helium being version two required for this more verbose GET /objects endpoint.

 

Response Parameters

  • name The name of the adapter object. 
  • vendorName The name specified within the API provider's system. 
  • type Specifies whether the object is a Common Resource created in Sugar Integrate, a normalized Sugar Integrate object (ceCanonical), or an object that exists at the API provider (vendor).

Example Request

curl -X GET \
https://api-us.integrate.sugarapps.com/elements/api-v2/objects \
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2, Element yCCtl7Pqx0E4Qf6MBFXxT+/QcbogS1q1Deyw+1vSW=A3' \
-H 'Elements-Version: Helium ' \
-H 'Content-Type: application/json' \

Example Response

[
    {
        "name": "products",
        "vendorName": "Product",
        "type": "vdr"
    },
    {
        "name": "servicesDataV20.0SobjectsAttachmentBody",
        "vendorName": "servicesDataV20.0SobjectsAttachmentBody",
        "type": "vendor"
    },
    {
        "name": "servicesDataV35.0AnalyticsReportsDescribe",
        "vendorName": "servicesDataV35.0AnalyticsReportsDescribe",
        "type": "vendor"
    },
    {
        "name": "notes",
        "vendorName": "Note",
        "type": "vdr"
    },
    {
        "name": "incidents",
        "vendorName": "Case",
        "type": "vdr"
    },
    {
        "name": "tasks",
        "vendorName": "Task",
        "type": "vdr"
    },
    {
        "name": "contacts",
        "vendorName": "Contact",
        "type": "vdr"
    },
    {
        "name": "servicesDataV36.0SobjectsBody",
        "vendorName": "servicesDataV36.0SobjectsBody",
        "type": "vendor"
    },
    {
        "name": "agents",
        "vendorName": "Contact",
        "type": "vdr"
    },
    {
        "name": "attachments",
        "vendorName": "servicesDataV29.0SobjectsAttachment",
        "type": "ceCanonical"
    },
    {
        "name": "accounts",
        "vendorName": "Account",
        "type": "vdr"
    },
    {
        "name": "activities",
        "vendorName": "Event",
        "type": "vdr"
    },
    {
        "name": "reportsMetadata",
        "vendorName": "servicesDataV35.0AnalyticsReportsDescribe",
        "type": "ceCanonical"
    },
    {
        "name": "opportunities",
        "vendorName": "Opportunity",
        "type": "vdr"
    },
    {
        "name": "servicesDataV20.0SobjectsAttachment",
        "vendorName": "servicesDataV20.0SobjectsAttachment",
        "type": "vendor"
    },
    {
        "name": "users",
        "vendorName": "User",
        "type": "vdr"
    },
    {
        "name": "servicesDataV29.0SobjectsAttachment",
        "vendorName": "servicesDataV29.0SobjectsAttachment",
        "type": "vendor"
    },
    {
        "name": "attachments",
        "vendorName": "servicesDataV36.0SobjectsAttachments",
        "type": "ceCanonical"
    },
    {
        "name": "reports",
        "vendorName": "Report",
        "type": "vdr"
    }
]