iotoms Docs

Update a quick pick configuration

PUT
/api/v1/quickpick/configurations/{id}

Replaces the name, pages and buttons of a quick pick configuration. Archived configurations cannot be modified.

How to use it

  1. Fetch the current layout with Get a quick pick configuration; archived configurations cannot be changed.
  2. Send the name and the complete set of pages and buttons; it replaces all existing pages. Every button's item code must exist.
  3. Scope assignments are kept. Call Publish a quick pick configuration to issue a new version.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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 PUT 'https://beta.iotoms.com/api/v1/quickpick/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -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      }    ]  }}