Data element formats

You can retrieve elements from the API in both JSON and XML formats.

The format depends on the Accept HTTP header parameter. Accept: application/json returns elements in JSON. Accept: application/xml returns elements in XML.

Elements include at least the name and comment information. If administrative Domains are used, elements also include a link to the domains to which the elements belong. In addition, elements include two flags that show whether they are system and/or read-only. Custom elements have system and read-only attributes with a false value.

Elements must show the key attribute to be updated. Elements show their specific attributes and elements as a content description. The API uses the element type and the key attribute to identify the element. The key attribute must be unique within each element type, but elements of different types can have the same key attribute.

By default, all attributes and elements from the data element input that are not supported are ignored. For this reason, we recommend to first retrieve an existing element in XML or JSON and then create an element or update the existing element.

For example, the “link” element is always ignored in data element input, the “key” attribute is always ignored in element creation, and the “system” and “read_only” attributes are always ignored.