Skip to main content
POST
/
api
/
item
/
screen
Returns the screen layout definition for adding or updating an item, including field definitions and workflow states.
curl --request POST \
  --url https://{tenant}.ekso.app/api/item/screen \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "containerId": "<string>",
  "processId": "<string>",
  "itemId": "<string>",
  "stage": 123,
  "source": "<string>"
}
'
{
  "item": {
    "entity": "<string>",
    "containerId": "<string>",
    "processId": "<string>",
    "sequence": 123,
    "boardId": "<string>",
    "cycleId": "<string>",
    "resourceType": 123,
    "resourceId": "<string>",
    "dateOpened": "2023-11-07T05:31:56Z",
    "dateWorking": "2023-11-07T05:31:56Z",
    "dateClosed": "2023-11-07T05:31:56Z",
    "time": [
      {
        "id": "<string>",
        "dated": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "timeTypeId": "<string>",
        "timeLogged": "<string>",
        "comment": "<string>",
        "status": 123
      }
    ],
    "field": [
      {
        "fieldId": "<string>",
        "data": "<string>"
      }
    ],
    "meta": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "clockStart": "2023-11-07T05:31:56Z",
    "clockFinish": "2023-11-07T05:31:56Z",
    "clockDelta": 123,
    "clockHours": 123,
    "clockStatus": 123,
    "dependencyKey": "<string>",
    "dependencyIndent": 123,
    "dependencyChild": 123,
    "tenantId": "<string>",
    "id": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updated": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "deleted": true
  },
  "stage": 123,
  "workflow": [
    {
      "id": "<string>",
      "value": "<string>",
      "image": "<string>",
      "metadata": "<string>",
      "active": true
    }
  ],
  "field": [
    {
      "definition": {
        "entity": "<string>",
        "fieldType": "<string>",
        "contentType": "<string>",
        "maximum": 123,
        "defaultValue": "<string>",
        "name": "<string>",
        "prompt": "<string>",
        "description": "<string>",
        "isCore": true,
        "isFeature": true,
        "featureName": "<string>",
        "placement": [
          123
        ],
        "usage": [
          123
        ],
        "listEditable": true,
        "tenantId": "<string>",
        "id": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "updated": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>",
        "deleted": true
      },
      "data": "<string>",
      "required": true
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

The screen request specifying container, process, item, and screen stage.

containerId
string
processId
string
itemId
string
stage
integer
source
string

Response

The screen layout model.

item
object
stage
integer
workflow
object[]
field
object[]