Connectors

2 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List field hierarchies for all connectors

GET/api/v1/connectors/field-hierarchies/

API key permissionDatastream: Read-onlydatastream:read

Returns the field dependency graph for every connector that has configuration fields with dependencies. Data is static and changes only with connector releases.

Query parameters

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedConnectorFieldHierarchySchema

• itemsarray of objectrequired
  Items · ConnectorFieldHierarchySchema

  • connectorstringrequired
  • fieldsobjectrequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/connectors/field-hierarchies/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "connector": "string",
      "fields": {
        "key": {
          "depends_on": [
            null
          ]
        }
      }
    }
  ],
  "count": 1
}

Get field hierarchy for a connector

GET/api/v1/connectors/{path}/field-hierarchy/

API key permissionDatastream: Read-onlydatastream:read

Returns the field dependency graph for a single connector, showing which configuration fields depend on which. Use the content type identifier (app_label/model_name) or nocode/slug from the list endpoint.

Path parameters

• pathstringrequired

Responses

200OKapplication/json

Response schema

object ConnectorFieldHierarchySchema

• connectorstringrequired
• fieldsobjectrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/connectors/{path}/field-hierarchy/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "connector": "string",
  "fields": {
    "key": {
      "depends_on": [
        "string"
      ]
    }
  }
}

Was this page helpful? Yes No