v1
latestOpenAPI 3.0.32026-07-14101033.6 KBGet the structure of an analysis sets or selection list
Use this API operation to get the structural definition of an analysis sets or selection lists.
Query parameters
The unique id of the analysis set.
This parameter is required and has no default.
Note: for historical reasons, this parameter is usually called maskid in AlisQI URLs. The API uses setId for consistency with the terminology used in the user interface.
Whether to only show currently active fields or also include deactivated fields.
Defaults to true (only active fields).
Response
The output will be a JSON-encoded object.
For both analysis sets and selection lists, the object will have properties name and fields. Analysis sets will also have group and indexField, which might be null.
The fields value will be an array of objects. These objects are listed in order and describe the fields. Object properties will vary based on the field type:
-
date fields have a format property, which is either date or datetime.
-
numeric fields all have decimals. If this is null, the field holds a floating point value. Calculations have a formula, while others have a default.
-
select fields have properties (listId, listField, listFilter) that define which selection list the field is based on, and which of list's fields is selected, along with which filter (see the product field in the example below).
-
text fields have a multiLine property with a boolean value.
Example response
{
"fields": [
{
"name": "date",
"label": "Date",
"abbreviation": "Date",
"unit": null,
"type": "date",
"required": true,
"format": "datetime",
"active": true
}
]
}