Data Structures

Get a data structure by ID

Changed on

Retrieves a single data structure by its ID, scoped to the caller's organization.

get/api/v3/data-structures/{id}

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/data-structures/{id}
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Path parameters

idnumber required
Example:123

Data structure ID

Response

The data structure was found

idnumber required

Unique identifier of the data structure.

namestring required

Display name of the data structure.

strictboolean required

When true, all values stored against this structure must conform exactly to its spec.

teamIdnumber required

ID of the team that owns this data structure. The search endpoint always scopes results to this team; clients can also use it as an explicit filter.

Example response

{
  "id": 42,
  "name": "Customer record",
  "teamId": 88,
  "spec": [
    {
      "name": "name",
      "label": "Full Name",
      "required": true,
      "sequence": true,
      "codepage": "utf-8"
    }
  ]
}

Changes