/datasets/{datasetId}/dataTypes (DEPRECATED)

Get a collection of custom data types for a dataset.

Important: The Batch Data Extract and Dataset V2 endpoints should be used instead of the Datasets endpoints.
  • Batch Data Extract endpoints return a complete export of activity and profile variable data.
  • Datasets V2 endpoints allows you to select specific activities or profile variables.

Resource URL

/v1/applications/{communityApiKeyName}/datasets/{datasetId}/dataTypes

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see API Access.

Available methods

Method Description
GET Returns a collection of data types.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation Description Example

Refine the response by field

To reduce the number of fields returned, specify the fields in a comma separated list.

You can filter the response on the following fields:
  • constructor
  • href
  • name
/datasets/{datasetId}/dataTypes?fields=name
Filtering by value By default, all the items are returned unless you specify your criteria using the variable name and value.
You can filter the response on the values in the following fields:
  • constructor
  • name
/datasets/{datasetId}/dataTypes?constructor=enum
Paging The default is 20 items returned at a time and the maximum is 1000. Use the limit and offset query string parameters to effectively page through the results.
Sorting You can sort the results on the name and constructor fields. /datasets/{datasetId}/dataTypes?sort=constructor:d

For more information, see Content control.

Available fields

Field Description
constructor The string value for the primitive or custom data type. Possible values are:
  • enum
  • set
href This field will always be null.
links This field will always be empty.
name The string or URN value for the data type.
parameters Defines the value set.
  • dataType: The string name for the data type
  • value: The range of possible values
GET response structure

{
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 2
  },
  "items": [
    {
      "name": <urn of data type>,
      "constructor": <enum|set>,
      "parameters": [
        {
          "dataType": <data type name>
        },
        {
          "dataType": <data type name>,
          "value": <data value>
        },
        {
          "dataType": <data type name>,
          "value": <data value>
        },
        {
          "dataType": <data type name>,
          "value": <data value>
        }
      ],
      "links": [],
      "href": null
    },
    {
      "name": <urn of data type>,
      "constructor": <enum|set>,
      "parameters": [
        {
          "dataType": <data type name>
        },
        {
          "dataType": <data type name>,
          "value": <data value>
        }
      ],
      "links": [],
      "href": null
    },
  ],
  "links": [
    {
      "rel": "first",
      "href": "https://https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/dataTypes?offset=0&limit=20"
    },
    {
      "rel": "prev",
      "href": null
    },
    {
      "rel": "last",
      "href": null
    },
    {
      "rel": "next",
      "href": null
    }
  ]
  "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/dataTypes"
}