iotoms Docs

Create a quick pick configuration

POST
/api/v1/quickpick/configurations

Creates a new quick pick button layout with a name and its pages of buttons. Buttons are validated on save. The configuration needs a scope assignment before it can be published.

How to use it

  1. Pick items for the buttons from List items.
  2. Send a name and at least one page, each with at least one button (item code, row and column). Unknown item codes reject the request.
  3. The configuration is created as DRAFT, version 1. Add where it applies with Assign a quick pick configuration to a scope, then publish it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
name*string

Name of the layout. Required.

pages*array<>

The full set of pages and buttons. Required, at least one page; it replaces all existing pages on update.

aiSessionId?|

Optional, at most 64 characters. Marks a new configuration as created by the AI assistant. Ignored on update.

Length0 <= length <= 64

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The quick pick configuration with its pages, buttons and scope assignments.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/quickpick/configurations' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "pages": [    {      "pageIndex": 0,      "buttons": [        {          "itemId": "string",          "positionRow": 0,          "positionCol": 0        }      ]    }  ]}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "status": "DRAFT",    "version": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pages": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "pageIndex": 0,        "title": "string",        "backgroundColor": "string",        "buttons": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "itemId": "string",            "buttonLabel": "string",            "buttonColor": "string",            "positionRow": 0,            "positionCol": 0,            "uiPayload": {              "property1": {},              "property2": {}            }          }        ]      }    ],    "scopes": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "scopeType": "REGISTER",        "scopeRefId": 0,        "effectiveFrom": "2019-08-24T14:15:22Z",        "effectiveTo": "2019-08-24T14:15:22Z",        "active": true      }    ]  }}