Create new set or list

post

https://{subdomain}.alisqi.com/api/createSet

This endpoint allows the creation of a new set or list, with its properties and collection of fields.

Pass name, type and groupId as query parameters, and send the field definitions as a JSON array in the request body (with Content-Type: application/json).

Example: POST /api/createSet?name=Coating&type=set&groupId=3 with body [{"label": "Date", "type": "date", "format": "datetime", "required": true}]

Alternatively, the field definitions can be passed as a JSON string in a fields form or query parameter.

The user group of the user associated with the token is granted all permissions on the new set or list. This operation does not count towards the rate limit.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

required

Name of the set or list. Must not be empty.

type

string

enum

required

Type of the set, either set or list.

Allowed:

groupId

integer

Group ID. Required if type is set, and must be left out if type is list.

Body Params

The field definitions, as a JSON array. The fields are added to the set in this order and appear as form fields.

label

string

required

Human-readable title for the field.

abbreviation

string

Abbreviation for the field title.

unit

string

Unit of measure for the field.

method

string

The field's test method.

type

string

enum

required

Type of field.

Allowed:

required

boolean

Defaults to false

Indicates if the field is required.

lockOnValue

boolean

Whether the field is locked after receiving its first value.

isIndex

boolean

Indicates whether the field should be configured as the index field. Applies to required select fields only.

format

string

enum

Specific format for date or numeric fields. This property is required for date or numeric fields.

Allowed:

multiline

boolean

Controls the appearance of text fields in forms. Applies to text fields only.

Note that this property is written in lowercase (multiline), unlike the multiLine property returned by getSetDefinition.

decimals

integer

Number of decimal places. Applies to numeric fields only.

default

number

Default value for the field. Applies to numeric fields only.

listId

integer

ID of the selection list associated with a select field. Applies to select fields only.

listField

string

Field name in the selection list identified by listId. The referenced fields needs to be required and of type text or numeric

radioButtons

boolean

Controls appearance of select fields, either radio buttons or dropdown. Applies to select fields only.

lockResultSignoff

boolean

Whether the entire result should be locked upon sign-off. Applies to signature fields only.

200Set created successfully.

400Bad Request: a parameter or field definition is missing or invalid.

401Unauthorized: no token was provided, or the token is invalid.

403Forbidden: the user associated with the token doesn't have permission to create sets, or the request comes from an IP address that is not in the token's IP allow-list.

500Internal Server Error: an unexpected error occurred, or the rate limit has been exceeded (see Rate limiting in the API description).