Connections API

Retrieve connection by ID

Changed on

Retrieves a connection by ID

get/data/connections/{connectionId}

Request

  • Base URL: https://cja.adobe.io
  • URL: https://cja.adobe.io/data/connections/{connectionId}
  • Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Path parameters

connectionIdstring required

The id of the connection to lookup

Query parameters

expansionstring[]

Comma-delimited list of additional fields to include on response.

localestring

Locale

includeHiddenDataSetstrue | false

Include hidden data sets

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Response

successful operation

primaryIdTypestring
shardTablestring
namestring
descriptionstring
modifiedDatestring date-time
createdDatestring date-time
organizationstring
modifiedBystring
modifiedByFullNamestring
backfillEnabledboolean
sandboxIdstring
sandboxNamestring
floatPrecisioninteger
dataRetentionMonthsinteger
tagsobject[]
idWithoutPrefixstring uuid
idstring

Example response

{
  "dataSets": [
    {
      "backfills": [
        {
          "startDate": "2022-03-11T14:44:16Z",
          "endDate": "2022-03-11T14:44:16Z",
          "createdDate": "2022-03-11T14:44:16Z"
        }
      ],
      "streamingEnabledAt": "2022-03-11T14:44:16Z"
    }
  ]
}

Changes

  • a90e9a66f1b5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

  • 16c119587e5fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status