API Reference

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.

Body Params
string
required

Name of the set or list

string
enum
required

Type of the set, either 'set' or 'list'.

Allowed:
integer

Group ID, required if type is 'set', should be omitted if the type is 'list'.

fields
array of objects
required
length ≥ 1

Collection of fields that will be added to the set. They will appear as form fields.

fields*
string
required

Human-readable title for the field.

string

Abbreviation for the field title.

string

Unit of measure for the field.

string

The field's test method.

string
enum
required

Type of field.

Allowed:
boolean
Defaults to false

Indicates if the field is required.

boolean

Whether the field is locked after receiving its first value.

boolean

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

string
enum

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

Allowed:
boolean

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

integer

Number of decimal places. Applies to numeric fields only.

number

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

integer

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

string

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

boolean

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

boolean

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

Responses

401

Unauthorized. The caller does not have permission to create sets.

Updated 11 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago