Wallboard API Documentation (1.11)
Download OpenAPI specification:Download
OpenAPI specification (OAS) for the Wallboard API.
Wallboard has hundreds of endpoints and documenting all of them takes time. If you have any question please contact our support and we'll extend the documentation on-demand, based on your needs.
In this document, you can find some useful information about the Wallboard API. The API mainly follows the REST approach with OAuth 2.0 authentication and authorization standards.
Wallboard have two types of end-points:
Public
- Callable by any client
- API root starts with
/public-api/
- No OAuth2 authorization
- Usually used with GUID based ID-s
Secured
- Only callable with OAuth2 authorization
- API root starts with
/api/
Notes
- The API only uses JSON format for data transfer objects.
- The update logic usually follows the “if an attribute is null, it’s ignored” logic.
- In the return value if a primitive attribute is not present it means NULL.
customerId
- tenant selector parameter
- Customer ID parameter is present on most our endpoints and it can be used to select a specific tenant in the system, which the operations should be performed on.
- This is used by ADMIN users (or network/subresellers OWNERS) as they have access to multiple tenants.
- Non-admin users don't have to fill this parameter, because they can only access their customer's resources.
- If as an ADMIN you want to get every resource in the system set this value to "-1".
page
,size
- pagination parameters
- Pagination is implemented by the default Spring pagination logic.
- Page index starts from
0
. - If you don’t set any additional parameter, the API gives back the first 20 elements.
- The maximum element count for a page is 1000.
sort
parameter
- Spring's default sort expression
- Directions:
asc
,desc
- Multiple parameters are supported -
sort=name,asc&sort=lastActivity,desc
- There is no escape logic, the parameter simply has to be URL encoded.
- Value selectors can be chained with a
.
to be able to access embedded or connected entities' attributes - Examples:
sort=name,asc
,sort=content.name,asc
search
- filtering parameter
With this parameter you can create dynamic queries to filter the resources.
select
- selecting fields
With this parameter you can specify which attributes or related entities should be present in the response.
Syntax (WBQL - Wallboard Query Language)
Search (WBCriteria)
Value operators
:
- meanscontains
in case of string literals andequals
in case of other value types- Example:
name:mydevice
- matches forprefix-mydevice-postfix
- Example:
=
- means exact match≠
- not equals- Unicode escape sequence:
\u2260
- Unicode escape sequence:
∉
- not contains- Works only with string literals
- Unicode escape sequence:
\u2209
^
- starts with- Works only with string literals
>
- greater than≥
- greater than or equal- Unicode escape sequence:
\2265
- Unicode escape sequence:
<
- less than≤
- less than or equal- Unicode escape sequence:
\2264
- Unicode escape sequence:
Logical operators
,
- AND- Example:
name=a,name=b
- Example:
|
- OR- Example:
name=something|name=something else
- Example:
- Logical groupings are currently not supported
Value matcher keywords
true
- Only can be used with
boolean
attributes - Example:
isValid:true
- Only can be used with
false
- Only can be used with
boolean
attributes
- Only can be used with
NULL
- value or connected entity is null- Example:
content=NULL
- Example:
!NULL
- value or connected entity is NOT null- Example:
folder.parent=!NULL
- Example:
Escaping
- All values has to be URL encoded
- The search parameter value must be URL encoded (most libraries encode request parameters by default)
- Format:
search=urlEncode({value_name}{value_operator}urlEncode({value}))
- Example:
search=name:mydevice:athome
(the second:
is part of the device's name) ->search=name%3Amydevice%253Aathome
Notes
- Date type attributes are supported and can be matched by UTC timestamps (milliseconds)
- Example:
startDate>1683616562
- means thestartDate
should be after2023-05-09T07:15:46+00:00
- Example:
- Value selectors can be chained with a
.
to be able to access embedded or connected entities' attributes- Example:
deviceGroup.parent.id=000c08d294df48efb1b0f5aa754d7ef9
- meaning: the device's group's parent group's id should be '000c08d294df48efb1b0f5aa754d7ef9'.
- Example:
Basic Examples
- User name contains the letter a:
name:a
- Device state is online and is in emergency state:
state:ONLINE,device.emergencyStatus:true
- A device content's name contains the substring "happy new year":
content.name:happy new year
Advanced Examples
- Coming soon
Select (WBSelect)
With the select
parameter you can also specify attributes that you want to select from a given entity.
This method allows you to run more optimal and faster queries.
You can use the select function to append attributes from other related entities to the query (if the relationship is one-to-one or many-to-one).
Syntax:
*
: Selects all primitive attributes of the entity- Equivalent to the missing
select
parameter - Calculated fields and related entities are NOT included
- Example:
select=*
- Equivalent to the missing
,
: Attributes should be separated with a,
- Example:
select=id,name,comment
- Example:
( )
: Used to select specific attributes from related entities- Example:
select=id,name,device(id,name)
- Example:
Advanced examples:
select=*,customer(id,name)
- Selects all primitive attributes from the device, plus the id and name of the customer it belongs to
select=*,totalUserLoginCount,lastDeviceActivity
- Select all the primitive attributes from the customer and the two specified calculated fields
Team management
includeReadOnlyInfo
parameter
- Most of the GET endpoints support the optional calculation of the
readOnly
-ness of a resource - An entity can be read-only for a user depending on the team settings
- If specifically not needed we suggest to turn if off, for faster response times
includeResourcesWithoutTeam
parameter
- Determines whether or not to include resources which are not assigned to any team
selectTeamIds
parameter
- A list of team ids that resources should be included in the response
- If empty, all team's resources are included
- Example:
select=teamAssignments.team.id=${teamid1}|teamAssignments.team.id=${teamid2}
Roles
All users have a role and all of the secured API requires a minimum role to use it. The role is always hierarchical, so a user with an OWNER role can use all endpoints that require an OWNER or lower roles. We use the following hierarchy:
Global:
ADMIN
- Super admin of the system.
- Can access anything and can do everything.
Tenant:
OWNER
- Tenant(customer) admin.
- Under it's own domain can access anything and can do everything.
- Can't belong to any team.
TECHNICIAN
- Can do everything except user and team management.
APPROVER
EDITOR
CONTRIBUTOR
VIEWER
Terminology
We are using a bit different terminology for entities like you used to in our GUI. The following expressions mean the same:
device
= screen = playercustomer
= client = tenantsubreseller
= network owner
Swagger - Deprecated
We have swagger set up at https://development.wallboard.info/swagger-ui.html, but it's not perfectly configured, there can be missing or misleading parameters. Also, the microservice's API is missing from there.
OAuth2 client credentials
By default, there are two built-in client credentials in the system, which you can use to get an access_token
.
Default client details:
client-id
: default-clientclient-secret
: 76211db5d8ea- Basic auth header value: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh
access_token
validity: 20 minutesrefresh_token
validity: 30 days
Short-lived client details:
client-id
: short-livedclient-secret
: mPSjfsJy8rs4m7y4- Basic auth header value: Basic c2hvcnQtbGl2ZWQ6bVBTamZzSnk4cnM0bTd5NA==
access_token
validity: 20 minutesrefresh_token
validity: 30 minutes
JWT
Certain new API endpoints use JWT token as authorization instead of the regular access_token
.
Get and refresh access token
To log in (get first access_token
) fill username
/password
and set grant_type
to "password".
To exchange a refresh_token
for a new access_token
fill refresh_token
parameter and set grant_type
to "refresh_token".
header Parameters
Authorization required | string <Basic clientId:clientSecret> Example: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh Uses basic authentication. The 'clientId:clientSecret' part must be base64 encoded. |
Request Body schema: x-www-form-urlencodedrequired
username | string <username@example.com> Email address of the user who wants to log in. |
password | string Password of the user who wants to log in. |
refresh_token | string Refresh token of the user who already logged in. |
grant_type | string Enum: "password" "refresh_token" On login use "password", on refresh use "refresh_token". |
Responses
Request samples
- CURL - Login
- CURL - Refresh token
curl -X POST \ https://example.com/oauth/token \ -H 'Authorization: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=password' \ --data-urlencode 'username=user@example.com' \ --data-urlencode 'password=MyPassword123'
Response samples
- 200
{- "access_token": "string",
- "token_type": "bearer",
- "expires_in": 0,
- "refresh_token": "string",
- "refresh_total_validity_seconds": 0,
- "jwt_access_token": "string",
- "customer_id": 0
}
Get Customers
This endpoint is used to retrieve customer data.
query Parameters
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/?page=0&size=10'
Response samples
- 200
- 400
{- "id": 0,
- "comment": "string",
- "country": "string",
- "expirationDate": "string",
- "freeLicenses": 0,
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "licenseType": "BASIC",
- "profile": "BASIC",
- "location": "string",
- "name": "string",
- "restricted": true,
- "type": "string",
- "contentDesignerEmail": "string",
- "supportEmail": "string",
- "createdDate": "string",
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [ ],
- "font": [ ]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": "string",
- "lastDeviceActivity": "string",
- "totalLicenses": 0,
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "owner": {
- "id": 0,
- "orderAutoApproveAllowed": true
}
}
Get Users
This endpoint is used to retrieve user data.
query Parameters
customerId | integer |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/user/??page=0&size=50&sort=lastActivity,desc&select=*,customer(*)'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "content": [
- {
- "address": "string",
- "authProvider": "LOCAL",
- "createdDate": 1683802510,
- "customer": {
- "id": 0,
- "name": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "email": "string",
- "hiddenUIElementRules": "string",
- "lastActivity": 1683802510,
- "lastLogin": 1683802510,
- "logins": 0,
- "name": "string",
- "presenceTime": 0,
- "profilePictureApiPath": "string",
- "restricted": true,
- "role": "DEVICE_USER",
- "ssoLoginEnabled": true,
- "termsOfServiceAcceptDate": 1683802510,
- "use2FA": true,
- "usernamePasswordLoginEnabled": true,
- "hasProfilePicture": true,
- "language": "string",
- "phoneNumber": "string",
- "comment": "string",
- "iconUrl": "string",
- "editorLevel": "BASIC",
- "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}
}
]
}
Get User interface profiles
This endpoint is used to retrieve user interface profile data.
query Parameters
customerId | integer |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/userInterfaceProfile?page=0&size=50&customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}
]
}
Get teams
This endpoint is used to retrieve team data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
includeTeamUserNumber | boolean Default: false |
includeTeamResourceNumber | boolean Default: false |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/?customerId=182&includeTeamUserNumber=false&includeTeamResourceNumber=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "teamUserNumber": 0,
- "teamDeviceNumber": 0,
- "teamDeviceGroupNumber": 0,
- "teamDeviceContentNumber": 0,
- "teamDatasourceNumber": 0,
- "teamContentGroupNumber": 0,
- "teamFileNumber": 0,
- "teamFileFolderNumber": 0,
- "teamMessageNumber": 0,
- "teamMessageGroupNumber": 0,
- "teamCampaignNumber": 0,
- "teamMicrosoftTenantNumber": 0,
- "teamGoogleCredentialNumber": 0,
- "teamAdvertiserNumber": 0,
- "teamNotificationChannelNumber": 0,
- "teamAlertRuleNumber": 0,
- "teamWebhookEventActionNumber": 0
}
]
}
Get team list
This endpoint is used to retrieve team data list.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
includeTeamUserNumber | boolean Default: false |
includeTeamResourceNumber | boolean Default: false |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/list?customerId=182&includeTeamUserNumber=false&includeTeamResourceNumber=false'
Response samples
- 200
{- "id": "string",
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "teamUserNumber": 0,
- "teamDeviceNumber": 0,
- "teamDeviceGroupNumber": 0,
- "teamDeviceContentNumber": 0,
- "teamDatasourceNumber": 0,
- "teamContentGroupNumber": 0,
- "teamFileNumber": 0,
- "teamFileFolderNumber": 0,
- "teamMessageNumber": 0,
- "teamMessageGroupNumber": 0,
- "teamCampaignNumber": 0,
- "teamMicrosoftTenantNumber": 0,
- "teamGoogleCredentialNumber": 0,
- "teamAdvertiserNumber": 0,
- "teamNotificationChannelNumber": 0,
- "teamAlertRuleNumber": 0,
- "teamWebhookEventActionNumber": 0
}
Register device
A device calls it every time it turned on or reconnects to the network
The deviceInfo
parameter should be a stringified JSON object
Example:
{
"other":{
"brand":"beta",
"debug":false,
"locked":false,
"lastStartTime":"2023-10-18T00:01:11.467Z",
"firmwareStatus":"UNKNOWN",
"webViewVersion":"Chrome/87"
},
"general":{
"model":"HD223",
"version":"4.1.510",
"hostname":"BrightSign-33E84S001174",
"platform":"BRIGHTSIGN",
"fwVersion":"9.0.105",
"osVersion":"7.0.21",
"versionCode":"JsCore",
"serialNumber":"33E84S001183",
"webResolution":"1440x900",
"nativeResolution":"1440x900"
},
"metrics":{
"cpu":{
"cores":1,
"threads":1,
"description":"ARMv7 Processor rev 3 (v7l)"
},
"screen":[
{
"used":true,
"scaling":1,
"resolution":"1440x900",
"displayName":""
}
],
"network":[
{
"ip":"192.168.1.53",
"mac":"90:ac:3f:10:13:99",
"name":"eth",
"type":"eth"
}
],
"storage":[
{
"type":"internal",
"mount":"/storage/sd",
"capacity":31914459136
}
],
"maxMemory":482344960
}
}
Request Body schema: application/jsonrequired
deviceId | string |
object (deviceInfo) | |
type | string (deviceType) Enum: "TABLET" "PHONE" "SCREEN" "DESKTOP" |
platform | string (platform) Enum: "ANDROID" "WINDOWS" "BRIGHTSIGN" "SAMSUNG" "LG" "PWA" "UNKNOWN" |
object (supportedFeatures) | |
fillContentDetails | boolean Default: true optional |
Responses
Request samples
- Payload
{- "deviceId": "string",
- "deviceInfo": {
- "other": {
- "brand": "string",
- "debug": true,
- "locked": true,
- "rooted": true,
- "gpuInfo": "string",
- "updatable": true,
- "rootGranted": true,
- "giadaDeviceId": "string",
- "lastStartTime": 0,
- "webViewVersion": "string"
}, - "general": {
- "model": "string",
- "version": "string",
- "platform": "string",
- "fwVersion": "string",
- "osVersion": "string",
- "webResolution": "string",
- "nativeResolution": "string"
}, - "metrics": {
- "cpu": {
- "cores": 0,
- "threads": 0,
- "description": "string"
}, - "network": [
- {
- "ip": "string",
- "mac": "string",
- "name": "string",
- "type": "string"
}
], - "storage": [
- {
- "type": "string",
- "mount": "string",
- "capacity": 0
}
], - "maxMemory": 0
}
}, - "type": "TABLET",
- "platform": "ANDROID",
- "supportedFeatures": {
- "featureList": [
- {
- "type": "WORKING_HOURS"
}
]
}, - "fillContentDetails": true
}
Response samples
- 200
{- "content": "string",
- "deviceName": "string",
- "showName": true,
- "showConsole": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "dataRowId": "string",
- "datasourceId": "string",
- "emergencyState": true,
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "rebootTime": "string",
- "timeStamp": 0,
- "licenseType": "BASIC",
- "weatherLocation": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "displayStatus": "ON",
- "locked": true,
- "timeZone": "string",
- "syncPeriodMillis": 0,
- "rotation": {
- "angle": 0,
- "type": "WEB_VIEW"
}, - "tags": [
- "string"
], - "advancedConfiguration": { },
- "updateRule": { },
- "workingHours": {
- "days": {
- "MON": {
- "from": "string",
- "to": "string"
}, - "TUE": {
- "from": "string",
- "to": "string"
}, - "WED": {
- "from": "string",
- "to": "string"
}, - "THU": {
- "from": "string",
- "to": "string"
}, - "FRI": {
- "from": "string",
- "to": "string"
}, - "SAT": {
- "from": "string",
- "to": "string"
}, - "SUN": {
- "from": "string",
- "to": "string"
}
}, - "mode": "DEVICE"
}, - "connectionSettings": { },
- "statisticsSettings": { },
- "resourcesToCache": {
- "reloadContentIfChangedResources": [
- {
- "absolutePath": "string",
- "resourceHandlingPolicy": "RELOAD_CONTENT_IF_CHANGED",
- "resourceType": "DISPLAYER_FILE",
- "version": "V1"
}
], - "alwaysRecheckResources": [
- {
- "absolutePath": "string",
- "resourceHandlingPolicy": "RELOAD_CONTENT_IF_CHANGED",
- "resourceType": "DISPLAYER_FILE",
- "version": "V1"
}
], - "cacheOnceResources": [
- {
- "absolutePath": "string",
- "resourceHandlingPolicy": "RELOAD_CONTENT_IF_CHANGED",
- "resourceType": "DISPLAYER_FILE",
- "version": "V1"
}
], - "rotateRules": [
- {
- "urlPattern": "string",
- "strategy": "LRU",
- "threshold": "ALWAYS"
}
]
}
}
Get devices with basic attributes
Minimum role: VIEWER
Useful for listing or if quick response time is required and you only need the id
and name
.
Authorizations:
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
includeResourcesWithoutTeam | boolean (includeResourcesWithoutTeam) Default: true |
selectTeamIds | Array of strings (selectTeamIds) Example: selectTeamIds={team_id_1},{team_id_2}
|
Responses
Request samples
- CURL
curl -X GET "https://example.com/api/device/simplePaged?customerId=123&page=0&size=20&sort=name,asc" \ -H "Authorization: Bearer <your_access_token>" \ -H "Content-Type: application/json"
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "content": [
- {
- "id": "string",
- "name": "string",
- "deviceGroupId": "string",
- "readOnly": true
}
]
}
Assign device to customer
Minimum role: TECHNICIAN
Authorizations:
query Parameters
customerId | integer |
Request Body schema: application/jsonrequired
customerId | string |
activationCode | string |
serial | string |
deviceName | string |
deviceGroupId | string |
contentId | string |
emergencyContentId | string |
licenseOrderId | integer |
showName | boolean Default: false |
showConsole | boolean Default: false |
weatherLocation | string |
timeZone | string |
object (rotation) | |
tags | Array of strings <= 10 items |
emergencyStatus | boolean Default: false |
updateVersionUpperLimit | string |
rebootTime | string |
volumeLevel | integer |
brightnessLevel | integer |
advancedConfiguration | object |
updateRule | object |
datasourceId | string |
daraRowId | string |
sensorConfig | string |
migrateFromDeviceId | string |
deleteMigratedDevice | boolean Default: false |
object |
Responses
Request samples
- Payload
- CURL
{- "customerId": "string",
- "activationCode": "string",
- "serial": "string",
- "deviceName": "string",
- "deviceGroupId": "string",
- "contentId": "string",
- "emergencyContentId": "string",
- "licenseOrderId": 0,
- "showName": false,
- "showConsole": false,
- "weatherLocation": "string",
- "timeZone": "string",
- "rotation": {
- "angle": 0,
- "type": "WEB_VIEW"
}, - "tags": [
- "string"
], - "emergencyStatus": false,
- "updateVersionUpperLimit": "string",
- "rebootTime": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "advancedConfiguration": { },
- "updateRule": { },
- "datasourceId": "string",
- "daraRowId": "string",
- "sensorConfig": "string",
- "migrateFromDeviceId": "string",
- "deleteMigratedDevice": false,
- "resourceCreationTeamAssignParams": {
- "resourceTeamAssigns": [ ]
}
}
Set advanced configuration
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Request Body schema: application/jsonrequired
advancedConfiguration | object |
Responses
Request samples
- Payload
- CURL
{- "advancedConfiguration": { }
}
Set update rule
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Request Body schema: application/jsonrequired
updateRule | object |
Responses
Request samples
- Payload
- CURL
{- "updateRule": { }
}
Set data row
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
dataRowId required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/dataRowId?customerId=182&applyOn=DEVICE&dataRowId=row1&search=id=f229806904154d8abe67f42629d0c1bb'
Delete data row
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X DELETE \ '{{server_root}}/api/v2/device/dataRowId?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Set datasource
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
datasourceId | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/datasource?applyOn=DEVICE&customerId=182&search=id=f229806904154d8abe67f42629d0c1bb&datasourceId=6edd67f7597645de8ed0f0a1dceaed30'
Delete datasource
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X DELETE \ '{{server_root}}/api/v2/device/datasource?applyOn=DEVICE&customerId=182&search=id=f229806904154d8abe67f42629d0c1bb'
Set rotation
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
angle required | integer |
type required | string Default: "WEB_VIEW" Enum: "WEB_VIEW" "DEVICE" |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/rotation?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&angle=90&type=WEB_VIEW'
Set brightness
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
level required | integer |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/brightness?customerId=182&applyOn=DEVICE&level=10&search=id=f229806904154d8abe67f42629d0c1bb'
Set volume
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
level required | integer |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/volume?customerId=182&applyOn=DEVICE&level=10&search=id=f229806904154d8abe67f42629d0c1bb'
Set time
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
timeZone required | string <Europe/Budapest> |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/time?customerId=182&applyOn=DEVICE&timeZone=Europe%2FBudapest&search=id=f229806904154d8abe67f42629d0c1bb'
Set weather location
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
weatherLocation required | string <New York, NY> |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/setWeatherLocation?customerId=182&applyOn=DEVICE&weatherLocation=New%20York%2C%20NY&search=id=f229806904154d8abe67f42629d0c1bb'
Set working hours
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Request Body schema: application/jsonrequired
object | |
mode | string Value: "DEVICE" |
Responses
Request samples
- Payload
- CURL
{- "days": {
- "MON": {
- "from": "string",
- "to": "string"
}, - "TUE": {
- "from": "string",
- "to": "string"
}, - "WED": {
- "from": "string",
- "to": "string"
}, - "THU": {
- "from": "string",
- "to": "string"
}, - "FRI": {
- "from": "string",
- "to": "string"
}, - "SAT": {
- "from": "string",
- "to": "string"
}, - "SUN": {
- "from": "string",
- "to": "string"
}
}, - "mode": "DEVICE"
}
Set reboot time
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
time required | string <02:00:00> |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/rebootTime?applyOn=DEVICE&customerId=182&time=2:0:00&search=id=f229806904154d8abe67f42629d0c1bb'
Delete reboot time
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/rebootTime?applyOn=DEVICE&customerId=182&search=id=f229806904154d8abe67f42629d0c1bb'
Set update version upper limit
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
version required | string <1.2.3.4> 0 means never update. |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/setUpdateVersionUpperLimit?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&version=4.0.8'
Set sensor config
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Request Body schema: application/jsonrequired
sensorConfig | object |
Responses
Request samples
- Payload
- CURL
{- "sensorConfig": { }
}
Reset sensor
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/resetSensor?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Turn on and off display
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
enabled required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/display?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&enabled=true'
Turn on and off emergency
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
emergencyStatus required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/emergency?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&emergencyStatus=true'
Turn on and off lock
path Parameters
locked required | boolean |
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/lockDown/true?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Show console
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
enabled required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showConsole?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&enabled=true'
Show device info
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
enabled required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showDeviceInfo?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&enabled=true'
Show name
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
enabled required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showName?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&enabled=true'
Show state indicator
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
enabled required | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showStateIndicator?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&enabled=true'
Set toast message
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
message required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showToastMessage?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&message=Welcome'
Send command
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
command required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/showToastMessage?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&command=testCommand'
Update device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/update?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Restart device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/restart?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Snooze device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/snooze?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Wake up device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/wakeUp?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Start recovery
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/startRecovery?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Start settings
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/startSettings?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Load page
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
url required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/loadPage?customerId=182&applyOn=DEVICE&url=https%3A%2F%2Fwallboard.info%2F&search=id=f229806904154d8abe67f42629d0c1bb'
Request log
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
logcat required | boolean Default: false |
bugreport required | boolean Default: false |
systemLog required | boolean Default: false |
systemReport required | boolean Default: false |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/requestLog?customerId=182&applyOn=DEVICE&logcat=false&bugreport=false&systemLog=false&systemReport=false&search=id=f229806904154d8abe67f42629d0c1bb'
Install application
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
url required | integer |
Request Body schema: application/jsonrequired
params | object |
Responses
Request samples
- Payload
- CURL
{- "params": { }
}
Take high resolution preview
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/takeHighResPreview?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Turn on rapid preview mode
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
duration required | integer |
minimumDelayBetweenPreviews required | integer |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/turnOnRapidPreviewMode?customerId=182&applyOn=DEVICE&duration=5&minimumDelayBetweenPreviews=5&search=id=f229806904154d8abe67f42629d0c1bb'
Set preview content
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
contentId required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/previewContent?customerId=182&applyOn=DEVICE&contentId=bbc27d811cfe44d18eae17bb2734122e&search=id=f229806904154d8abe67f42629d0c1bb'
Set preview template
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
templateId required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/previewContent?customerId=182&applyOn=DEVICE&templateId=bbc27d811cfe44d18eae17bb2734122e&search=id=f229806904154d8abe67f42629d0c1bb'
Upload preview image
Upload a preview image for a device. This api always response with status OK.
query Parameters
deviceId required | string ID of the device |
highRes | boolean Default: false Indicates whether the image is high resolution or not |
header Parameters
Content-Type required | string <multipart/form-data; boundary={boundary}> Example: multipart/form-data; boundary=q1w2e3r4t5y6u7i8o9 |
Request Body schema: multipart/form-data
image | any <binary> |
Responses
Request samples
- Payload
- CURL
--q1w2e3r4t5y6u7i8o9 Content-Disposition: form-data; name=image; filename="image.jpg" Content-Type: image/jpg {..binary_data_of_picture..}
Assign content to device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
contentId required | string |
nextContentId | string |
nextContentStartDate | integer |
asAssigned required | boolean Default: true |
asEmergency required | boolean Default: false |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/assignContent?customerId=182&applyOn=DEVICE&contentId=bbc27d811cfe44d18eae17bb2734122e&asAssigned=true&asEmergency=false&search=id=f229806904154d8abe67f42629d0c1bb'
Refresh content
Minimum role: APPROVER
Authorizations:
query Parameters
customerId | integer (customerId) |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
Responses
Request samples
- CURL
curl -X POST \ https://example.com/api/v2/device/refreshContent?customerId=123&search=id%3A000c08d294df48efb1b0f5aa754d7ef9&applyOn=DEVICE \ -H 'Authorization: Bearer <token>' \ -H 'Content-Type: application/json'
Cache content
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
contentId required | string |
cacheAt | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/cacheContent?customerId=182&applyOn=DEVICE&contentId=bbc27d811cfe44d18eae17bb2734122e&search=id=f229806904154d8abe67f42629d0c1bb'
Cache content files
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
cacheAt | string |
Request Body schema: application/jsonrequired
urls | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "urls": [
- "string"
]
}
Clear cache
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
contentId required | string |
limit | integer |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/clearCache?customerId=182&applyOn=DEVICE&limit=10&search=id=f229806904154d8abe67f42629d0c1bb'
Detach content from device
query Parameters
customerId required | integer |
search | string (search)
|
applyOn required | string (applyOn) Enum: "DEVICE" "DEVICEGROUP" "ALL" Defines what |
detachNext | boolean Default: true |
detachAssigned | boolean Default: true |
detachEmergency | boolean Default: false |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/detachContent?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb&detachNext=true&detachAssigned=true&detachEmergency=false'
Set location image
query Parameters
deviceId required | integer |
header Parameters
Content-Type required | string <multipart/form-data> |
Request Body schema: multipart/form-data
files | Array of strings <binary> [ items <binary > ] |
previews | Array of strings <binary> [ items <binary > ] |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/v2/device/534/locationImage'
Response samples
- 200
{- "content": [
- {
- "name": "string",
- "apiPath": "string"
}
]
}
Get location image
This endpoint is used to retrieve device location image data.
path Parameters
deviceId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/device/534/locationImage'
Response samples
- 200
{- "content": [
- {
- "name": "string",
- "apiPath": "string"
}
]
}
Get summary of devices
This endpoint is used to retrieve summary of devices.
query Parameters
customerId | integer |
deviceGroupSearch | string |
deviceSearch | string |
quickFilterId | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/device/view/summary'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "comment": "string",
- "location": "string",
- "readOnly": true,
- "entityType": "DEVICE_GROUP"
}, - {
- "id": "string",
- "name": "string",
- "emergencyStatus": true,
- "customerId": 0,
- "deviceStatus": "ONLINE",
- "lastActivity": 1683802510,
- "version": "string",
- "webViewVersion": "string",
- "platform": "ANDROID",
- "licenseType": "BASIC",
- "nativeResolutionWidth": 0,
- "nativeResolutionHeight": 0,
- "webResolutionWidth": 0,
- "webResolutionHeight": 0,
- "isOutDated": true,
- "previewPath": "string",
- "readOnly": true,
- "entityType": "DEVICE",
- "address": "string",
- "contentId": "string",
- "contentType": "string",
- "location": "string",
- "emergencyContentId": "string",
- "emergencyContentType": "string",
- "nextContentId": "string",
- "lastDeviceStatusChange": 1683802510,
- "customerExpirationDate": 1683802510,
- "deviceInfo": {
- "other": {
- "brand": "string",
- "debug": true,
- "locked": true,
- "rooted": true,
- "gpuInfo": "string",
- "updatable": true,
- "rootGranted": true,
- "giadaDeviceId": "string",
- "lastStartTime": 0,
- "webViewVersion": "string"
}, - "general": {
- "model": "string",
- "version": "string",
- "platform": "string",
- "fwVersion": "string",
- "osVersion": "string",
- "webResolution": "string",
- "nativeResolution": "string"
}, - "metrics": {
- "cpu": {
- "cores": 0,
- "threads": 0,
- "description": "string"
}, - "network": [
- {
- "ip": "string",
- "mac": "string",
- "name": "string",
- "type": "string"
}
], - "storage": [
- {
- "type": "string",
- "mount": "string",
- "capacity": 0
}
], - "maxMemory": 0
}
}, - "dataRowId": "string",
- "datasourceId": "string",
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "rebootTime": "string",
- "weatherLocation": "string",
- "customerSlaveId": "string",
- "longitude": 0,
- "latitude": 0
}
]
}
Get devices
This endpoint is used to retrieve device data.
query Parameters
customerId | integer |
includeReadOnlyInfo | boolean Default: false |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/device?customerId=123&page=0&size=20&sort=name&includeReadOnlyInfo=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "content": [
- {
- "address": "string",
- "id": "string",
- "assignDate": 0,
- "deviceInfo": {
- "other": {
- "brand": "string",
- "debug": true,
- "locked": true,
- "rooted": true,
- "gpuInfo": "string",
- "updatable": true,
- "rootGranted": true,
- "giadaDeviceId": "string",
- "lastStartTime": 0,
- "webViewVersion": "string"
}, - "general": {
- "model": "string",
- "version": "string",
- "platform": "string",
- "fwVersion": "string",
- "osVersion": "string",
- "webResolution": "string",
- "nativeResolution": "string"
}, - "metrics": {
- "cpu": {
- "cores": 0,
- "threads": 0,
- "description": "string"
}, - "network": [
- {
- "ip": "string",
- "mac": "string",
- "name": "string",
- "type": "string"
}
], - "storage": [
- {
- "type": "string",
- "mount": "string",
- "capacity": 0
}
], - "maxMemory": 0
}
}, - "deviceStatus": "ONLINE",
- "emergencyStatus": true,
- "enabledConsole": true,
- "enabledName": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "installDate": 0,
- "lastActivity": 1683802510,
- "licenseType": "BASIC",
- "name": "string",
- "dataRowId": "string",
- "sensorConfig": "string",
- "tags": [
- "string"
], - "type": "TABLET",
- "platform": "ANDROID",
- "upTime": 0,
- "rebootTime": "string",
- "version": "string",
- "firmwareVersion": "string",
- "networkInterfaceType": "string",
- "osVersion": "string",
- "webViewVersion": "string",
- "nativeResolutionWidth": 0,
- "nativeResolutionHeight": 0,
- "webResolutionWidth": 0,
- "webResolutionHeight": 0,
- "macAddress": "string",
- "localIpAddress": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "rotation": {
- "angle": 0,
- "type": "WEB_VIEW"
}, - "workingHours": {
- "days": {
- "MON": {
- "from": "string",
- "to": "string"
}, - "TUE": {
- "from": "string",
- "to": "string"
}, - "WED": {
- "from": "string",
- "to": "string"
}, - "THU": {
- "from": "string",
- "to": "string"
}, - "FRI": {
- "from": "string",
- "to": "string"
}, - "SAT": {
- "from": "string",
- "to": "string"
}, - "SUN": {
- "from": "string",
- "to": "string"
}
}, - "mode": "DEVICE"
}, - "supportedFeatures": {
- "featureList": [
- {
- "type": "WORKING_HOURS"
}
]
}, - "customerId": 0,
- "deviceGroupId": "string",
- "deviceGroupPath": "string",
- "preview": "string",
- "contentId": "string",
- "contentType": "string",
- "location": "string",
- "emergencyContentId": "string",
- "emergencyContentType": "string",
- "nextContentId": "string",
- "lastDeviceStatusChange": 1683802510,
- "customerExpirationDate": 1683802510,
- "datasourceId": "string",
- "updateVersionUpperLimit": "string",
- "weatherLocation": "string",
- "customerSlaveId": "string",
- "longitude": 0,
- "latitude": 0
}
]
}
Get device preview
This endpoint is used to retrieve device preview image data.
path Parameters
deviceId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/device/534/previewStore'
Response samples
- 200
{- "content": [
- {
- "name": "string",
- "apiPath": "string",
- "lastModified": 1683802510
}
]
}
Get device contents
This endpoint is used to retrieve device content data.
query Parameters
customerId | integer |
includeLoops | boolean Default: true |
includeContents | boolean Default: true |
includeSchedules | boolean Default: true |
shuffleDeviceContents | boolean Default: true |
includeReadOnlyInfo | boolean Default: false |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/deviceContent?customerId=182&includeLoops=true&includeContents=true&includeSchedules=true&shuffleDeviceContents=true&includeReadOnlyInfo=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "customerId": 0,
- "contentGroupId": "string",
- "tags": "string",
- "contentGroupPath": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": null,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "iconUrl": "string"
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "contentGroup": {
- "id": "string",
- "name": "string"
}, - "assignedDeviceCount": 0,
- "assignedAsNextDeviceCount": 0,
- "assignedAsEmergencyDeviceCount": 0,
- "previewPath": "string",
- "readOnly": true,
- "deviceContentType": "simpleLoop",
- "shortUrl": "string",
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}
}
]
}
Upload file
Minimum role: EDITOR
RFC 1867 compliant multipart/form-data stream (https://www.ietf.org/rfc/rfc1867.txt)
For pictures the thumbnails are created automatically by the server, but video files require and explicitly uploaded preview.
Authorizations:
query Parameters
customerId | integer (customerId) |
teamIds | string <{teamId},{readOnly},{teamId},{readOnly}...
> (teamIds) Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9,true,00a22e86602c4a88914614aa9516a481,false |
parentId | string Folder ID where the file will be uploaded. If empty, the file will be uploaded into the root folder. |
validFrom | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) Example: validFrom=1683802510 File validity start time. |
validTo | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) Example: validTo=1683802510 File validity end time. |
header Parameters
Content-Type required | string <multipart/form-data; boundary={boundary}> Example: multipart/form-data; boundary=q1w2e3r4t5y6u7i8o9 |
Request Body schema: multipart/form-data
files | Array of strings <binary> [ items <binary > ] |
previews | Array of strings <binary> [ items <binary > ] |
Responses
Request samples
- Payload
- CURL
--q1w2e3r4t5y6u7i8o9 Content-Disposition: form-data; name=files; filename="my_picture.png" Content-Type: image/png {..binary_data_of_picture..} --q1w2e3r4t5y6u7i8o9 Content-Disposition: form-data; name=previews; filename="my_video_preview.preview" Content-Type: video/mp4 {..binary_data_of_video_preview..} --q1w2e3r4t5y6u7i8o9--
Response samples
- 200
[- {
- "id": "string",
- "name": "string",
- "contentType": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "createDate": 1683802510,
- "tags": [
- "string"
], - "creatorEmail": "string",
- "crcCheckSum": "string",
- "fileFolderId": "string",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "location": "string"
}
]
Get files
This endpoint is used to retrieve file data.
query Parameters
customerId | integer |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/file?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": "string",
- "name": "string",
- "contentType": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "createDate": 1683802510,
- "creatorEmail": "string",
- "fileFolderPath": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolderId": "string",
- "fileMutabilityType": "STATIC",
- "location": "string"
}
]
}
Get files from folder
This endpoint is used to retrieve file data from file folder.
query Parameters
customerId required | integer |
folderId required | string |
contentTypes | Array of strings |
recursively | boolean Default: true |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/file/getFilesFromFolder?customerId=182&contentTypes=image%2F&folderId=58&recursively=true'
Response samples
- 200
[- {
- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "customerId": 0,
- "location": "string"
}
]
Get filtered file folders
This endpoint is used to retrieve filtered file folder data.
query Parameters
customerId | integer |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/quickFilter/?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": "string",
- "name": "string",
- "filteredEntityType": "FILE",
- "criteria": {
- "type": "FILE",
- "search": "string",
- "searchRecursively": true,
- "name": "string",
- "tags": [
- "string"
], - "validFileOnly": true,
- "undefinedValidityValid": true
}, - "customerId": 0
}
]
}
Update campaign team assignment
query Parameters
customerId | integer (customerId) |
campaignId required | integer |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "readOnly": true,
- "teamId": "string"
}
], - "removeFromTeamIds": [
- "string"
]
}
Create campaign
query Parameters
customerId | integer (customerId) |
teamIds | string <{teamId},{readOnly},{teamId},{readOnly}...
> (teamIds) Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9,true,00a22e86602c4a88914614aa9516a481,false |
Request Body schema: application/jsonrequired
name | string |
validFrom | string <2024-03-19> |
validTo | string <2024-03-20> |
weight | integer This is the priority of the campaign. Priority increases as the number decreases. |
contentShuffleMode | string (contentShuffleMode) Enum: "BALANCED" "SERIAL" |
saturation | integer Campaigns with higher saturation will be played proportionally more. |
skipDefaultPage | boolean Default: false |
skipInvalidFiles | boolean Default: false |
enabled | boolean Default: true |
object (affectedHours) | |
object (affectedDays) | |
object (affectedDates) | |
object (tagCondition) | |
object (tagCondition) | |
object (tagCondition) | |
type | string (campaignType) Enum: "CONTENT" "CONTENT_BY_TAG" "MESSAGE_GROUP" "ASSETS_STATIC" "ASSETS_DYNAMIC" |
object (teamAccessList) | |
object (teamAccessList) | |
playMultipleItemsInSinglePlaybackSlot | boolean Default: false |
playAllItemsInSinglePlaybackSlot | boolean Default: true |
playbackSlotDuration | integer |
playbackSlotNumberOfElementsToPlay | integer |
tags | Array of strings |
readOnly | boolean (readOnly) If |
duration | integer |
defaultDuration | integer Default duration for media items without length (images). |
orderingMode | string (orderingMode) Enum: "RANDOM" "ALPHABET" "DEFAULT" |
advertiserId | string |
Array of objects | |
Array of objects | |
Array of objects | |
Array of objects | |
Array of objects |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "duration": 0,
- "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "campaignDeviceGroupAssignments": [
- {
- "deviceGroupId": "string"
}
], - "campaignContentAssignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "campaignMessageGroupAssignments": [
- {
- "messageGroupId": "string"
}
], - "campaignFileAssignments": [
- {
- "fileId": "string",
- "weight": 0
}
], - "campaignFileFolderAssignments": [
- {
- "fileFolderId": "string"
}
]
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "customerId": 0,
- "creatorEmail": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "duration": 0,
- "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "affectedScreenCount": 0
}
Get campaigns
This endpoint is used to retrieve campaign data.
query Parameters
customerId | integer |
includeAffectedScreenCount | boolean Default: false |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/campaign?customerId=182&includeAffectedScreenCount=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": [
- {
- "direction": "string",
- "property": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "ascending": true,
- "descending": true
}
], - "content": [
- {
- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "customerId": 0,
- "creatorEmail": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "duration": 0,
- "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "affectedScreenCount": 0
}
]
}
Get campaigns with basic attributes (simple)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/campaign/simple?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get campaigns with basic attributes (simplePaged)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer (customerId) |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/campaign/simplePaged?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get campaign player devices
This endpoint is used to retrieve the data of the devices, on which the campaign is being played.
query Parameters
campaignId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/campaign/playerDevices?campaignId=653'
Response samples
- 200
[- {
- "id": "string",
- "name": "string"
}
]
Get campaign
This endpoint is used to retrieve campaign data by campaignId.
path Parameters
campaignId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/campaign/653'
Response samples
- 200
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "customerId": 0,
- "creatorEmail": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "duration": 0,
- "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "campaignDeviceGroupAssignments": [
- {
- "deviceGroupId": "string"
}
], - "campaignContentAssignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "campaignMessageGroupAssignments": [
- {
- "messageGroupId": "string"
}
], - "campaignFileAssignments": [
- {
- "fileId": "string",
- "weight": 0
}
], - "campaignFileFolderAssignments": [
- {
- "fileFolderId": "string"
}
]
}
Update campaign
path Parameters
campaignId required | integer |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
- CURL
{ }
Response samples
- 200
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "customerId": 0,
- "creatorEmail": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "duration": 0,
- "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "campaignDeviceGroupAssignments": [
- {
- "deviceGroupId": "string"
}
], - "campaignContentAssignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "campaignMessageGroupAssignments": [
- {
- "messageGroupId": "string"
}
], - "campaignFileAssignments": [
- {
- "fileId": "string",
- "weight": 0
}
], - "campaignFileFolderAssignments": [
- {
- "fileFolderId": "string"
}
]
}
Get messages
This endpoint is used to retrieve message data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
includeDeviceGroupName | boolean Default: false |
includeContentName | boolean Default: false |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/message?customerId=182&includeDeviceGroupName=false&includeContentName=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "text": "string",
- "type": "CONTENT",
- "skipDefaultPage": true,
- "enabled": true,
- "contentId": "string",
- "simpleLoopId": "string",
- "affectedHours": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "messageGroupId": 0,
- "name": "string",
- "deviceGroupId": "string",
- "customerId": 0,
- "creatorEmail": "string",
- "createDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workingTime": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}
}
]
}, - "advertiserId": "string",
- "deviceGroupName": "string",
- "contentName": "string"
}
]
}
Update message
path Parameters
messageId required | integer |
Request Body schema: application/jsonrequired
validFrom | string |
validTo | string |
weight | integer |
text | string |
skipDefaultPage | boolean |
enabled | boolean |
contentId | string |
simpleLoopId | string |
object | |
object (affectedDays) | |
messageGroupId | integer |
name | string |
deviceGroupId | string |
object | |
saturation | integer |
tags | Array of strings |
defaultDuration | integer |
orderingMode | string Enum: "RANDOM" "ALPHABET" "DEFAULT" |
object | |
advertiserId | string |
deviceGroupName | string |
contentName | string |
Responses
Request samples
- Payload
- CURL
{- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "text": "string",
- "skipDefaultPage": true,
- "enabled": true,
- "contentId": "string",
- "simpleLoopId": "string",
- "affectedHours": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "messageGroupId": 0,
- "name": "string",
- "deviceGroupId": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workingTime": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}
}
]
}, - "advertiserId": "string",
- "deviceGroupName": "string",
- "contentName": "string"
}
Response samples
- 200
{- "id": 0,
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "text": "string",
- "type": "CONTENT",
- "skipDefaultPage": true,
- "enabled": true,
- "contentId": "string",
- "simpleLoopId": "string",
- "affectedHours": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "affectedDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "messageGroupId": 0,
- "name": "string",
- "deviceGroupId": "string",
- "customerId": 0,
- "creatorEmail": "string",
- "createDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDates": {
- "intervals": [
- {
- "from": "string",
- "to": "string",
- "workingTime": {
- "from": "string",
- "end": "string",
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}
}
]
}, - "advertiserId": "string",
- "deviceGroupName": "string",
- "contentName": "string"
}
Get datasource
This endpoint is used to retrieve datasource data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/datasource/?customerId=182'
Response samples
- 200
{- "object": {
- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "content": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "customerId": 0,
- "global": true,
- "remoteUrl": "string",
- "refreshFrequency": 0,
- "cronExpressionParameters": {
- "cronExpression": "string",
- "timeZone": "string"
}, - "data": "string",
- "hash": "string",
- "customer": {
- "id": 0,
- "comment": "string",
- "country": "string",
- "expirationDate": 1683802510,
- "freeLicenses": 0,
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "licenseType": "BASIC",
- "profile": "BASIC",
- "location": "string",
- "name": "string",
- "restricted": true,
- "type": "string",
- "contentDesignerEmail": "string",
- "supportEmail": "string",
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "name": "string",
- "colorCode": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}
}, - "cacheResources": true,
- "removeUrlIfCacheFailed": true,
- "rotateCacheOnEveryUpdate": true,
- "exchangeInternalResourceReferences": true,
- "downloadResourceOnEveryUpdate": true,
- "editableByDisplay": true,
- "lastAccessed": 1683802510,
- "lastError": 1683802510,
- "lastModified": 1683802510,
- "lastUpdated": 1683802510,
- "lastChanged": 1683802510,
- "errorCounter": 0,
- "ignoreErrorCounter": true,
- "nextRefreshTime": 1683802510,
- "type": "XML",
- "sourceType": "EXTERNAL",
- "structureType": "CUSTOM",
- "deactivated": true,
- "dateFormat": "string",
- "timeFormat": "string",
- "timeZone": "string",
- "generateCalendarForDays": 0,
- "firstDayOfWeek": "Monday",
- "credentialId": "string",
- "credentialType": "GOOGLE",
- "microsoftCalendarDatasourceType": "USER_CALENDAR",
- "calendarId": "string",
- "microsoftUserPrincipalIdOrName": "string",
- "sharepointGroupId": "string",
- "flowId": "string",
- "spreadSheetLegacyFormat": true,
- "spreadSheetId": "string",
- "sheetId": "string",
- "sheetRange": "string",
- "driveFolderId": "string",
- "firstRowIsHeader": true,
- "jdbcUserName": "string",
- "jdbcPassword": "string",
- "jdbcQuery": "string",
- "standardTableFormat": true,
- "keepLastXDays": 0,
- "keepLastXItem": 0,
- "liveDataId": 0,
- "siteId": "string",
- "listId": "string",
- "sharepointHeaders": {
- "headers": [
- "string"
]
}, - "capParameters": {
- "capFeedUrl": "string",
- "parserRule": {
- "capItemURLSelector": "string"
}, - "cacheRule": {
- "capFeedUpdatedSelector": "string",
- "capItemLastModifiedSelector": "string"
}, - "deviceIdentificationRule": {
- "tagBasedRule": {
- "deviceTagSelector": "ADDRESSES"
}, - "deviceTagSeparator": "string",
- "deviceTagOperator": "AND"
}, - "emergencyStatusAutoUpdaterRule": {
- "includeDevicesByTag": "string"
}
}, - "microsoftWorkBookParameters": {
- "workBookId": "string",
- "workSheetId": "string",
- "driveId": "string",
- "range": "string",
- "fetchCharts": true,
- "firstRowIsHeader": true
}, - "fileFromUrlParameters": {
- "urls": {
- "url": "string"
}
}, - "toastParameters": {
- "externalGroupRef": "string",
- "externalRestaurantRef": "string",
- "menusLastUpdated": "string",
- "method": "MENU"
}, - "toastRestaurantGuid": "string",
- "systemDatasourceType": "FILES",
- "maxElementCount": 0,
- "datasourceTransformation": {
- "transformation": [
- "string"
]
}, - "quickFilterId": "string"
}
]
}
}
Get datasource resource
Public API for accessing datasource resources.
This API allows you to retrieve specific resources from a datasource identified by its ID. You can specify the JSON path to the desired resource and the response type too (JSON or file).
JSONPath standard: https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html
JSONPath tester: https://jsonpath.com/
The API offers support for both JSON and binary responses. In the case where the selected value corresponds to an internal URL (e.g. https://beta.wallboard.info/api/storage/datasources/f56b7b4b780a46199754aedc74354703/resources/f56b7b4b780a46199754aedc74354703.jpg), the API will return the actual file associated with that URL.
path Parameters
datasourceId required | string ID of the datasource |
query Parameters
path | string Default: "$" Example: path=$.charts[0] JSON path to the resource |
type | string Default: "json" Enum: "file" "json" Datasource response type |
Responses
Request samples
- CURL
curl --location -g --request GET 'example.com/public-api/datasource/8994b2113f8e4496aacaa05a6b25073a/resource?path=$.charts[0].image&type=file'
Response samples
- 200
- 400
{- "id": "432523-527123-C30D-2D84-B32ED231",
- "name": "Diagram",
}
Update INTERNAL datasource's data
Minimum role: TECHNICIAN
Authorizations:
path Parameters
datasourceId | string |
Request Body schema: application/jsonrequired
data | string <{\"example_key\" : \"example_value\"}> In Wallboard all datasources mapped to |
Responses
Request samples
- Payload
- CURL
{- "data": "string"
}
Response samples
- 400
{- "timestamp": 1683802510,
- "status": 0,
- "error": "string",
- "message": "string",
- "path": "string",
- "exception": "string",
- "details": { }
}
Call webhook as POST request
Authorizations:
Request Body schema: application/jsonrequired
Custom JSON payload. The only required attribute is the event_id
.
Example body: {"event_id":"decrease","keySelector":"test"}
Webhook calls are async in a way that they always send back the response instantly, but the actual action executed in the background.
event_id | string |
Responses
Request samples
- Payload
- CURL
{- "event_id": "string"
}
Response samples
- 200
- 400
{- "message": "string"
}
Call webhook as GET request
Every webhook can be called as GET request. The payload is a Base64 encoded JSON.
Webhook calls are async in a way that they always send back the response instantly, but the actual action executed in the background.
query Parameters
apiKey | string <JWT> |
payload | string <Base64 encoded JSON> Example: payload=eyJldmVudF9pZCI6ImRlY3JlYXNlIiwia2V5U2VsZWN0b3IiOiJ0ZXN0In0=
Original JSON in the example: |
Responses
Request samples
- CURL
curl -X GET \ 'https://example.com/public-api/integration/webhooks?apiKey=your_api_key&payload=eyJldmVudF9pZCI6ImRlY3JlYXNlIiwia2V5U2VsZWN0b3IiOiJ0ZXN0In0='
Response samples
- 200
- 400
{- "message": "string"
}
Update webhook team assignment
query Parameters
customerId | integer (customerId) |
actionId required | integer |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "readOnly": true,
- "teamId": "string"
}
], - "removeFromTeamIds": [
- "string"
]
}
Create webhook event action
query Parameters
customerId | integer (customerId) |
teamIds | string <{teamId},{readOnly},{teamId},{readOnly}...
> (teamIds) Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9,true,00a22e86602c4a88914614aa9516a481,false |
Request Body schema: application/jsonrequired
name | string |
id | integer |
eventId | string |
enabled | boolean |
action | string (action) Enum: "ENABLE_EMERGENCY_ON_DEVICE" "ENABLE_EMERGENCY_ON_DEVICE_TAG" "ENABLE_EMERGENCY_ON_DEVICE_GROUP" "ENABLE_EMERGENCY_ON_DEVICE_ALL" "DISABLE_EMERGENCY_ON_DEVICE" "DISABLE_EMERGENCY_ON_DEVICE_TAG" "DISABLE_EMERGENCY_ON_DEVICE_GROUP" "DISABLE_EMERGENCY_ON_DEVICE_ALL" "LOAD_URL_ON_DEVICE" "LOAD_URL_ON_DEVICE_TAG" "LOAD_URL_ON_DEVICE_GROUP" "LOAD_URL_ON_DEVICE_ALL" "PAUSE_CONTENT_ON_DEVICE" "PAUSE_CONTENT_ON_DEVICE_TAG" "PAUSE_CONTENT_ON_DEVICE_GROUP" "PAUSE_CONTENT_ON_DEVICE_ALL" "RESUME_CONTENT_ON_DEVICE" "RESUME_CONTENT_ON_DEVICE_TAG" "RESUME_CONTENT_ON_DEVICE_GROUP" "RESUME_CONTENT_ON_DEVICE_ALL" "REFRESH_CONTENT_ON_DEVICE" "REFRESH_CONTENT_ON_DEVICE_TAG" "REFRESH_CONTENT_ON_DEVICE_GROUP" "REFRESH_CONTENT_ON_DEVICE_ALL" "SEND_SENSOR_EVENT_TO_DEVICE" "SEND_SENSOR_EVENT_TO_DEVICE_TAG" "SEND_SENSOR_EVENT_TO_DEVICE_GROUP" "SEND_SENSOR_EVENT_TO_DEVICE_ALL" "RESTART_DEVICE" "RESTART_DEVICE_TAG" "RESTART_DEVICE_GROUP" "RESTART_DEVICE_ALL" "ASSIGN_CONTENT_ON_DEVICE" "ASSIGN_CONTENT_ON_DEVICE_TAG" "ASSIGN_CONTENT_ON_DEVICE_GROUP" "ASSIGN_CONTENT_ON_DEVICE_ALL" "PREVIEW_CONTENT_ON_DEVICE" "PREVIEW_CONTENT_ON_DEVICE_TAG" "PREVIEW_CONTENT_ON_DEVICE_GROUP" "PREVIEW_CONTENT_ON_DEVICE_ALL" "WAKE_UP_DEVICE" "WAKE_UP_DEVICE_TAG" "WAKE_UP_DEVICE_GROUP" "WAKE_UP_DEVICE_ALL" "SNOOZE_DEVICE" "SNOOZE_DEVICE_TAG" "SNOOZE_DEVICE_GROUP" "SNOOZE_DEVICE_ALL" "SHOW_TOAST_MESSAGE_DEVICE" "SHOW_TOAST_MESSAGE_DEVICE_TAG" "SHOW_TOAST_MESSAGE_DEVICE_GROUP" "SHOW_TOAST_MESSAGE_DEVICE_ALL" "REFRESH_DATASOURCE" "REFRESH_DATASOURCE_ALL" "INCREASE_VALUE_IN_DATASOURCE" "DECREASE_VALUE_IN_DATASOURCE" "SET_INTERNAL_DATASOURCE" "MERGE_INTERNAL_DATASOURCE" "DELETE_BY_KEY_INTERNAL_DATASOURCE" "INSERT_TO_ARRAY_INTERNAL_DATASOURCE" "REMOVE_FROM_ARRAY_INTERNAL_DATASOURCE" "EMPTY_ARRAY_INTERNAL_DATASOURCE" "ROTATE_ARRAY_INTERNAL_DATASOURCE" "ENABLE_CAMPAIGN" "ENABLE_CAMPAIGN_BY_TAGS" "DISABLE_CAMPAIGN" "DISABLE_CAMPAIGN_BY_TAGS" "CHANGE_SATURATION_CAMPAIGN" "CHANGE_SATURATION_CAMPAIGN_BY_TAGS" "CHANGE_PRIORITY_CAMPAIGN" "CHANGE_PRIORITY_CAMPAIGN_BY_TAGS" "FORCE_SYNC_SHARED_FOLDER" "UPLOAD_FILE_TO_FOLDER" |
actionParams | object |
targetName | string Value: "ALL" |
targetId | string |
customerId | integer |
readOnly | boolean |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "targetId": "string",
- "customerId": 0,
- "readOnly": true
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "targetId": "string",
- "customerId": 0,
- "readOnly": true
}
Get webhook event actions
This endpoint is used to retrieve webhook event action data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhookEvent/actions?customerId=123'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "targetId": "string",
- "customerId": 0,
- "readOnly": true
}
]
}
Get webhook with basic attributes (simple)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer (customerId) |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhookEvent/simple?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get webhook with basic attributes (simplePaged)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer (customerId) |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhookEvent/simplePaged?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get webhook event action by eventId
This endpoint is used to retrieve webhook event action data.
path Parameters
eventId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhookEvent/1/actions'
Response samples
- 200
[- {
- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "customerId": 0,
- "readOnly": true
}
]
Get webhook event action by actionId
This endpoint is used to retrieve webhook event action data.
path Parameters
actionId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhookEvent/actions/133'
Response samples
- 200
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "customerId": 0,
- "readOnly": true
}
Update webhook event action
path Parameters
actionId required | integer |
Request Body schema: application/jsonrequired
name | string |
id | integer |
eventId | string |
enabled | boolean |
action | string (action) Enum: "ENABLE_EMERGENCY_ON_DEVICE" "ENABLE_EMERGENCY_ON_DEVICE_TAG" "ENABLE_EMERGENCY_ON_DEVICE_GROUP" "ENABLE_EMERGENCY_ON_DEVICE_ALL" "DISABLE_EMERGENCY_ON_DEVICE" "DISABLE_EMERGENCY_ON_DEVICE_TAG" "DISABLE_EMERGENCY_ON_DEVICE_GROUP" "DISABLE_EMERGENCY_ON_DEVICE_ALL" "LOAD_URL_ON_DEVICE" "LOAD_URL_ON_DEVICE_TAG" "LOAD_URL_ON_DEVICE_GROUP" "LOAD_URL_ON_DEVICE_ALL" "PAUSE_CONTENT_ON_DEVICE" "PAUSE_CONTENT_ON_DEVICE_TAG" "PAUSE_CONTENT_ON_DEVICE_GROUP" "PAUSE_CONTENT_ON_DEVICE_ALL" "RESUME_CONTENT_ON_DEVICE" "RESUME_CONTENT_ON_DEVICE_TAG" "RESUME_CONTENT_ON_DEVICE_GROUP" "RESUME_CONTENT_ON_DEVICE_ALL" "REFRESH_CONTENT_ON_DEVICE" "REFRESH_CONTENT_ON_DEVICE_TAG" "REFRESH_CONTENT_ON_DEVICE_GROUP" "REFRESH_CONTENT_ON_DEVICE_ALL" "SEND_SENSOR_EVENT_TO_DEVICE" "SEND_SENSOR_EVENT_TO_DEVICE_TAG" "SEND_SENSOR_EVENT_TO_DEVICE_GROUP" "SEND_SENSOR_EVENT_TO_DEVICE_ALL" "RESTART_DEVICE" "RESTART_DEVICE_TAG" "RESTART_DEVICE_GROUP" "RESTART_DEVICE_ALL" "ASSIGN_CONTENT_ON_DEVICE" "ASSIGN_CONTENT_ON_DEVICE_TAG" "ASSIGN_CONTENT_ON_DEVICE_GROUP" "ASSIGN_CONTENT_ON_DEVICE_ALL" "PREVIEW_CONTENT_ON_DEVICE" "PREVIEW_CONTENT_ON_DEVICE_TAG" "PREVIEW_CONTENT_ON_DEVICE_GROUP" "PREVIEW_CONTENT_ON_DEVICE_ALL" "WAKE_UP_DEVICE" "WAKE_UP_DEVICE_TAG" "WAKE_UP_DEVICE_GROUP" "WAKE_UP_DEVICE_ALL" "SNOOZE_DEVICE" "SNOOZE_DEVICE_TAG" "SNOOZE_DEVICE_GROUP" "SNOOZE_DEVICE_ALL" "SHOW_TOAST_MESSAGE_DEVICE" "SHOW_TOAST_MESSAGE_DEVICE_TAG" "SHOW_TOAST_MESSAGE_DEVICE_GROUP" "SHOW_TOAST_MESSAGE_DEVICE_ALL" "REFRESH_DATASOURCE" "REFRESH_DATASOURCE_ALL" "INCREASE_VALUE_IN_DATASOURCE" "DECREASE_VALUE_IN_DATASOURCE" "SET_INTERNAL_DATASOURCE" "MERGE_INTERNAL_DATASOURCE" "DELETE_BY_KEY_INTERNAL_DATASOURCE" "INSERT_TO_ARRAY_INTERNAL_DATASOURCE" "REMOVE_FROM_ARRAY_INTERNAL_DATASOURCE" "EMPTY_ARRAY_INTERNAL_DATASOURCE" "ROTATE_ARRAY_INTERNAL_DATASOURCE" "ENABLE_CAMPAIGN" "ENABLE_CAMPAIGN_BY_TAGS" "DISABLE_CAMPAIGN" "DISABLE_CAMPAIGN_BY_TAGS" "CHANGE_SATURATION_CAMPAIGN" "CHANGE_SATURATION_CAMPAIGN_BY_TAGS" "CHANGE_PRIORITY_CAMPAIGN" "CHANGE_PRIORITY_CAMPAIGN_BY_TAGS" "FORCE_SYNC_SHARED_FOLDER" "UPLOAD_FILE_TO_FOLDER" |
actionParams | object |
targetName | string Value: "ALL" |
customerId | integer |
readOnly | boolean |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "customerId": 0,
- "readOnly": true
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetName": "ALL",
- "customerId": 0,
- "readOnly": true
}
Update webhook api key team assignment
query Parameters
customerId | integer (customerId) |
webhookApiKeyId required | string |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "readOnly": true,
- "teamId": "string"
}
], - "removeFromTeamIds": [
- "string"
]
}
Create webhook api key
query Parameters
customerId | integer (customerId) |
teamIds | string <{teamId},{readOnly},{teamId},{readOnly}...
> (teamIds) Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9,true,00a22e86602c4a88914614aa9516a481,false |
Request Body schema: application/jsonrequired
name | string |
enabled | boolean |
restricted | boolean |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "enabled": true,
- "restricted": true
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "token": "string",
- "restricted": true,
- "createdAt": "string",
- "customerId": 0,
- "readOnly": true
}
Get webhook api key
This endpoint is used to retrieve webhook api key data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhooks/apikey?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "name": "string",
- "id": 0,
- "token": "string",
- "restricted": true,
- "createdAt": "string",
- "customerId": 0,
- "readOnly": true
}
]
}
Get webhook api key with basic attributes (simple)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer (customerId) |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhooks/apikey/simple?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get webhook api key with basic attributes (simplePaged)
This endpoint is useful for listing or if quick response time is required and you only need the id
and name
.
query Parameters
customerId | integer (customerId) |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhooks/apikey/simplePaged?customerId=182&includeReadOnlyInfo=false'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "readOnly": true
}
]
}
Get webhook api key by id
This endpoint is used to retrieve webhook api key data.
path Parameters
id required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/webhooks/apikey/981eb1fb92a045bf96a919f8c810cfd4'
Response samples
- 200
{- "name": "string",
- "id": 0,
- "token": "string",
- "restricted": true,
- "createdAt": "string",
- "customerId": 0,
- "readOnly": true
}
Update webhook api key
path Parameters
id required | string |
Request Body schema: application/jsonrequired
name | string |
id | integer |
token | string |
restricted | boolean |
createdAt | string |
customerId | integer |
readOnly | boolean |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "id": 0,
- "token": "string",
- "restricted": true,
- "createdAt": "string",
- "customerId": 0,
- "readOnly": true
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "token": "string",
- "restricted": true,
- "createdAt": "string",
- "customerId": 0,
- "readOnly": true
}
Update alert rule team assignment
query Parameters
customerId | integer (customerId) |
alertRuleId required | integer |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "readOnly": true,
- "teamId": "string"
}
], - "removeFromTeamIds": [
- "string"
]
}
Create alert rule
query Parameters
customerId | integer (customerId) |
teamIds | string <{teamId},{readOnly},{teamId},{readOnly}...
> (teamIds) Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9,true,00a22e86602c4a88914614aa9516a481,false |
Request Body schema: application/jsonrequired
@type | string Enum: "DeviceOffline" "DatasourceError" |
comment | string |
object | |
delayEvaluateAfterViolationMinutes | integer |
enabled | boolean |
name | string |
Array of objects | |
scheduledEvaluateSeconds | integer |
object (teamAccessList) | |
object (affectedDays) | |
object (workingTime) | |
id | integer |
Responses
Request samples
- Payload
- CURL
{- "@type": "DeviceOffline",
- "comment": "string",
- "condition": {
- "@type": "DeviceOfflineAndNoActivityForMinutes",
- "deviceGroupId": "string",
- "excludeDeviceGroupIds": [
- "string"
], - "excludeDeviceIds": [
- "string"
], - "inactiveMinutes": 0,
- "recursive": true,
- "tagFilter": {
- "logicalOperator": "AND",
- "tagFilterType": "INCLUDE",
- "tags": [
- "string"
]
}
}, - "delayEvaluateAfterViolationMinutes": 0,
- "enabled": true,
- "name": "string",
- "notificationChannel": [
- {
- "id": "string"
}
], - "scheduledEvaluateSeconds": 0,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "allDay": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}, - "id": 0
}
Response samples
- 200
{- "@type": "DeviceOffline",
- "comment": "string",
- "condition": {
- "@type": "DeviceOfflineAndNoActivityForMinutes",
- "deviceGroupId": "string",
- "excludeDeviceGroupIds": [
- "string"
], - "excludeDeviceIds": [
- "string"
], - "inactiveMinutes": 0,
- "recursive": true,
- "tagFilter": {
- "logicalOperator": "AND",
- "tagFilterType": "INCLUDE",
- "tags": [
- "string"
]
}
}, - "delayEvaluateAfterViolationMinutes": 0,
- "enabled": true,
- "name": "string",
- "notificationChannel": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "channelType": "EMAIL",
- "notify": [
- "string"
]
}
], - "scheduledEvaluateSeconds": 0,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialEndingSegment": true,
- "allowPartialStartingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}, - "alertFixedSmsTemplate": "string",
- "alertSmsTemplate": "string",
- "appliedToDeviceGroupId": "string",
- "evaluateSummaryEmailTemplate": "string",
- "excludeDeviceGroupIds": [
- "string"
], - "excludeDeviceIds": [
- "string"
], - "id": 0,
- "version": 0
}
Get alert rule
This endpoint is used to retrieve alert rule data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/alertRule?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "@type": "DeviceOffline",
- "comment": "string",
- "condition": {
- "@type": "DeviceOfflineAndNoActivityForMinutes",
- "deviceGroupId": "string",
- "excludeDeviceGroupIds": [
- "string"
], - "excludeDeviceIds": [
- "string"
], - "inactiveMinutes": 0,
- "recursive": true,
- "tagFilter": {
- "logicalOperator": "AND",
- "tagFilterType": "INCLUDE",
- "tags": [
- "string"
]
}
}, - "delayEvaluateAfterViolationMinutes": 0,
- "enabled": true,
- "name": "string",
- "notificationChannel": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "channelType": "EMAIL",
- "notify": [
- "string"
]
}
], - "scheduledEvaluateSeconds": 0,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "allDay": true,
- "allowDayOfWeekOverflow": true,
- "allowPartialEndingSegment": true,
- "allowPartialStartingSegment": true,
- "from": "string",
- "end": "string",
- "timeZone": "string"
}, - "alertFixedSmsTemplate": "string",
- "alertSmsTemplate": "string",
- "appliedToDeviceGroupId": "string",
- "evaluateSummaryEmailTemplate": "string",
- "excludeDeviceGroupIds": [
- "string"
], - "excludeDeviceIds": [
- "string"
], - "id": 0,
- "version": 0,
- "readOnly": true,
- "dtype": "DeviceOffline"
}
]
}
Get alert
This endpoint is used to retrieve alert data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/alert?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "alertRuleId": 0,
- "createdAtDate": "string",
- "customerId": 0,
- "id": 0
}
]
}
Get datasource alert
This endpoint is used to retrieve datasource alert data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/alert/datasource?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "alertRuleId": 0,
- "alertRuleName": "string",
- "createdAtDate": "string",
- "customerId": 0,
- "id": 0,
- "datasourceErrorCounter": 0,
- "datasourceId": "string",
- "datasourceLastError": "string",
- "datasourceName": "string"
}
]
}
Get device alert
This endpoint is used to retrieve device alert data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/alert/device?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "alertRuleId": 0,
- "alertRuleName": "string",
- "createdAtDate": "string",
- "deviceGroupId": "string",
- "deviceGroupPath": "string",
- "deviceId": "string",
- "deviceLastActivity": "string",
- "deviceLastStatusChange": "string",
- "deviceName": "string",
- "id": 0
}
]
}
Get all device alert
This endpoint is used to retrieve device alert data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/alert/device/all?customerId=182'
Response samples
- 200
{- "alertRuleId": 0,
- "alertRuleName": "string",
- "createdAtDate": "string",
- "deviceGroupId": "string",
- "deviceGroupPath": "string",
- "deviceId": "string",
- "deviceLastActivity": "string",
- "deviceLastStatusChange": "string",
- "deviceName": "string",
- "id": 0
}
Get log
This endpoint is used to retrieve log data.
query Parameters
customerId | integer (customerId) |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
select | string (select)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/log/?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "message": "string",
- "timestamp": 1683802510,
- "logLevel": "INFO",
- "customer": {
- "id": 0,
- "comment": "string",
- "country": "string",
- "expirationDate": "string",
- "freeLicenses": 0,
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "licenseType": "BASIC",
- "profile": "BASIC",
- "location": "string",
- "name": "string",
- "restricted": true,
- "type": "string",
- "contentDesignerEmail": "string",
- "supportEmail": "string",
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRule": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "user": {
- "address": "string",
- "authProvider": "LOCAL",
- "createdDate": 1683802510,
- "customer": {
- "id": 0,
- "name": "string",
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "profile": "BASIC",
- "restricted": true,
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "email": "string",
- "hiddenUIElementRules": "string",
- "lastActivity": 1683802510,
- "lastLogin": 1683802510,
- "logins": 0,
- "name": "string",
- "presenceTime": 0,
- "profilePictureApiPath": "string",
- "restricted": true,
- "role": "DEVICE_USER",
- "ssoLoginEnabled": true,
- "termsOfServiceAcceptDate": 1683802510,
- "use2FA": true,
- "usernamePasswordLoginEnabled": true,
- "hasProfilePicture": true,
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "active": true,
- "pinCodePresent": true
}, - "userEmail": "string"
}
]
}
Get specific log
This endpoint is used to retrieve device
or content
log data.
query Parameters
customerId | integer (customerId) |
deviceId | string Either |
contentId | string Either |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/log/specific?customerId=182&contentId=bbc27d811cfe44d18eae17bb2734122e'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "message": "string",
- "timestamp": 1683802510,
- "loglevel": "INFO",
- "customer": {
- "id": 0,
- "name": "string",
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "profile": "BASIC",
- "restricted": true,
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "device": {
- "address": "string",
- "id": "string",
- "assignDate": 0,
- "deviceInfo": {
- "other": {
- "brand": "string",
- "debug": true,
- "locked": true,
- "rooted": true,
- "gpuInfo": "string",
- "updatable": true,
- "rootGranted": true,
- "giadaDeviceId": "string",
- "lastStartTime": 0,
- "webViewVersion": "string"
}, - "general": {
- "model": "string",
- "version": "string",
- "platform": "string",
- "fwVersion": "string",
- "osVersion": "string",
- "webResolution": "string",
- "nativeResolution": "string"
}, - "metrics": {
- "cpu": {
- "cores": 0,
- "threads": 0,
- "description": "string"
}, - "network": [
- {
- "ip": "string",
- "mac": "string",
- "name": "string",
- "type": "string"
}
], - "storage": [
- {
- "type": "string",
- "mount": "string",
- "capacity": 0
}
], - "maxMemory": 0
}
}, - "deviceStatus": "ONLINE",
- "emergencyStatus": true,
- "enabledConsole": true,
- "enabledName": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "isOutdated": true,
- "installDate": 1683802510,
- "lastActivity": 1683802510,
- "licenseType": "BASIC",
- "name": "string",
- "dataRowId": "string",
- "sensorConfig": "string",
- "tags": [
- "string"
], - "type": "TABLET",
- "platform": "ANDROID",
- "upTime": 0,
- "rebootTime": "string",
- "version": "string",
- "firmwareVersion": "string",
- "networkInterfaceType": "string",
- "osVersion": "string",
- "webViewVersion": "string",
- "nativeResolutionWidth": 0,
- "nativeResolutionHeight": 0,
- "webResolutionWidth": 0,
- "webResolutionHeight": 0,
- "macAddress": "string",
- "localIpAddress": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "rotation": {
- "angle": 0,
- "type": "WEB_VIEW"
}, - "workingHours": {
- "days": {
- "MON": {
- "from": "string",
- "to": "string"
}, - "TUE": {
- "from": "string",
- "to": "string"
}, - "WED": {
- "from": "string",
- "to": "string"
}, - "THU": {
- "from": "string",
- "to": "string"
}, - "FRI": {
- "from": "string",
- "to": "string"
}, - "SAT": {
- "from": "string",
- "to": "string"
}, - "SUN": {
- "from": "string",
- "to": "string"
}
}, - "mode": "DEVICE"
}, - "supportedFeatures": {
- "featureList": [
- {
- "type": "WORKING_HOURS"
}
]
}, - "customerId": 0,
- "customer": {
- "id": 0,
- "comment": "string",
- "country": "string",
- "expirationDate": "string",
- "freeLicenses": 0,
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "licenseType": "BASIC",
- "profile": "BASIC",
- "location": "string",
- "name": "string",
- "restricted": true,
- "type": "string",
- "contentDesignerEmail": "string",
- "supportEmail": "string",
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRule": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "deviceGroupId": "string",
- "deviceGroupPath": "string",
- "preview": "string",
- "contentId": "string",
- "content": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": "string",
- "lastSavedByEmail": "string",
- "name": "string",
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "contentGroupName": "string",
- "fileName": "string",
- "previewLocation": "string",
- "location": "string"
}, - "contentType": "string",
- "location": "string",
- "emergencyContentId": "string",
- "emergencyContentType": "string",
- "emergencyContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": "string",
- "lastSavedByEmail": "string",
- "name": "string",
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "contentGroupName": "string",
- "fileName": "string",
- "previewLocation": "string",
- "location": "string"
}
}, - "deviceId": "string"
}, - {
- "id": 0,
- "message": "string",
- "timestamp": 1683802510,
- "loglevel": "INFO",
- "customerId": 0,
- "user": {
- "address": "string",
- "authProvider": "LOCAL",
- "createdDate": 1683802510,
- "customer": {
- "id": 0,
- "name": "string",
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "profile": "BASIC",
- "restricted": true,
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "email": "string",
- "hiddenUIElementRules": "string",
- "lastActivity": 1683802510,
- "lastLogin": 1683802510,
- "logins": 0,
- "name": "string",
- "presenceTime": 0,
- "profilePictureApiPath": "string",
- "restricted": true,
- "role": "DEVICE_USER",
- "ssoLoginEnabled": true,
- "termsOfServiceAcceptDate": 1683802510,
- "use2FA": true,
- "usernamePasswordLoginEnabled": true,
- "hasProfilePicture": true,
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "active": true,
- "pinCodePresent": true
}, - "userEmail": "string",
- "content": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "termsOfServiceAcceptDate": 1683802510,
- "lastActivity": 1683802510,
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "string",
- "customerId": 0,
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "profilePictureApiPath": "string",
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "tags": [
- "string"
], - "deviceContentType": "simpleLoop",
- "customer": {
- "id": 0,
- "comment": "string",
- "country": "string",
- "location": "string",
- "expirationDate": 1683802510,
- "freeLicenses": 0,
- "name": "string",
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "profile": "BASIC",
- "restricted": true,
- "type": "string",
- "createdDate": 1683802510,
- "needsToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "subreseller": {
- "id": 0,
- "orderAutoApproveAllowed": true
}, - "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "contentGroupName": "string",
- "fileName": "string",
- "previewLocation": "string",
- "location": "string"
}, - "contentId": "string"
}
]
}
Get log csv
This endpoint is used to retrieve log data in csv format.
query Parameters
customerId | integer (customerId) |
fromDate | date |
toDate | date |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/log/csv?customerId=182'
Response samples
- 200
{- "timestamp": "string",
- "contentName": "string",
- "deviceName": "string",
- "userEmail": "string",
- "logLevel": "INFO",
- "message": "string"
}