iotoms Docs

Get a quick pick configuration

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

Returns one quick pick button layout with all its pages (in page order), the buttons on each page (by row and column), its status and version, and every scope assignment that says where it applies.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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