v1

latestOpenAPI 3.0.32026-07-14101033.6 KB

Specifications

Get specification versions

Use this API operation to get (a) specification version(s) for an analysis set.

get/getSpecificationVersion

Query parameters

setIdinteger required

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.

indexValuestring

The index field value. (This only applies to sets that have an index field.)

Get the current specification version for this index value.

index value matching is case-insensitive.

Response

The output will be a JSON-encoded object with two properties: startDateTime and specs. The latter is another object with properties for each spec field (numeric or select type).

If the specification version is generic, a third property (generic) will be present. A generic specification version applies to all index values.

startDateTimestring datetime

genericboolean

Example response

{
  "startDateTime": "2001-02-03 14:15:16",
  "generic": true,
  "specs": {
    "numericfield": {
      "innermin": 3,
      "goal": 5,
      "max": 9
    },
    "selectfield": [
      "Option One",
      "Option Two"
    ]
  }
}