Get the status of an asynchronous display operation on the device's screen (UI related)

GET

/api/status/v5/display/{id}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Responses

🟢200OK

application/json

Status successfully retrieved

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠405405

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://192-168-1-1.xip.get.systems:9443/api/status/v5/display/12345678-abcd-4bcf-9bcd-123456789012' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - Example 1

{
    "data": {
        "statusDetails": "string",
        "jobId": "12345678-abcd-4bcf-9bcd-123456789012",
        "status": "Pending",
        "result": {
            "buttonPressedId": "my_button_id"
        },
        "createdAt": "2025-01-01T12:00:00.0000Z"
    }
}

Modified at 2025-02-13 14:31:55

Cancel an active job

Get the status of an asynchronous NFC tag interaction (NFC related)