Read a derived element

GET {{baseUrl}}/api/model/derivedElements/:derivedElementId

This API gets a detailed definition for a specified derived element.

An information field describes the common object information such as the object ID, creation time, version ID, etc. An attribute field describes the object reference information of the attribute whose attribute elements the API intends to group. The elements field describes how the attribute elements are grouped together. Each element groups several attribute elements by either a list, filter, or calculation. A special element that groups all attribute elements that are not in other elements is an all other element.

The project ID is required to return a derived element's definition in metadata. The changeset ID is required to return a derived element's definition within a specific changeset. To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used.

A changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.

HEADERS

RESPONSES

status: OK

{"information":{"versionId":"F72F13044BAD4EF9A5CA2F3C26590ED5","primaryLocale":"en-US","objectId":"4E75BA29C537478F8478F641A35C3CC1","subType":"consolidation_element","name":"grouped derived element","destinationFolderId":"D3C7D461F69C4610AA6BAA5EF51F4125"},"attribute":{"objectId":"5603951E4FE1BC04A44E44B85BBB8ED2","subType":"attribute","name":"Age Range"},"elements":[{"id":"007CA6FCAAC64F65BDF0562096393335","name":"Age under 34","type":"list","format":{"header":[],"values":[]},"options":{"display":"this_element","subtotal":"this_element","includeIndividual":false},"text":"Under 24, 25 to 34","elements":[{"display":"Under 24","elementId":"h1"},{"display":"25 to 34","elementId":"h2"}]},{"id":"E45D731983234320BAEB66F01A14C020","name":"All Other","type":"all_other","format":{"header":[],"values":[]},"options":{"display":"individual_items","subtotal":"this_element"}}]}