v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Metadata templates

List all metadata templates for enterprise

Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

get/metadata_templates/enterprise

Query parameters

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

Response

Returns all of the metadata templates within an enterprise and their corresponding schema.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

next_markerstring nullable

The marker for the start of the next page of results.

prev_markerstring nullable

The marker for the start of the previous page of results.

Example response

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "58063d82-4128-7b43-bba9-92f706befcdf",
      "type": "metadata_template",
      "scope": "enterprise_123456",
      "templateKey": "productInfo",
      "displayName": "Product Info",
      "hidden": true,
      "fields": [
        {
          "type": "string",
          "key": "category",
          "displayName": "Category",
          "description": "The category",
          "hidden": true,
          "options": [
            {
              "key": "Category 1",
              "id": "45dc2849-a4a7-40a9-a751-4a699a589190"
            }
          ],
          "taxonomyKey": "locationTaxonomy",
          "taxonomyId": "05ece6d7-fec4-4d3f-bfd2-36fd4dddea97",
          "namespace": "enterprise_123456",
          "optionsRules": {
            "multiSelect": true,
            "selectableLevels": [
              1,
              2
            ]
          },
          "id": "822227e0-47a5-921b-88a8-494760b2e6d2"
        }
      ],
      "copyInstanceOnItemCopy": true
    }
  ]
}