Create a new specification version

post https://{subdomain}.alisqi.com/api/storeSpecificationVersion

Use this API operation to create (a) new specification version(s) for an analysis sets.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

setId

integer

required

JSON object as a string.

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.

specs

string

required

JSON object as a string.

Specification objects.

Example:

{
  "ph_": {
	"min": 7,
	"innermin": 8,
	"goal": 9,
	"innermax": 10,
	"max": 11
  },
  "viscosity_": {
	"min": 500,
	"innermin": null,
	"goal": null,
	"innermax": null,
	"max": 1300
  }
}

Tip: Call the getSpecificationVersion endpoint to see the exact Specification data structure for this setId.

indexValue

string

The index field value. (Only applies to sets which have an index field.)

Store a new specification version for this index value.

Leave out to create a generic specification which applies to all index values.

startDateTime

string

Specify the starting date and time (formatted as yyyy-mm-dd hh:mm:ss or unix stimestamp).

Leave out to use the current date and time.

reason

string

The reason for changing the spec

This is used for documentation only.

Responses

200This operation will simply output true if the specification version has been stored.

304Not Modified

400Bad Request

403Forbidden

429Too many requests