Store permissions for an analysis set or selection list

post

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

Use this API operation to configure permissions for an analysis set or selection list.

Request formats

This operation accepts multipart/form-data and application/x-www-form-urlencoded. It has no JSON body parameter: with Content-Type: application/json the request body is ignored, so the request fails with 400 Missing parameter unless all parameters are passed in the query string.

Examples

multipart/form-data:

curl -X POST 'https://tenant.alisqi.com/api/storeSetPermissions' \
  -H 'Authorization: Bearer <token>' \
  -F setId=12 -F userGroupId=3 -F permissions=read,insert

application/x-www-form-urlencoded:

curl -X POST 'https://tenant.alisqi.com/api/storeSetPermissions' \
  -H 'Authorization: Bearer <token>' \
  -d setId=12 -d userGroupId=3 -d permissions=read,insert

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

setId

integer

required

The unique id of the analysis set or selection list.

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.

userGroupId

integer

required

The unique id of the user group.

permissions

string

required

Comma-separated list of permissions, as a string (e.g. read,insert).

Possible permissions: read, insert, complete, modify, delete and specification. For selection lists, only read and modify are applicable.

To revoke all permissions of the user group, send this parameter with an empty value (permissions=). Leaving the parameter out results in 400 Bad Request.

Headers

content-type

string

enum

Defaults to multipart/form-data

Generated from available request content types

Allowed:

Responses

`true` if the permissions have been stored.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns true if the permissions have been stored.

400Bad Request: a parameter is missing or invalid.

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

403Forbidden: the user associated with the token lacks the required permission, 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).

`true` if the permissions have been stored.