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 an attribute is not present it means NULL (to lower the overall traffic).
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
- Example:
search=teamAssignments.team.id=teamId1|teamAssignments.team.id=teamId2
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:
selectTeamIds=teamId1,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
}
Create customer
This endpoint is used to create customer.
Request Body schema: application/jsonrequired
id | integer |
comment | string |
country | string |
expirationDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
freeLicenses | integer |
browserSessionLicenses | integer |
deviceSessionLimit | integer |
licenseType | string (licenseType) Enum: "BASIC" "PROFESSIONAL" "ENTERPRISE" "DBA" |
profile | string (customerProfile) Enum: "BASIC" "ADVANCED" "PROFESSIONAL" "INHERIT" |
location | string |
name | string |
restricted | boolean |
type | string |
contentDesignerEmail | string |
supportEmail | string |
createdDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
needToBeInvoiced | boolean |
storageSize | integer |
vertical | string (customerVertical) Enum: "BANKING_AND_FINANCE" "EMPLOYEE_CORPORATE_COMMUNICATION" "CORPORATE_MEETING_ROOMS" "DIGITAL_SIGNAGE" "EDUCATION_COLLAGE_AND_UNIVERSITIES" "CONFERENCE_AND_CONVENTION_CENTERS" "GOVERNMENT" "HEALTHCARE" "HOSPITALITY" "QUICK_SERVICE_RESTAURANT" "RETAIL" "SPORTS" "PETROL_STATIONS" "TRANSPORTATION" "ENTERTAINMENT" "WAYFINDING_AND_DIRECTORIES" "OTHER" |
hiddenUIElementRules | string |
enableAutomaticDistributionToDms | boolean |
userFullAccessIfNotInTeam | boolean |
accessResourcesWithoutTeam | boolean |
object (brandingGuideline) | |
object (subreseller) | |
ownerSubresellerId | integer |
slaveId | string |
onlineLicenses | integer |
totalLicenses | integer |
usedFree | integer |
activeLicenses | integer |
deviceAndGroupCreationEnabledInRootForTeamUsers | boolean |
contentAndGroupCreationEnabledInRootForTeamUsers | boolean |
fileAndFolderCreationEnabledInRootForTeamUsers | boolean |
ownerName | string |
Responses
Request samples
- Payload
- CURL
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
Response samples
- 200
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
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
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "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",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": 1683802510,
- "lastDeviceActivity": 1683802510,
- "totalLicenses": 0,
- "subreseller": {
- "id": 0
}, - "owner": {
- "id": 0
}
}
]
}
Get customer info
This endpoint is used to retrieve customer info data.
query Parameters
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/info'
Response samples
- 200
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
Get customer
This endpoint is used to retrieve customer data.
query Parameters
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/select?customerId=182'
Response samples
- 200
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "subscriptionId": "string",
- "user": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "subscriptionUrl": "string"
}
Get customers 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
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/simple'
Response samples
- 200
{- "content": [
- {
- "id": 0,
- "name": "string"
}
]
}
Get customers 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
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/customer/simplePaged'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "name": "string"
}
]
}
Get customer statistics by id
This endpoint is used to retrieve customer statistics by customerId.
query Parameters
customerId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/182/stats'
Response samples
- 200
{- "totalDevices": 0,
- "totalLicenses": 0,
- "lastDeviceActivity": 1683802510,
- "activeDevicesInLastWeek": 0,
- "totalUsers": 0,
- "totalUserPresenceTime": 0,
- "totalUserLoginCount": 0,
- "activeUsersInLastWeek": 0,
- "totalContents": 0,
- "totalDatasources": 0,
- "ownedCustomerCount": 0,
- "devicesByState": {
- "slices": [
- {
- "name": "string",
- "value": 0
}
], - "total": 0
}, - "devicesByLicensePayType": {
- "slices": [
- {
- "name": "string",
- "value": 0
}
], - "total": 0
}, - "devicesByLicenseType": {
- "slices": [
- {
- "name": "string",
- "value": 0
}
], - "total": 0
}, - "contentsByType": {
- "slices": [
- {
- "name": "string",
- "value": 0
}
], - "total": 0
}
}
Get customer usage details
This endpoint is used to retrieve customer storage usage details.
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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/usageDetails'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "customerId": 0,
- "storageUsage": {
- "current": 0,
- "total": 0
}
}
]
}
Get customer white label properties
This endpoint is used to retrieve customer white label properties data.
query Parameters
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/customerWhiteLabelProperties?customerId=182'
Response samples
- 200
{- "domainName": "string"
}
Get subreseller customers
This endpoint is used to retrieve subreseller customer 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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/ownedAsSubreseller'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
]
}
Get customer default content
This endpoint is used to retrieve customer default content data.
query Parameters
customerId | integer (customerId) |
includeEmergencyContent | boolean |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/customer/settings/getDefaultContents?customerId=182&includeEmergencyContent=true'
Response samples
- 200
{- "emergencyContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "comment": "string",
- "iconUrl": "string",
- "termsOfServiceAcceptDate": 1683802510,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "string",
- "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true
}, - "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { }
}
}
Set customer default content
This endpoint is used to set default content for customer.
query Parameters
customerId | integer (customerId) |
defaultEmergencyContentId | string |
Responses
Request samples
- CURL
curl -X PUT \ '{{server_root}}/api/customer/settings/setDefaultContents?customerId=182&defaultEmergencyContentId=158309d3291041cb7e6887552076'
Update customer team settings
This endpoint is used to update customer global team settings data.
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
userFullAccessIfNotInTeam | boolean |
accessResourcesWithoutTeam | boolean |
isDeviceAndGroupCreationEnabledInRootForTeamUsers | boolean |
isContentAndGroupCreationEnabledInRootForTeamUsers | boolean |
isFileAndFolderCreationEnabledInRootForTeamUsers | boolean |
Responses
Request samples
- Payload
- CURL
{- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true
}
Update customer hidden UI element rules
This endpoint is used to update customer hidden UI element rules.
path Parameters
customerId required | integer |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
- CURL
{ }
Response samples
- 200
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
Update customer branding guideline
This endpoint is used to update customer branding guideline data.
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
Array of objects |
Responses
Request samples
- Payload
- CURL
{- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}
Update subreseller customer
This endpoint is used to update subreseller customer data.
path Parameters
subresellerId required | integer |
Request Body schema: application/jsonrequired
id | integer |
Responses
Request samples
- Payload
- CURL
{- "id": 0
}
Response samples
- 200
{- "id": 0
}
Update customer
This endpoint is used to update customer data.
path Parameters
customerId required | integer |
Request Body schema: application/jsonrequired
comment | string |
country | string |
expirationDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
freeLicenses | integer |
licenseType | string (licenseType) Enum: "BASIC" "PROFESSIONAL" "ENTERPRISE" "DBA" |
profile | string (customerProfile) Enum: "BASIC" "ADVANCED" "PROFESSIONAL" "INHERIT" |
location | string |
name | string |
restricted | boolean |
type | string |
contentDesignerEmail | string |
supportEmail | string |
createdDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
needToBeInvoiced | boolean |
hiddenUIElementRules | string |
enableAutomaticDistributionToDms | boolean |
browserSessionLicenses | integer |
deviceSessionLimit | integer |
storageSize | integer |
vertical | string (customerVertical) Enum: "BANKING_AND_FINANCE" "EMPLOYEE_CORPORATE_COMMUNICATION" "CORPORATE_MEETING_ROOMS" "DIGITAL_SIGNAGE" "EDUCATION_COLLAGE_AND_UNIVERSITIES" "CONFERENCE_AND_CONVENTION_CENTERS" "GOVERNMENT" "HEALTHCARE" "HOSPITALITY" "QUICK_SERVICE_RESTAURANT" "RETAIL" "SPORTS" "PETROL_STATIONS" "TRANSPORTATION" "ENTERTAINMENT" "WAYFINDING_AND_DIRECTORIES" "OTHER" |
Responses
Request samples
- Payload
- CURL
{- "comment": "string",
- "country": "string",
- "expirationDate": 1683802510,
- "freeLicenses": 0,
- "licenseType": "BASIC",
- "profile": "BASIC",
- "location": "string",
- "name": "string",
- "restricted": true,
- "type": "string",
- "contentDesignerEmail": "string",
- "supportEmail": "string",
- "createdDate": 1683802510,
- "needToBeInvoiced": true,
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "browserSessionLicenses": 0,
- "deviceSessionLimit": 0,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE"
}
Response samples
- 200
{- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}
Update user team assignments
This endpoint is used to update user team assignments.
query Parameters
customerId | integer (customerId) |
email required | string |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "removeFromTeamIds": [
- "string"
]
}
Send feedback
This endpoint is used to send feedback.
Request Body schema: application/jsonrequired
Array of objects | |
message | string |
messageType | string |
Responses
Request samples
- Payload
- CURL
{- "images": [
- {
- "fileName": "string",
- "imageUrl": "string"
}
], - "message": "string",
- "messageType": "string"
}
Send content request
This endpoint is used to send content request.
Request Body schema: application/jsonrequired
Array of objects | |
message | string |
messageType | string |
contentName | string |
startDate | string |
endDate | string |
targetScreenGroup | string |
Responses
Request samples
- Payload
- CURL
{- "images": [
- {
- "fileName": "string",
- "imageUrl": "string"
}
], - "message": "string",
- "messageType": "string",
- "contentName": "string",
- "startDate": "string",
- "endDate": "string",
- "targetScreenGroup": "string"
}
Create user
This endpoint is used to create user.
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
string | |
name | string |
language | string |
phoneNumber | string |
address | string |
comment | string |
iconUrl | string |
lastLogin | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
createdDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
termsOfServiceAcceptDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
logins | integer |
presenceTime | integer |
lastActivity | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
editorLevel | string (editorLevel) Enum: "BASIC" "ADVANCED" "PROFESSIONAL" |
role | string (userRole) Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN" |
authProvider | string (authProvider) Enum: "LOCAL" "LDAP" "KEYCLOAK" |
ssoLoginEnabled | boolean |
usernamePasswordLoginEnabled | boolean |
use2FA | boolean |
restricted | boolean |
hasProfilePicture | boolean |
hiddenUIElementRules | string |
object (customer) | |
customerId | integer |
object (location) | |
object (userInterfaceProfile) | |
userInterfaceProfileId | integer |
regionalFormatSettings | object |
ownerCanAccessNetworkMember | boolean |
storageIdentifier | string |
resetUserInterfaceProfile | boolean |
profilePictureApiPath | string |
readOnly | boolean |
active | boolean |
pinCodePresent | boolean |
Responses
Request samples
- Payload
- CURL
{- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}
Response samples
- 200
{- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}
Get users
This endpoint is used to retrieve user 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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/user/?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "content": [
- {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}
]
}
Update user
This endpoint is used to update user data.
query Parameters
email required | string |
Request Body schema: application/jsonrequired
string | |
name | string |
language | string |
phoneNumber | string |
address | string |
comment | string |
iconUrl | string |
lastLogin | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
createdDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
termsOfServiceAcceptDate | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
logins | integer |
presenceTime | integer |
lastActivity | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
editorLevel | string (editorLevel) Enum: "BASIC" "ADVANCED" "PROFESSIONAL" |
role | string (userRole) Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN" |
authProvider | string (authProvider) Enum: "LOCAL" "LDAP" "KEYCLOAK" |
ssoLoginEnabled | boolean |
usernamePasswordLoginEnabled | boolean |
use2FA | boolean |
restricted | boolean |
hasProfilePicture | boolean |
hiddenUIElementRules | string |
object (customer) | |
customerId | integer |
object (location) | |
object (userInterfaceProfile) | |
userInterfaceProfileId | integer |
regionalFormatSettings | object |
ownerCanAccessNetworkMember | boolean |
storageIdentifier | string |
resetUserInterfaceProfile | boolean |
profilePictureApiPath | string |
readOnly | boolean |
active | boolean |
pinCodePresent | boolean |
Responses
Request samples
- Payload
- CURL
{- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}
Get users V2
This endpoint is used to retrieve user 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/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": [
- {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "use2FA": true,
- "restricted": true,
- "hiddenUIElementRules": "string",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "hasProfilePicture": true,
- "regionalFormatSettings": "string",
- "ownerCanAccessNetworkMember": true,
- "pinCodePresent": true,
- "profilePictureApiPath": "string",
- "customer": {
- "id": 0,
- "name": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "active": true
}
]
}
Get users 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) |
search | string (search)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/user/simple'
Response samples
- 200
{- "content": [
- {
- "email": "string",
- "name": "string"
}
]
}
Get users 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) |
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/user/simplePaged'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "email": "string",
- "name": "string"
}
]
}
Get user terms of service acceptance info
This endpoint is used to retrieve terms of service acceptance info.
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/user/userTermsOfServiceAcceptanceInfo'
Response samples
- 200
{- "userAcceptedTermsOfServiceDate": 1683802510,
- "termsOfServiceLastUpdatedDate": 1683802510,
- "userAcceptedLatestTermsOfService": true
}
Get user access and role
This endpoint is used to retrieve user access and role.
query Parameters
role | string (userRole) Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN" |
customerId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/user/checkAccessAndRole?role=TECHNICIAN&customerId=182'
Update user interface profile assignments
This endpoint is used to update user interface profile user assignments.
path Parameters
userInterfaceProfileId required | integer |
Request Body schema: application/jsonrequired
assignUserIds | Array of strings |
removeUserIds | Array of strings |
allIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignUserIds": [
- "string"
], - "removeUserIds": [
- "string"
], - "allIds": [
- "string"
]
}
Create user interface profile
This endpoint is used to create user interface profile.
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
hiddenUIElementRules | string |
name | string |
comment | string |
Responses
Request samples
- Payload
- CURL
{- "hiddenUIElementRules": "string",
- "name": "string",
- "comment": "string"
}
Response samples
- 200
{- "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 (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/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": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}
]
}
Update user interface profile
This endpoint is used to update user interface profile.
path Parameters
userInterfaceProfileId required | integer |
Request Body schema: application/jsonrequired
hiddenUIElementRules | string |
name | string |
comment | string |
Responses
Request samples
- Payload
- CURL
{- "hiddenUIElementRules": "string",
- "name": "string",
- "comment": "string"
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}
Create team
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
name | string |
comment | string |
hiddenUIElementRules | string |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string"
}
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
}
Update team
query Parameters
teamId required | string |
Request Body schema: application/jsonrequired
name | string |
comment | string |
hiddenUIElementRules | string |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string"
}
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
}
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 |
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)
|
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
}
]
Get team
This endpoint is used to retrieve team data by teamId.
path Parameters
teamId required | string |
query Parameters
includeTeamUserNumber | boolean Default: false |
includeTeamResourceNumber | boolean Default: false |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/c0fe84f898534829816988949b6012c3?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
}
Get team user assignments
This endpoint is used to retrieve team user assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/userAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get user team assignments
This endpoint is used to retrieve user team assignments data.
path Parameters
userEmail required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/user/wallboard%40wallboard.info/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team device assignments
This endpoint is used to retrieve team device assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get device team assignments
This endpoint is used to retrieve device team assignments data.
path Parameters
deviceId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/device/f229806904154d8abe67f42629d0c1bb/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team device group assignments
This endpoint is used to retrieve team device group assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get device group team assignments
This endpoint is used to retrieve device group team assignments data.
path Parameters
deviceGroupId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceGroup/7a6b26eea52549eda28c265acd808471/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team device content assignments
This endpoint is used to retrieve team device content assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceContentAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get device content team assignments
This endpoint is used to retrieve device content team assignments data.
path Parameters
deviceContentId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceContent/fvb50b6232b4eb19bce33c16c6db148/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team content group assignments
This endpoint is used to retrieve team content group assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/contentGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get content group team assignments
This endpoint is used to retrieve content group team assignments data.
path Parameters
contentGroupId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/contentGroup/7a6b26eea52549eda28c265acd808471/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team device install rule assignments
This endpoint is used to retrieve team device install rule assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceInstallRuleAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get device install rule team assignments
This endpoint is used to retrieve device install rule team assignments data.
path Parameters
deviceInstallRuleId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/deviceInstallRule/390/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team file assignments
This endpoint is used to retrieve team file assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/fileAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get file team assignments
This endpoint is used to retrieve file team assignments data.
path Parameters
fileId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/file/9d1db619f8364d5cb18c3853cb69c056/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team file folder assignments
This endpoint is used to retrieve team file folder assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/fileFolderAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get file folder team assignments
This endpoint is used to retrieve file folder team assignments data.
path Parameters
fileFolderId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/fileFolder/661d67c2829044228480eeb6/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team quick filter assignments
This endpoint is used to retrieve team quick filter assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/quickFilterAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get quick filter team assignments
This endpoint is used to retrieve quick filter team assignments data.
path Parameters
quickFilterId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/quickFilter/af0d948d59144d61a67e677b509dec49/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team datasource assignments
This endpoint is used to retrieve team datasource assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/datasourceAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get datasource team assignments
This endpoint is used to retrieve datasource team assignments data.
path Parameters
datasourceId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/datasource/477713a90f1846039aae43698c7d3aac/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team campaign assignments
This endpoint is used to retrieve team campaign assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/campaignAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get campaign team assignments
This endpoint is used to retrieve campaign team assignments data.
path Parameters
campaignId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/campaign/2328/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team advertiser assignments
This endpoint is used to retrieve team advertiser assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/advertiserAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get advertiser team assignments
This endpoint is used to retrieve advertiser team assignments data.
path Parameters
advertiserId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/advertiser/eab615518d4a405ea08f8002760c8739/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team message assignments
This endpoint is used to retrieve team message assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/messageAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get message team assignments
This endpoint is used to retrieve message team assignments data.
path Parameters
messageId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/message/881/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team message group assignments
This endpoint is used to retrieve team message group assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/messageGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get message group team assignments
This endpoint is used to retrieve message group team assignments data.
path Parameters
messageGroupId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/messageGroup/1264/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team alert rule assignments
This endpoint is used to retrieve team alert rule assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/alertRuleAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get alert rule team assignments
This endpoint is used to retrieve alert rule team assignments data.
path Parameters
alertRuleId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/alertRule/337/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team notification channel assignments
This endpoint is used to retrieve team notification channel assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/notificationChannelAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get notification channel team assignments
This endpoint is used to retrieve notification channel team assignments data.
path Parameters
notificationChannelId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/notificationChannel/14/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team microsoft tenant assignments
This endpoint is used to retrieve team microsoft tenant assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/microsoftTenantAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get microsoft tenant team assignments
This endpoint is used to retrieve microsoft tenant team assignments data.
path Parameters
microsoftTenantId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/microsoftTenant/21b1028ed2b34ftl11d6b4a78e69657/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team google credential assignments
This endpoint is used to retrieve team google credential assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/googleCredentialAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get google credential team assignments
This endpoint is used to retrieve google credential team assignments data.
path Parameters
googleCredentialId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/googleCredential/5942433f4b374ba79cca749d5464e833/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get team webhook assignments
This endpoint is used to retrieve team webhook assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/webhookEventActionAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get webhook team assignments
This endpoint is used to retrieve webhook team assignments data.
path Parameters
webhookEventActionId required | integer |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/webhookEventAction/168/assignments'
Response samples
- 200
[- {
- "resourceId": 0,
- "teamId": "string",
- "readOnly": true
}
]
Get team webhook api key assignments
This endpoint is used to retrieve team webhook api key assignments data.
query Parameters
teamId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/webhookApiKeyAssignments?teamId=c0fe84f898534829816988949b6012c3'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Get webhook api key team assignments
This endpoint is used to retrieve webhook api key team assignments data.
path Parameters
webhookApiKeyId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/team/webhookApiKey/dff1bf8db99b4864b122e0fa2eb2ad7d/assignments'
Response samples
- 200
[- {
- "resourceId": "string",
- "teamId": "string",
- "readOnly": true
}
]
Update team user assignments
This endpoint is used to update team user assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team device assignments
This endpoint is used to update team device assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team device group assignments
This endpoint is used to update team device group assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team device content assignments
This endpoint is used to update team device content assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team content group assignments
This endpoint is used to update team content group assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team device install rule assignments
This endpoint is used to update team device install rule assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team file assignments
This endpoint is used to update team file assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team file folder assignments
This endpoint is used to update team file folder assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team quick filter assignments
This endpoint is used to update team quick filter assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team datasource assignments
This endpoint is used to update team datasource assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team campaign assignments
This endpoint is used to update team campaign assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team advertiser assignments
This endpoint is used to update team advertiser assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team message assignments
This endpoint is used to update team message assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team message group assignments
This endpoint is used to update team message group assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team alert rule assignments
This endpoint is used to update team alert rule assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team notification channel assignments
This endpoint is used to update team notification channel assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team microsoft tenant assignments
This endpoint is used to update team microsoft tenant assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team google credential assignments
This endpoint is used to update team google credential assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
Update team webhook assignments
This endpoint is used to update team webhook assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of integers |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": 0,
- "readOnly": true
}
], - "resourceIdsToRemove": [
- 0
]
}
Update team webhook api key assignments
This endpoint is used to update team webhook api key assignments data.
query Parameters
teamId required | string |
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Array of objects | |
resourceIdsToRemove | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "resourcesToAdd": [
- {
- "id": "string",
- "readOnly": true
}
], - "resourceIdsToRemove": [
- "string"
]
}
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 (devicePlatform) Enum: "ANDROID" "WINDOWS" "BRIGHTSIGN" "SAMSUNG" "LG" "PWA" "UNKNOWN" |
object (supportedDeviceFeatures) | |
fillContentDetails | boolean Default: true optional |
alwaysIncludeAssignedDatasourceResources | boolean |
currentTime | integer |
timeZone | string |
object |
Responses
Request samples
- Payload
- CURL
{- "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,
- "alwaysIncludeAssignedDatasourceResources": true,
- "currentTime": 0,
- "timeZone": "string",
- "screenshotModeParams": {
- "currentPage": "string"
}
}
Response samples
- 200
{- "content": "string",
- "assignedContentId": "string",
- "deviceName": "string",
- "showName": true,
- "showConsole": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "dataRowId": "string",
- "datasourceId": "string",
- "emergencyState": true,
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "timeStamp": 0,
- "rebootTime": "string",
- "licenseType": "BASIC",
- "specialLicenses": [
- "SENSOR_COMMUNICATION"
], - "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"
}
]
}, - "assignedDatasourceResources": {
- "cachedResources": [
- {
- "absolutePath": "string",
- "resourceHandlingPolicy": "RELOAD_CONTENT_IF_CHANGED",
- "resourceType": "DISPLAYER_FILE",
- "version": "V1"
}
], - "rotateRules": [
- {
- "urlPattern": "string",
- "strategy": "LRU",
- "threshold": "ALWAYS"
}
]
}, - "weatherLocation": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "displayStatus": "ON",
- "locked": true,
- "timeZone": "string",
- "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"
}, - "connectionSettings": {
- "dmsUrl": "string",
- "fallbackUrls": [
- "string"
], - "masterServerUrl": "string"
}, - "statisticsSettings": {
- "deviceMetricsEnabled": true,
- "formDataEnabled": true,
- "clickStatEnabled": true,
- "displayTimeStatEnabled": true
}, - "tags": [
- "string"
], - "advancedConfiguration": { },
- "updateRule": { },
- "screenshotMode": {
- "nextPageId": "string"
}
}
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 |
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",
- "deviceStatus": "ONLINE",
- "readOnly": true
}
]
}
Assign device to customer
Minimum role: TECHNICIAN
Authorizations:
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
activationCode | string |
serial | string |
createDeviceIfSerialNotFound | boolean |
customerId | integer |
deviceName | string |
deviceGroupId | string |
contentId | string |
emergencyContentId | string |
licenseOrderId | integer |
migrateFromDeviceId | string |
deleteMigratedDevice | boolean |
object (resourceCreationTeamAssignParams) | |
showName | boolean Default: false |
showConsole | boolean Default: false |
showDeviceInfo | boolean Default: false |
showStateIndicator | boolean Default: true |
datasourceId | string |
daraRowId | string |
sensorConfig | string |
weatherLocation | string |
timeZone | string |
object (deviceRotation) | |
object (deviceWorkingHours) | |
tags | Array of strings (tags) |
emergencyStatus | boolean Default: false |
updateVersionUpperLimit | string |
rebootTime | string |
volumeLevel | integer |
brightnessLevel | integer |
advancedConfiguration | object |
updateRule | object |
Responses
Request samples
- Payload
- CURL
{- "activationCode": "string",
- "serial": "string",
- "createDeviceIfSerialNotFound": true,
- "customerId": 0,
- "deviceName": "string",
- "deviceGroupId": "string",
- "contentId": "string",
- "emergencyContentId": "string",
- "licenseOrderId": 0,
- "migrateFromDeviceId": "string",
- "deleteMigratedDevice": true,
- "resourceCreationTeamAssignParams": {
- "resourceTeamAssigns": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "teamIds": [
- "string"
]
}, - "showName": false,
- "showConsole": false,
- "showDeviceInfo": false,
- "showStateIndicator": true,
- "datasourceId": "string",
- "daraRowId": "string",
- "sensorConfig": "string",
- "weatherLocation": "string",
- "timeZone": "string",
- "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"
}, - "tags": [
- "string"
], - "emergencyStatus": false,
- "updateVersionUpperLimit": "string",
- "rebootTime": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "advancedConfiguration": { },
- "updateRule": { }
}
Response samples
- 200
{- "id": "string",
- "address": "string",
- "assignDate": 1683802510,
- "comment": "string",
- "nextContentDate": 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
}
}, - "deviceStatus": "ONLINE",
- "lastDeviceStatusChange": 1683802510,
- "emergencyStatus": true,
- "enabledConsole": true,
- "enabledName": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "isOutdated": true,
- "installDate": 1683802510,
- "licenseType": "BASIC",
- "name": "string",
- "dataRowId": "string",
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "location": "string",
- "tags": [
- "string"
], - "activationCode": "string",
- "migrationNotes": "string",
- "type": "TABLET",
- "platform": "ANDROID",
- "upTime": 0,
- "rebootTime": 1683802510,
- "weatherLocation": "string",
- "serial": "string",
- "hardwareId": "string",
- "version": "string",
- "firmwareVersion": "string",
- "networkInterfaceType": "string",
- "osVersion": "string",
- "webViewVersion": "string",
- "nativeResolutionWidth": 0,
- "nativeResolutionHeight": 0,
- "webResolutionWidth": 0,
- "webResolutionHeight": 0,
- "macAddress": "string",
- "localIpAddress": "string",
- "model": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "displayStatus": "ON",
- "locked": true,
- "timeZone": "string",
- "nextSyncTime": 1683802510,
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "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"
}
]
}, - "advancedConfiguration": { },
- "updateRule": { },
- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "content": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "contentId": "string",
- "contentType": "string",
- "nextContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "nextContentId": "string",
- "emergencyContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "emergencyContentId": "string",
- "emergencyContentType": "string",
- "deviceGroup": {
- "id": "string",
- "comment": "string",
- "name": "string",
- "location": "string",
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "tags": [
- "string"
], - "children": [
- { }
], - "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "parent": { },
- "parentId": "string",
- "devices": [
- { }
], - "readOnly": true
}, - "deviceGroupId": "string",
- "datasourceId": "string",
- "licenseOrder": {
- "id": 0,
- "orderDate": 1683802510,
- "createDate": 1683802510,
- "deviceLicenseCount": 0,
- "pricePerDevice": 0,
- "currency": "string",
- "comment": "string",
- "approved": true,
- "approveDate": 1683802510,
- "invoiceStartDate": 1683802510,
- "poNumber": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "licensePackage": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "licenseType": "BASIC",
- "licensePayType": "SUBSCRIPTION",
- "pricePerDevice": 0,
- "currency": "string",
- "recurrence": {
- "frequency": 0,
- "recurrenceType": "DAILY"
}, - "createdAt": 1683802510,
- "modifiedAt": 1683802510,
- "isPublic": true,
- "isPriceVisible": true,
- "orderCount": 0,
- "deviceCount": 0,
- "globalLicenseLimit": 0,
- "reservedLicenses": 0,
- "available": 0,
- "approvedLicenses": 0
}, - "licensePackageId": 0,
- "approvedByUser": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "approvedByUserId": "string",
- "soldByUser": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "soldByUserId": "string",
- "soldBySubreseller": {
- "id": 0
}, - "assignedDeviceCount": 0
}, - "slave": {
- "id": "string",
- "name": "string",
- "address": "string",
- "comment": "string",
- "url": "string",
- "lowWatermark": 0,
- "highWatermark": 0,
- "isPrivate": true,
- "deviceCount": 0,
- "onlineDeviceCount": 0,
- "customerCount": 0,
- "browserSessionCount": 0
}, - "slaveId": "string",
- "preview": "string",
- "packageName": "string",
- "readOnly": true
}
Move device to device group
This endpoint is used to move devices and device groups into device group.
Request Body schema: application/jsonrequired
deviceIds | Array of strings |
groupIds | Array of strings |
targetGroupId | string |
Responses
Request samples
- Payload
- CURL
{- "deviceIds": [
- "string"
], - "groupIds": [
- "string"
], - "targetGroupId": "string"
}
Set data row
This endpoint is used to set device 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
This endpoint is used to remove device 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
This endpoint is used to set device 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
This endpoint is used to remove device 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 reboot time
This endpoint is used to set device 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
This endpoint is used to remove device 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 advanced configuration
This endpoint is used to set device 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
This endpoint is used to set device 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 rotation
This endpoint is used to set rotation of device.
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
This endpoint is used to set brightness of device.
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
This endpoint is used to set volume of device.
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
This endpoint is used to set time zone of device.
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
This endpoint is used to set weather location of device.
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
This endpoint is used to set working hours of device.
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 Enum: "DEVICE" "SCREEN" |
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 update version upper limit
This endpoint is used to set upper limit of device update version.
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
This endpoint is used to set sensor configuration for device.
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
This endpoint is used to reset device sensor configuration.
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
This endpoint is used to turn display on and off.
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
This endpoint is used to turn emergency on and off.
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
This endpoint is used to turn lock on and off.
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
This endpoint is used to show and hide 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
This endpoint is used to show and hide 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
This endpoint is used to show and hide name of device.
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
This endpoint is used to show and hide state indicator of device.
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
This endpoint is used to set toast message on device.
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
This endpoint is used to send command to device.
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
This endpoint is used to 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
This endpoint is used to 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
This endpoint is used to 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
This endpoint is used to 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
This endpoint is used to start recovery on 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/startRecovery?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Start settings
This endpoint is used to start settings on 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/startSettings?customerId=182&applyOn=DEVICE&search=id=f229806904154d8abe67f42629d0c1bb'
Load page
This endpoint is used to load page on device.
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
This endpoint is used to request log of device.
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
This endpoint is used to install application on device.
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
This endpoint is used to take high resolution preview of device.
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
This endpoint is used to turn on rapid preview mode on device.
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
This endpoint is used to set preview content on device.
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
This endpoint is used to set preview template on device.
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
This endpoint is used to 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
This endpoint is used to refresh content on device.
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
This endpoint is used to cache content on device.
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
This endpoint is used to cache content files on device.
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
This endpoint is used to clear cache of device.
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
This endpoint is used to 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
This endpoint is used to set location image for device.
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"
}
]
}
Delete location image
This endpoint is used to remove location image of device.
path Parameters
deviceId required | integer |
fileName required | string |
Responses
Request samples
- CURL
curl -X DELETE \ '{{server_root}}/api/v2/device/534/locationImage?fileName=kep.jpg'
Response samples
- 200
{- "content": [ ]
}
Get location image
This endpoint is used to retrieve device location image.
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 (customerId) |
deviceGroupSearch | string |
deviceSearch | string |
quickFilterId | string |
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/v2/device/view/summary'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "address": "string",
- "assignDate": 1683802510,
- "comment": "string",
- "nextContentDate": 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
}
}, - "deviceStatus": "ONLINE",
- "lastDeviceStatusChange": 1683802510,
- "emergencyStatus": true,
- "enabledConsole": true,
- "enabledName": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "isOutdated": true,
- "installDate": 1683802510,
- "licenseType": "BASIC",
- "name": "string",
- "dataRowId": "string",
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "location": "string",
- "tags": [
- "string"
], - "activationCode": "string",
- "migrationNotes": "string",
- "type": "TABLET",
- "platform": "ANDROID",
- "upTime": 0,
- "rebootTime": 1683802510,
- "weatherLocation": "string",
- "serial": "string",
- "hardwareId": "string",
- "version": "string",
- "firmwareVersion": "string",
- "networkInterfaceType": "string",
- "osVersion": "string",
- "webViewVersion": "string",
- "nativeResolutionWidth": 0,
- "nativeResolutionHeight": 0,
- "webResolutionWidth": 0,
- "webResolutionHeight": 0,
- "macAddress": "string",
- "localIpAddress": "string",
- "model": "string",
- "volumeLevel": 0,
- "brightnessLevel": 0,
- "displayStatus": "ON",
- "locked": true,
- "timeZone": "string",
- "nextSyncTime": 1683802510,
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "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"
}
]
}, - "advancedConfiguration": { },
- "updateRule": { },
- "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "content": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "contentId": "string",
- "contentType": "string",
- "nextContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "nextContentId": "string",
- "emergencyContent": {
- "id": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "lastSavedBy": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "lastSavedByEmail": "string",
- "name": "string",
- "shortUrl": "string",
- "data": { },
- "preview": "string",
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "deviceContentType": "string",
- "customerId": 0,
- "contentGroupId": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "advancedConfiguration": { },
- "assigned": true,
- "assignedAsNext": true,
- "assignedAsEmergency": true,
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "readOnly": true,
- "fileName": "string",
- "pagePreviewPrefix": "string",
- "previewFileName": "string",
- "tempFileName": "string",
- "tempLocation": "string",
- "location": "string",
- "previewLocation": "string"
}, - "emergencyContentId": "string",
- "emergencyContentType": "string",
- "deviceGroup": {
- "id": "string",
- "comment": "string",
- "name": "string",
- "location": "string",
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "tags": [
- "string"
], - "children": [
- { }
], - "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "parent": { },
- "parentId": "string",
- "devices": [
- { }
], - "readOnly": true
}, - "deviceGroupId": "string",
- "datasourceId": "string",
- "licenseOrder": {
- "id": 0,
- "orderDate": 1683802510,
- "createDate": 1683802510,
- "deviceLicenseCount": 0,
- "pricePerDevice": 0,
- "currency": "string",
- "comment": "string",
- "approved": true,
- "approveDate": 1683802510,
- "invoiceStartDate": 1683802510,
- "poNumber": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "licensePackage": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "licenseType": "BASIC",
- "licensePayType": "SUBSCRIPTION",
- "pricePerDevice": 0,
- "currency": "string",
- "recurrence": {
- "frequency": 0,
- "recurrenceType": "DAILY"
}, - "createdAt": 1683802510,
- "modifiedAt": 1683802510,
- "isPublic": true,
- "isPriceVisible": true,
- "orderCount": 0,
- "deviceCount": 0,
- "globalLicenseLimit": 0,
- "reservedLicenses": 0,
- "available": 0,
- "approvedLicenses": 0
}, - "licensePackageId": 0,
- "approvedByUser": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "approvedByUserId": "string",
- "soldByUser": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "soldByUserId": "string",
- "soldBySubreseller": {
- "id": 0
}, - "assignedDeviceCount": 0
}, - "slave": {
- "id": "string",
- "name": "string",
- "address": "string",
- "comment": "string",
- "url": "string",
- "lowWatermark": 0,
- "highWatermark": 0,
- "isPrivate": true,
- "deviceCount": 0,
- "onlineDeviceCount": 0,
- "customerCount": 0,
- "browserSessionCount": 0
}, - "slaveId": "string",
- "preview": "string",
- "packageName": "string",
- "readOnly": true
}
]
}
Get devices
This endpoint is used to retrieve device data.
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/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,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "address": "string",
- "assignDate": 1683802510,
- "comment": "string",
- "nextContentDate": 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
}
}, - "deviceStatus": "ONLINE",
- "lastDeviceStatusChange": 1683802510,
- "emergencyStatus": true,
- "enabledConsole": true,
- "enabledName": true,
- "showDeviceInfo": true,
- "showStateIndicator": true,
- "installDate": 1683802510,
- "commissioningDate": 1683802510,
- "replacementDate": 1683802510,
- "lastActivity": 1683802510,
- "licenseType": "BASIC",
- "name": "string",
- "dataRowId": "string",
- "sensorConfig": "string",
- "updateVersionUpperLimit": "string",
- "location": "string",
- "tags": [
- "string"
], - "activationCode": "string",
- "migrationNotes": "string",
- "type": "TABLET",
- "platform": "ANDROID",
- "upTime": 0,
- "rebootTime": 1683802510,
- "weatherLocation": "string",
- "serial": "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,
- "displayStatus": "ON",
- "locked": true,
- "timeZone": "string",
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "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"
}
]
}, - "advancedConfiguration": { },
- "updateRule": { },
- "customerId": 0,
- "contentId": "string",
- "contentType": "string",
- "nextContentId": "string",
- "emergencyContentId": "string",
- "emergencyContentType": "string",
- "deviceGroupId": "string",
- "deviceGroupPath": "string",
- "datasourceId": "string",
- "licenseOrderId": 0,
- "slaveId": "string",
- "isOutDated": true,
- "model": "string",
- "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",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": 1683802510,
- "lastDeviceActivity": 1683802510,
- "totalLicenses": 0,
- "subreseller": {
- "id": 0
}, - "owner": {
- "id": 0
}
}, - "slave": {
- "id": "string",
- "name": "string",
- "address": "string",
- "comment": "string",
- "url": "string",
- "lowWatermark": 0,
- "highWatermark": 0,
- "isPrivate": true,
- "deviceCount": 0,
- "onlineDeviceCount": 0,
- "customerCount": 0,
- "browserSessionCount": 0
}, - "deviceGroup": {
- "id": "string",
- "comment": "string",
- "customerId": 0,
- "name": "string",
- "updateVersionUpperLimit": "string",
- "parentId": "string",
- "deviceGroupPath": "string",
- "location": "string",
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "tags": [
- "string"
], - "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { },
- "alertCount": 0,
- "readOnly": true
}, - "content": {
- "id": "string",
- "name": "string",
- "width": 0,
- "height": 0
}, - "emergencyContent": {
- "id": "string",
- "name": "string",
- "width": 0,
- "height": 0
}, - "packageName": "string",
- "nativeOrientation": "string",
- "webViewOrientation": "string",
- "alerts": [
- {
- "id": 0,
- "createdAtDate": 1683802510,
- "alertRuleId": 0,
- "alertRuleName": "string",
- "customerId": 0
}
], - "previewPath": "string",
- "readOnly": true
}
]
}
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 (customerId) |
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": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "customerId": 0,
- "contentGroupId": "string",
- "tags": [
- "string"
], - "contentGroupPath": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "deviceContentType": "string",
- "width": 0,
- "height": 0,
- "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",
- "orientation": "string",
- "readOnly": true,
- "shortUrl": "string",
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "campaignUsageDetails": {
- "campaigns": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "messageUsageDetails": {
- "messages": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "contentMetaData": { }
}
]
}
Set file validity
This endpoint is used to set the validity of the file.
path Parameters
fileId required | string |
query Parameters
customerId | integer (customerId) |
validFrom | integer |
validTo | integer |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/file/9d1db619f8364d5cb18c3853cb69c056/setValidity'
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Add file tag
This endpoint is used to add file tag.
path Parameters
fileId required | string |
query Parameters
customerId | integer (customerId) |
tag required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/file/9d1db619f8364d5cb18c3853cb69c056/addTag?customerId=182&tag=fileTag1'
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Set file tags
This endpoint is used to set file tags.
path Parameters
fileId required | string |
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
- CURL
[- "string"
]
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Remove file tag
This endpoint is used to remove file tag.
path Parameters
fileId required | string |
query Parameters
customerId | integer (customerId) |
tag required | string |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/file/9d1db619f8364d5cb18c3853cb69c056/removeTag?customerId=182&tag=fileTag1'
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Update file team assignments
This endpoint is used to update file team assignments.
query Parameters
customerId | integer (customerId) |
fileId required | string |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "removeFromTeamIds": [
- "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 file
This endpoint is used to retrieve file data.
query Parameters
customerId | integer (customerId) |
contentType | string Enum: "video/" "image/" "audio/" "font/" "json" "application/pdf" |
folderId | string |
folderPath | string |
recursively | boolean |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/?customerId=182&contentType=image%2F&folderId=9d1db619f8364d5cb18c3853cb69c056&folderPath=%2Fapi%2Fstorage%2Fcustomer%2F182%2Ffiles%2F9d1db619f8364d5cb18c3853cb69c056&recursively=true'
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Get files V2
This endpoint is used to retrieve file 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/v2/file?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "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",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "creator": {
- "email": "string",
- "name": "string",
- "iconUrl": "string"
}, - "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "readOnly": true,
- "location": "string",
- "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "orientation": "string",
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}
}
]
}
Get files 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) |
search | string (search)
|
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/simple?customerId=182&includeReadOnlyInfo=true'
Response samples
- 200
{- "content": [
- {
- "id": "string",
- "name": "string",
- "fileFolderId": "string"
}
]
}
Get files 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) |
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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/simplePaged?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "fileFolderId": "string"
}
]
}
Search file
This endpoint is used to retrieve file data.
query Parameters
customerId | integer (customerId) |
fillDuplicateDetails | boolean |
search | string (search)
|
page | integer (page) Default: 0 Page index |
size | integer (size) Default: 20 Size of page |
sort | string (sort) Sort expression |
required | object |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/search?customerId=182&fillDuplicateDetails=true&page=0&size=1&sort=string&attributeNames=string'
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Get file usage details
This endpoint is used to retrieve file storage usage details.
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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/usageDetails'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}
]
}
Get file storage statistics
This endpoint is used to retrieve file storage statistics.
query Parameters
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/storageStat'
Response samples
- 200
{- "totalAvailableStorageSize": 0,
- "totalUsedStorageSize": 0,
- "usedDatasourceResourceStorageSize": 0,
- "usedUploadedFileStorageSize": 0
}
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",
- "fileManagerPath": "string",
- "storagePathInternal": "string"
}
]
Get summary of files
This endpoint is used to retrieve summary of files.
query Parameters
customerId | integer (customerId) |
folderSearch | string |
fileSearch | string |
quickFilterId | string |
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/file/view/summary?customerId=182&folderSearch=ff7e939254dc49128bb847fa1b9c00d5&page=0&size=1&sort=string'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "contentType": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "tags": [
- "string"
], - "customerId": 0,
- "creator": {
- "email": "string",
- "name": "string",
- "iconUrl": "string"
}, - "previewPath": "string",
- "location": "string",
- "entityType": "FILE",
- "isGoogleFileSelector": true,
- "isOneDriveFileSelector": true,
- "readOnly": true
}, - {
- "id": "string",
- "name": "string",
- "fileFolderType": 0,
- "cleanupOutdatedFiles": true,
- "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "googleCredentialId": "string",
- "microsoftTenantId": "string",
- "isRootSyncedFolder": true,
- "isSyncedGoogleFolder": true,
- "isSyncedOneDriveFolder": true,
- "quickFilterId": "string",
- "readOnly": true,
- "entityType": "FILE_FOLDER"
}
]
}
Get all files by quick filter
This endpoint is used to retrieve file data by quick filter.
path Parameters
quickFilterId required | string |
query Parameters
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/file/getAllByQuickFilter/9624eb247dbb450aa731681df8415747?customerId=182'
Response samples
- 200
[- {
- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
]
Get files by quick filter
This endpoint is used to retrieve file data by quick filter.
path Parameters
quickFilterId required | string |
query Parameters
customerId | integer (customerId) |
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/file/getPagedByQuickFilter/9624eb247dbb450aa731681df8415747?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
]
}
Update file
This endpoint is used to update file.
path Parameters
fileId required | string |
Request Body schema: application/jsonrequired
name | string |
validFrom | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
validTo | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
tags | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "tags": [
- "string"
]
}
Response samples
- 200
{- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "width": 0,
- "height": 0,
- "tags": [
- "string"
], - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "use2FA": true,
- "restricted": true,
- "hasProfilePicture": true,
- "hiddenUIElementRules": "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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "userInterfaceProfileId": 0,
- "regionalFormatSettings": { },
- "ownerCanAccessNetworkMember": true,
- "storageIdentifier": "string",
- "resetUserInterfaceProfile": true,
- "profilePictureApiPath": "string",
- "readOnly": true,
- "active": true,
- "pinCodePresent": true
}, - "createDate": 1683802510,
- "creatorEmail": "string",
- "crcCheckSum": "string",
- "customerId": 0,
- "fileFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "cloudStorageId": "string",
- "cloudFolderId": "string",
- "syncType": "GOOGLE_DRIVE",
- "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { }
}, - "fileFolderId": "string",
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "fileMutabilityType": "DYNAMIC",
- "validFrom": 1683802510,
- "validTo": 1683802510,
- "usageDetails": {
- "fileId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "duplicateDetails": {
- "files": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "readOnly": true,
- "location": "string"
}
Create file folder
This endpoint is used to create file folder.
query Parameters
customerId | integer (customerId) |
parentId required | string |
name required | string |
inheritParentTeams | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/fileFolder/?customerId=182&parentId=ff7e939254dc49128bb847fa1b9c00d5&name=fileFolder1&inheritParentTeams=true'
Response samples
- 200
{- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "lastStartPageToken": "string",
- "fileTypes": [
- "IMAGE"
], - "googleFolderId": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "driveId": "string",
- "validFromColumnName": "string",
- "validToColumnName": "string",
- "lastDeltaToken": "string",
- "fileTypes": [
- "IMAGE"
], - "oneDriveFolderId": "string"
}, - "cloudStorageId": "string",
- "cloudFolderId": "string",
- "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "syncType": "GOOGLE_DRIVE"
}
Create filtered file folder
This endpoint is used to create filtered file folder.
query Parameters
customerId | integer (customerId) |
parentId required | string |
name required | string |
quickFilterId required | string |
inheritParentTeams | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/fileFolder/addFilteredFileFolder?customerId=182&parentId=ff7e939254dc49128bb847fa1b9c00d5&name=fileFolder1&quickFilterId=af0d948d59144d61a67e677b509dec49&inheritParentTeams=true'
Response samples
- 200
{- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "quickFilterId": "string"
}
Add synced google drive folder
This endpoint is used to add synced google drive folder.
query Parameters
customerId | integer (customerId) |
parentId required | string |
name required | string |
inheritParentTeams | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/fileFolder/addSyncedGoogleDriveFolder?customerId=182&parentId=ff7e939254dc49128bb847fa1b9c00d5&name=fileFolder1&inheritParentTeams=true'
Response samples
- 200
{- "googleCredentialId": "string",
- "googleFolderId": "string",
- "autoSync": true,
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "fileTypes": [
- "IMAGE"
]
}
Add synced one drive folder
This endpoint is used to add synced one drive folder.
query Parameters
customerId | integer (customerId) |
parentId required | string |
name required | string |
inheritParentTeams | boolean |
Responses
Request samples
- CURL
curl -X POST \ '{{server_root}}/api/fileFolder/addSyncedOneDriveFolder?customerId=182&parentId=ff7e939254dc49128bb847fa1b9c00d5&name=fileFolder1&inheritParentTeams=true'
Response samples
- 200
{- "microsoftTenantId": "string",
- "driveId": "string",
- "oneDriveFolderId": "string",
- "autoSync": true,
- "ignoredSubfolderIds": [
- "string"
], - "validFromColumnName": "string",
- "validToColumnName": "string",
- "syncMode": "DOWNLOAD_ONCE",
- "fileTypes": [
- "IMAGE"
]
}
Move batch to file folder
This endpoint is used to move files and file folders to file folder.
query Parameters
customerId | integer (customerId) |
inheritParentTeams | boolean |
Request Body schema: application/jsonrequired
fileIds | Array of strings |
folderIds | Array of strings |
object (storedFileFolder) |
Responses
Request samples
- Payload
- CURL
{- "fileIds": [
- "string"
], - "folderIds": [
- "string"
], - "targetFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "lastStartPageToken": "string",
- "fileTypes": [
- "IMAGE"
], - "googleFolderId": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "driveId": "string",
- "validFromColumnName": "string",
- "validToColumnName": "string",
- "lastDeltaToken": "string",
- "fileTypes": [
- "IMAGE"
], - "oneDriveFolderId": "string"
}, - "cloudStorageId": "string",
- "cloudFolderId": "string",
- "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "syncType": "GOOGLE_DRIVE"
}
}
Response samples
- 200
{- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true
}
Remove batch from file folder
This endpoint is used to remove files and file folders from file folder.
query Parameters
customerId | integer (customerId) |
Request Body schema: application/jsonrequired
fileIds | Array of strings |
folderIds | Array of strings |
object (storedFileFolder) |
Responses
Request samples
- Payload
- CURL
{- "fileIds": [
- "string"
], - "folderIds": [
- "string"
], - "targetFolder": {
- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "lastStartPageToken": "string",
- "fileTypes": [
- "IMAGE"
], - "googleFolderId": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "driveId": "string",
- "validFromColumnName": "string",
- "validToColumnName": "string",
- "lastDeltaToken": "string",
- "fileTypes": [
- "IMAGE"
], - "oneDriveFolderId": "string"
}, - "cloudStorageId": "string",
- "cloudFolderId": "string",
- "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "syncErrorCounter": 0,
- "nextRefreshTime": 1683802510,
- "cleanupOutdatedFiles": true,
- "syncType": "GOOGLE_DRIVE"
}
}
Update file folder team assignments
This endpoint is used to update file folder team assignments.
query Parameters
customerId | integer (customerId) |
fileFolderId required | string |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "removeFromTeamIds": [
- "string"
]
}
Get file folders 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) |
search | string (search)
|
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/fileFolder/simple?customerId=182&includeReadOnlyInfo=true'
Response samples
- 200
{- "content": [
- {
- "id": "string",
- "name": "string",
- "fileFolderId": "string"
}
]
}
Get file folders 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) |
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 |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/fileFolder/simplePaged?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "fileFolderId": "string"
}
]
}
Get file folder content
This endpoint is used to retrieve file folder content data.
query Parameters
folderId | string |
customerId | integer (customerId) |
contentType | string Enum: "video/" "image/" "audio/" "font/" "json" "application/pdf" |
nameKeyword | string |
searchFiles | string |
searchFolders | string |
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/fileFolder/folderContent?customerId=182&folderId=ff7e939254dc49128bb847fa1b9c00d5'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "baseFolder": {
- "id": "string",
- "name": "string",
- "parentId": "string",
- "type": "storedFileFolder",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "lastStartPageToken": "string",
- "fileTypes": [
- "IMAGE"
], - "googleFolderId": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderStoredDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "driveId": "string",
- "validFromColumnName": "string",
- "validToColumnName": "string",
- "lastDeltaToken": "string",
- "fileTypes": [
- "IMAGE"
], - "oneDriveFolderId": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "cleanupOutdatedFiles": true,
- "synced": true
}, - "fileFolders": [
- {
- "id": "string",
- "name": "string",
- "parentId": "string",
- "type": "storedFileFolder",
- "fileFolderType": 0,
- "readOnly": true,
- "googleCredentialId": "string",
- "googleDriveFolderDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "lastStartPageToken": "string",
- "fileTypes": [
- "IMAGE"
], - "googleFolderId": "string"
}, - "microsoftTenantId": "string",
- "oneDriveFolderStoredDetails": {
- "ignoredSubfolderIds": [
- "string"
], - "syncMode": "DOWNLOAD_ONCE",
- "driveId": "string",
- "validFromColumnName": "string",
- "validToColumnName": "string",
- "lastDeltaToken": "string",
- "fileTypes": [
- "IMAGE"
], - "oneDriveFolderId": "string"
}, - "autoSync": true,
- "lastSync": 1683802510,
- "lastChange": 1683802510,
- "lastError": 1683802510,
- "cleanupOutdatedFiles": true,
- "synced": true
}
], - "files": [
- {
- "id": "string",
- "contentType": "string",
- "name": "string",
- "size": 0,
- "creator": {
- "email": "string",
- "name": "string"
}, - "location": "string",
- "tags": [
- "string"
], - "type": "file",
- "customerId": 0,
- "googleDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "md5Checksum": "string",
- "modifiedTime": "string"
}, - "oneDriveFileDetails": {
- "id": "string",
- "name": "string",
- "createdTime": 1683802510,
- "mimeType": "string",
- "etag": "string"
}, - "validFrom": 1683802510,
- "validTo": 1683802510,
- "readOnly": true
}
]
}
Get file folders by folder path
This endpoint is used to retrieve file folders by folder path.
query Parameters
folderPath | string |
customerId | integer (customerId) |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/fileFolder/folderByFolderPath?folderPath=%2Fapi%2Fstorage%2Fcustomer%2F182%2FfileFolders%2F9d1db619f8364d5cb18c3853cb69c056&customerId=182'
Response samples
- 200
{- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true
}
Get file folder
This endpoint is used to retrieve file folder data.
path Parameters
folderId required | string |
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/fileFolder/ff7e939254dc49128bb847fa1b9c00d5'
Response samples
- 200
{- "id": "string",
- "name": "string",
- "customerId": 0,
- "parentId": "string",
- "fileFolderType": 0,
- "readOnly": true
}
Set automatic synchronization
This endpoint is used to set automatic synchronization for file folder.
query Parameters
folderId required | string |
autoSync required | boolean |
Responses
Request samples
- CURL
curl -X PUT \ '{{server_root}}/api/fileFolder/setAutoSync?folderId=ff7e939254dc49128bb847fa1b9c00d5&autoSync=true'
Set cleanup outdated files
This endpoint is used to set cleanup outdated files for file folder.
query Parameters
folderId required | string |
cleanupOutdatedFiles required | boolean |
Responses
Request samples
- CURL
curl -X PUT \ '{{server_root}}/api/fileFolder/setCleanupOutdatedFiles?folderId=ff7e939254dc49128bb847fa1b9c00d5&cleanupOutdatedFiles=true'
Set validity column names
This endpoint is used to set column names for validity of file folder.
query Parameters
folderId required | string |
validFromColumnName | string |
validToColumnName | string |
Responses
Request samples
- CURL
curl -X PUT \ '{{server_root}}/api/fileFolder/setValidityColumnNames?folderId=ff7e939254dc49128bb847fa1b9c00d5&validFromColumnName=from&validToColumnName=to'
Update one drive folder
This endpoint is used to update synchronized one drive folder.
query Parameters
customerId | integer (customerId) |
folderId required | string |
Request Body schema: application/jsonrequired
syncMode | string Enum: "DOWNLOAD_ONCE" "REPLACE_ON_CHANGE" "UPDATE_FILE_CONTENT_ON_CHANGE" |
fileTypes | Array of strings Items Enum: "SHEET" "DOCX" "PPTX" "IMAGE" "VIDEO" "AUDIO" "FONT" "PDF" |
Responses
Request samples
- Payload
- CURL
{- "syncMode": "DOWNLOAD_ONCE",
- "fileTypes": [
- "SHEET"
]
}
Update google drive folder
This endpoint is used to update synchronized google drive folder.
query Parameters
customerId | integer (customerId) |
folderId required | string |
Request Body schema: application/jsonrequired
syncMode | string Enum: "DOWNLOAD_ONCE" "REPLACE_ON_CHANGE" "UPDATE_FILE_CONTENT_ON_CHANGE" |
fileTypes | Array of strings Items Enum: "IMAGE" "VIDEO" "SHEET" "AUDIO" "PDF" "FONT" "GOOGLE_DOC" "SLIDE" |
Responses
Request samples
- Payload
- CURL
{- "syncMode": "DOWNLOAD_ONCE",
- "fileTypes": [
- "IMAGE"
]
}
Get quick filter
This endpoint is used to retrieve quick filter 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/v2/quickFilter/?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": "string",
- "name": "string",
- "filteredEntityType": "FILE",
- "criteria": {
- "type": "FILE",
- "search": "string",
- "searchRecursively": true,
- "name": "string",
- "tags": [
- "string"
], - "validFileOnly": true,
- "undefinedValidityValid": true
}, - "customer": {
- "id": 0,
- "name": "string"
}, - "customerId": 0,
- "readOnly": true,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}
}
]
}
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": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "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> |
duration | integer |
defaultDuration | integer Default duration for media items without length (images). |
weight | integer This is the priority of the campaign. Priority increases as the number decreases. |
contentShuffleMode | string (campaignContentShuffleMode) 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 (workingTime) | |
object (workingDays) | |
object (workingDateRanges) | |
object (tagCondition) | |
object (tagCondition) | |
object (tagCondition) | |
object (tagCondition) | |
type | string (campaignPlayedAssetType) Enum: "CONTENT" "CONTENT_BY_TAG" "MESSAGE_GROUP" "ASSETS_STATIC" "ASSETS_DYNAMIC" "SIMPLE_LOOP" "SIMPLE_LOOP_BY_TAG" |
orderingMode | string (campaignOrderingMode) Enum: "RANDOM" "ALPHABET" "DEFAULT" |
advertiserId | string |
object (teamAccessList) | |
object (teamAccessList) | |
playMultipleItemsInSinglePlaybackSlot | boolean Default: false |
playAllItemsInSinglePlaybackSlot | boolean Default: true |
playbackSlotDuration | integer |
playbackSlotNumberOfElementsToPlay | integer |
tags | Array of strings (tags) |
object (campaignMessageGroupAssignmentDto) | |
object (campaignDeviceGroupAssignmentDto) | |
object (campaignContentAssignmentDto) | |
object (campaignSimpleLoopAssignmentDto) | |
object (campaignFileFolderAssignmentDto) | |
object (campaignFileAssignmentDto) |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "orderingMode": "RANDOM",
- "advertiserId": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "messageGroupAssignment": {
- "assignments": [
- {
- "messageGroupId": 0
}
], - "removeIds": [
- 0
]
}, - "deviceGroupAssignment": {
- "assignments": [
- {
- "deviceGroupId": "string"
}
], - "removeIds": [
- "string"
]
}, - "contentAssignment": {
- "assignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}, - "simpleLoopAssignment": {
- "assignments": [
- {
- "simpleLoopId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}, - "fileFolderAssignment": {
- "assignments": [
- {
- "fileFolderId": "string"
}
], - "removeIds": [
- "string"
]
}, - "fileAssignment": {
- "assignments": [
- {
- "fileId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "orderingMode": "RANDOM",
- "customerId": 0,
- "advertiserId": "string",
- "affectedScreenCount": 0,
- "creatorEmail": "string",
- "createdDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true
}
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": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "orderingMode": "RANDOM",
- "customerId": 0,
- "advertiserId": "string",
- "affectedScreenCount": 0,
- "creatorEmail": "string",
- "createdDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true
}
]
}
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",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "orderingMode": "RANDOM",
- "customerId": 0,
- "advertiserId": "string",
- "affectedScreenCount": 0,
- "creatorEmail": "string",
- "createdDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true,
- "campaignContentAssignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "campaignSimpleLoopAssignments": [
- {
- "simpleLoopId": "string",
- "weight": 0
}
], - "campaignMessageGroupAssignments": [
- {
- "messageGroupId": 0
}
], - "campaignDeviceGroupAssignments": [
- {
- "deviceGroupId": "string"
}
], - "campaignFileAssignments": [
- {
- "fileId": "string"
}
], - "campaignFileFolderAssignments": [
- {
- "fileFolderId": "string"
}
]
}
Update campaign
path Parameters
campaignId required | integer |
Request Body schema: application/jsonrequired
id | integer |
name | string |
validFrom | string <2024-03-19> |
validTo | string <2024-03-20> |
duration | integer |
defaultDuration | integer Default duration for media items without length (images). |
weight | integer This is the priority of the campaign. Priority increases as the number decreases. |
contentShuffleMode | string (campaignContentShuffleMode) 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 (workingTime) | |
object (workingDays) | |
object (workingDateRanges) | |
object (tagCondition) | |
object (tagCondition) | |
object (tagCondition) | |
object (tagCondition) | |
orderingMode | string (campaignOrderingMode) Enum: "RANDOM" "ALPHABET" "DEFAULT" |
advertiserId | string |
object (campaignMessageGroupAssignmentDto) | |
object (campaignDeviceGroupAssignmentDto) | |
object (campaignContentAssignmentDto) | |
object (campaignSimpleLoopAssignmentDto) | |
object (campaignFileAssignmentDto) | |
object (campaignFileFolderAssignmentDto) | |
resetValidTo | boolean |
resetDuration | boolean |
resetDefaultDuration | boolean |
resetAdvertiserId | boolean |
object (teamAccessList) | |
object (teamAccessList) | |
playMultipleItemsInSinglePlaybackSlot | boolean Default: false |
playAllItemsInSinglePlaybackSlot | boolean Default: true |
playbackSlotDuration | integer |
playbackSlotNumberOfElementsToPlay | integer |
resetPlaybackSlotDuration | boolean |
resetPlaybackSlotNumberOfElementsToPlay | boolean |
tags | Array of strings (tags) |
Responses
Request samples
- Payload
- CURL
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "orderingMode": "RANDOM",
- "advertiserId": "string",
- "messageGroupAssignment": {
- "assignments": [
- {
- "messageGroupId": 0
}
], - "removeIds": [
- 0
]
}, - "deviceGroupAssignment": {
- "assignments": [
- {
- "deviceGroupId": "string"
}
], - "removeIds": [
- "string"
]
}, - "contentAssignment": {
- "assignments": [
- {
- "contentId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}, - "simpleLoopAssignment": {
- "assignments": [
- {
- "simpleLoopId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}, - "fileAssignment": {
- "assignments": [
- {
- "fileId": "string",
- "weight": 0
}
], - "removeIds": [
- "string"
]
}, - "fileFolderAssignment": {
- "assignments": [
- {
- "fileFolderId": "string"
}
], - "removeIds": [
- "string"
]
}, - "resetValidTo": true,
- "resetDuration": true,
- "resetDefaultDuration": true,
- "resetAdvertiserId": true,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "resetPlaybackSlotDuration": true,
- "resetPlaybackSlotNumberOfElementsToPlay": true,
- "tags": [
- "string"
]
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "duration": 0,
- "defaultDuration": 0,
- "weight": 0,
- "contentShuffleMode": "BALANCED",
- "saturation": 0,
- "skipDefaultPage": false,
- "skipInvalidFiles": false,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "contentTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "simpleLoopTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "fileTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "type": "CONTENT",
- "orderingMode": "RANDOM",
- "customerId": 0,
- "advertiserId": "string",
- "affectedScreenCount": 0,
- "creatorEmail": "string",
- "createdDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playedAssetTeamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "playMultipleItemsInSinglePlaybackSlot": false,
- "playAllItemsInSinglePlaybackSlot": true,
- "playbackSlotDuration": 0,
- "playbackSlotNumberOfElementsToPlay": 0,
- "tags": [
- "string"
], - "readOnly": true
}
Update message team assignments
This endpoint is used to update message team assignments.
query Parameters
customerId | integer (customerId) |
messageId required | integer |
Request Body schema: application/jsonrequired
Array of objects | |
removeFromTeamIds | Array of strings |
Responses
Request samples
- Payload
- CURL
{- "assignToTeams": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "removeFromTeamIds": [
- "string"
]
}
Create message
query Parameters
customerId | integer (customerId) |
teamIds | string Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9:true,00a22e86602c4a88914614aa9516a481:false It is mandatory to choose from the own teams if the user belongs to at least one team and have a lower role than owner. |
includeReadOnlyInfo | boolean (includeReadOnlyInfo) Default: false Whether or not the |
Request Body schema: application/jsonrequired
text | string |
validFrom | string |
validTo | string |
object (teamAccessList) | |
type | string (messagePlayedAssetType) Enum: "CONTENT" "ASSETS_STATIC" "ASSETS_DYNAMIC" "TEXT" "SIMPLE_LOOP" |
contentId | string |
simpleLoopId | string |
weight | integer |
skipDefaultPage | boolean |
enabled | boolean |
object (workingTime) | |
object (workingDays) | |
messageGroupId | integer |
name | string |
deviceGroupId | string |
saturation | integer |
tags | Array of strings (tags) |
defaultDuration | integer |
orderingMode | string (campaignOrderingMode) Enum: "RANDOM" "ALPHABET" "DEFAULT" |
object (workingDateRanges) | |
advertiserId | string |
object (messageFileAssignmentDto) | |
object (messageFileFolderAssignmentDto) | |
object (messageDeviceAssignmentDto) | |
object (tagCondition) |
Responses
Request samples
- Payload
- CURL
{- "text": "string",
- "validFrom": "string",
- "validTo": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "type": "CONTENT",
- "contentId": "string",
- "simpleLoopId": "string",
- "weight": 0,
- "skipDefaultPage": true,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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",
- "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "advertiserId": "string",
- "fileAssignment": {
- "assignments": [
- {
- "fileId": "string"
}
], - "removeIds": [
- "string"
]
}, - "fileFolderAssignment": {
- "assignments": [
- {
- "fileFolderId": "string"
}
], - "removeIds": [
- "string"
]
}, - "deviceAssignment": {
- "assignments": [
- {
- "deviceId": "string"
}
], - "removeIds": [
- "string"
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}
}
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": 1683802510,
- "end": 1683802510,
- "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",
- "creatorEmail": "string",
- "createDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "advertiserId": "string",
- "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "readOnly": true,
- "deviceGroupName": "string",
- "contentName": "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 |
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": 1683802510,
- "end": 1683802510,
- "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",
- "creatorEmail": "string",
- "createDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "advertiserId": "string",
- "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "readOnly": true,
- "deviceGroupName": "string",
- "contentName": "string"
}
]
}
Get messages V2
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)
|
Responses
Request samples
- CURL
curl -X GET \ '{{server_root}}/api/v2/message?customerId=182'
Response samples
- 200
{- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0,
- "sort": "string",
- "content": [
- {
- "id": 0,
- "name": "string",
- "validFrom": "string",
- "validTo": "string",
- "weight": 0,
- "saturation": 0,
- "text": "string",
- "skipDefaultPage": true,
- "enabled": true,
- "createdDate": 1683802510,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "type": "CONTENT",
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "contentId": "string",
- "simpleLoopId": "string",
- "messageGroupId": 0,
- "deviceGroupId": "string",
- "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "advertiserId": "string",
- "customerId": 0,
- "creatorEmail": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "content": {
- "id": "string",
- "name": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "customerId": 0,
- "contentGroupId": "string",
- "tags": [
- "string"
], - "contentGroupPath": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "deviceContentType": "string",
- "width": 0,
- "height": 0,
- "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",
- "orientation": "string",
- "readOnly": true,
- "shortUrl": "string",
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "campaignUsageDetails": {
- "campaigns": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "messageUsageDetails": {
- "messages": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "contentMetaData": { },
- "receiverEmail": "string",
- "powerBiDependencies": {
- "dependencies": [
- {
- "id": "string",
- "type": "REPORT"
}
]
}
}, - "simpleLoop": {
- "id": "string",
- "name": "string",
- "comment": "string",
- "lastSaved": 1683802510,
- "customerId": 0,
- "contentGroupId": "string",
- "tags": [
- "string"
], - "contentGroupPath": "string",
- "displayTime": 0,
- "locked": true,
- "startDate": 1683802510,
- "signageModeSecret": "string",
- "signageModeShortUrl": "string",
- "deviceContentType": "string",
- "width": 0,
- "height": 0,
- "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",
- "orientation": "string",
- "readOnly": true,
- "shortUrl": "string",
- "saveInfo": {
- "manual": "string",
- "auto": "string"
}, - "campaignUsageDetails": {
- "campaigns": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "messageUsageDetails": {
- "messages": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "contentMetaData": { }
}, - "messageGroup": {
- "id": 0,
- "name": "string",
- "customerId": 0,
- "readOnly": true,
- "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",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": 1683802510,
- "lastDeviceActivity": 1683802510,
- "totalLicenses": 0,
- "subreseller": {
- "id": 0
}, - "owner": {
- "id": 0
}
}
}, - "deviceGroup": {
- "id": "string",
- "comment": "string",
- "customerId": 0,
- "name": "string",
- "updateVersionUpperLimit": "string",
- "parentId": "string",
- "deviceGroupPath": "string",
- "location": "string",
- "longitude": 0,
- "latitude": 0,
- "zoom": 0,
- "locationMetaData": { },
- "tags": [
- "string"
], - "customer": {
- "id": 0,
- "name": "string"
}, - "parent": { },
- "alertCount": 0,
- "readOnly": true
}, - "advertiser": {
- "id": "string",
- "name": "string",
- "comment": "string",
- "enabled": true,
- "customerId": 0,
- "validity": {
- "fromDate": 1683802510,
- "toDate": 1683802510,
- "cron": "string",
- "timeZone": "string"
}, - "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",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": 1683802510,
- "lastDeviceActivity": 1683802510,
- "totalLicenses": 0,
- "subreseller": {
- "id": 0
}, - "owner": {
- "id": 0
}
}, - "readOnly": true,
- "proofOfPlayAccessSecretConfigured": true
}, - "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",
- "ownerSubresellerId": 0,
- "hiddenUIElementRule": "string",
- "slaveId": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
- "isFileAndFolderCreationEnabledInRootForTeamUsers": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "activeLicenses": 0,
- "totalUserLoginCount": 0,
- "totalUserPresenceTime": 0,
- "lastActivity": 1683802510,
- "lastDeviceActivity": 1683802510,
- "totalLicenses": 0,
- "subreseller": {
- "id": 0
}, - "owner": {
- "id": 0
}
}, - "creator": {
- "email": "string",
- "name": "string",
- "language": "string",
- "phoneNumber": "string",
- "address": "string",
- "comment": "string",
- "iconUrl": "string",
- "lastLogin": 1683802510,
- "createdDate": 1683802510,
- "termsOfServiceAcceptDate": 1683802510,
- "logins": 0,
- "presenceTime": 0,
- "lastActivity": 1683802510,
- "editorLevel": "BASIC",
- "role": "DEVICE_USER",
- "authProvider": "LOCAL",
- "use2FA": true,
- "restricted": true,
- "hiddenUIElementRules": "string",
- "ssoLoginEnabled": true,
- "usernamePasswordLoginEnabled": true,
- "hasProfilePicture": true,
- "regionalFormatSettings": "string",
- "ownerCanAccessNetworkMember": true,
- "pinCodePresent": true,
- "profilePictureApiPath": "string",
- "customer": {
- "id": 0,
- "name": "string"
}, - "customerId": 0,
- "location": {
- "latitude": "string",
- "longitude": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "postal": "string"
}, - "userInterfaceProfile": {
- "id": 0,
- "name": "string",
- "comment": "string",
- "hiddenUIElementRules": "string",
- "customerId": 0
}, - "active": true
}, - "deviceAssignments": [
- {
- "id": "string",
- "name": "string"
}
], - "fileFolderAssignments": [
- {
- "id": "string",
- "name": "string"
}
], - "fileAssignments": [
- {
- "id": "string",
- "name": "string"
}
], - "teamAssignments": [
- {
- "id": "string",
- "name": "string"
}
], - "readOnly": true
}
]
}
Update message
path Parameters
messageId required | integer |
Request Body schema: application/jsonrequired
text | string |
validFrom | string |
validTo | string |
object (teamAccessList) | |
contentId | string |
simpleLoopId | string |
weight | integer |
skipDefaultPage | boolean |
enabled | boolean |
object (workingTime) | |
object (workingDays) | |
name | string |
deviceGroupId | string |
widgetOverrides | object |
resetValidTo | boolean |
saturation | integer |
tags | Array of strings (tags) |
defaultDuration | integer |
orderingMode | string (campaignOrderingMode) Enum: "RANDOM" "ALPHABET" "DEFAULT" |
object (workingDateRanges) | |
advertiserId | string |
resetAdvertiserId | boolean |
object (messageFileAssignmentDto) | |
object (messageFileFolderAssignmentDto) | |
object (messageDeviceAssignmentDto) | |
object (tagCondition) |
Responses
Request samples
- Payload
- CURL
{- "text": "string",
- "validFrom": "string",
- "validTo": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "contentId": "string",
- "simpleLoopId": "string",
- "weight": 0,
- "skipDefaultPage": true,
- "enabled": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}, - "name": "string",
- "deviceGroupId": "string",
- "widgetOverrides": { },
- "resetValidTo": true,
- "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "advertiserId": "string",
- "resetAdvertiserId": true,
- "fileAssignment": {
- "assignments": [
- {
- "fileId": "string"
}
], - "removeIds": [
- "string"
]
}, - "fileFolderAssignment": {
- "assignments": [
- {
- "fileFolderId": "string"
}
], - "removeIds": [
- "string"
]
}, - "deviceAssignment": {
- "assignments": [
- {
- "deviceId": "string"
}
], - "removeIds": [
- "string"
]
}, - "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}
}
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": 1683802510,
- "end": 1683802510,
- "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",
- "creatorEmail": "string",
- "createDate": 1683802510,
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "saturation": 0,
- "tags": [
- "string"
], - "defaultDuration": 0,
- "orderingMode": "RANDOM",
- "affectedDateRanges": {
- "intervals": [
- {
- "from": 1683802510,
- "to": 1683802510,
- "isExcluded": true,
- "affectedHours": {
- "from": 1683802510,
- "end": 1683802510,
- "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
}
}
]
}, - "advertiserId": "string",
- "deviceTagCondition": {
- "tags": [
- "string"
], - "operator": "OR"
}, - "readOnly": true,
- "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 |
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,
- "needToBeInvoiced": true,
- "storageSize": 0,
- "vertical": "BANKING_AND_FINANCE",
- "hiddenUIElementRules": "string",
- "enableAutomaticDistributionToDms": true,
- "userFullAccessIfNotInTeam": true,
- "accessResourcesWithoutTeam": true,
- "brandingGuideline": {
- "colors": [
- {
- "colorCode": "string",
- "name": "string"
}
], - "fonts": [
- {
- "id": "string",
- "name": "string",
- "type": "SYSTEM"
}
]
}, - "subreseller": {
- "id": 0
}, - "ownerSubresellerId": 0,
- "slaveId": "string",
- "onlineLicenses": 0,
- "totalLicenses": 0,
- "usedFree": 0,
- "activeLicenses": 0,
- "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
- "contentAndGroupCreationEnabledInRootForTeamUsers": true,
- "fileAndFolderCreationEnabledInRootForTeamUsers": true,
- "ownerName": "string"
}, - "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",
- "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",
- "screenshotParameters": {
- "screenshotConfigs": [
- {
- "contentId": "string",
- "pageIds": [
- "string"
], - "allPage": true,
- "datasourceId": "string",
- "dataRowId": "string",
- "timeZone": "string",
- "url": "string",
- "width": 0,
- "height": 0,
- "headers": "string",
- "waitTime": 0
}
]
}, - "deactivated": true,
- "systemDatasourceType": "FILES",
- "maxElementCount": 0,
- "datasourceTransformation": {
- "transformation": [
- "string"
]
}, - "quickFilterId": "string",
- "requestSettings": {
- "httpMethod": "GET",
- "customHeaders": "string",
- "basicAuth": {
- "username": "string",
- "password": "string"
}, - "body": "string",
- "jsonBody": true,
- "followRedirects": true
}, - "usedStorage": 0,
- "usageDetails": {
- "datasourceId": "string",
- "contentUsage": [
- {
- "id": "string",
- "name": "string",
- "deviceContentType": "string"
}
]
}, - "readOnly": true
}
]
}
}
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": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "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 |
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 |
targetId | string |
object |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetId": "string",
- "targetData": {
- "targetIds": [
- "string"
]
}
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetData": {
- "targetIds": [
- "string"
]
}, - "targetName": "string",
- "customerId": 0,
- "readOnly": true,
- "targetId": "string"
}
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 |
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": { },
- "targetData": {
- "targetIds": [
- "string"
]
}, - "targetName": "string",
- "customerId": 0,
- "readOnly": true,
- "targetId": "string"
}
]
}
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)
|
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 |
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": { },
- "targetData": {
- "targetIds": [
- "string"
]
}, - "targetName": "string",
- "customerId": 0,
- "readOnly": true,
- "targetId": "string"
}
]
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": { },
- "targetData": {
- "targetIds": [
- "string"
]
}, - "targetName": "string",
- "customerId": 0,
- "readOnly": true,
- "targetId": "string"
}
Update webhook event action
path Parameters
actionId required | integer |
Request Body schema: application/jsonrequired
name | string |
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 |
targetId | string |
object |
Responses
Request samples
- Payload
- CURL
{- "name": "string",
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetId": "string",
- "targetData": {
- "targetIds": [
- "string"
]
}
}
Response samples
- 200
{- "name": "string",
- "id": 0,
- "eventId": "string",
- "enabled": true,
- "action": "ENABLE_EMERGENCY_ON_DEVICE",
- "actionParams": { },
- "targetData": {
- "targetIds": [
- "string"
]
}, - "targetName": "string",
- "customerId": 0,
- "readOnly": true,
- "targetId": "string"
}
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": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "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
id | integer |
token | string |
name | string |
createdAt | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
restricted | boolean |
customerId | integer |
readOnly | boolean |
Responses
Request samples
- Payload
- CURL
{- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "customerId": 0,
- "readOnly": true
}
Response samples
- 200
{- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "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": [
- {
- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "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)
|
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
{- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "customerId": 0,
- "readOnly": true
}
Update webhook api key
path Parameters
id required | string |
Request Body schema: application/jsonrequired
id | integer |
token | string |
name | string |
createdAt | integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp) |
restricted | boolean |
customerId | integer |
readOnly | boolean |
Responses
Request samples
- Payload
- CURL
{- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "customerId": 0,
- "readOnly": true
}
Response samples
- 200
{- "id": 0,
- "token": "string",
- "name": "string",
- "createdAt": 1683802510,
- "restricted": true,
- "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": [
- {
- "teamId": "string",
- "readOnly": true
}
], - "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" |
name | string |
id | integer |
comment | string |
enabled | boolean |
deviceLastActivityAlertRuleCondition (object) or deviceStatusChangedEventAlertRuleCondition (object) or datasourceRefreshErrorCountAlertRuleCondition (object) or metricValueCondition (object) | |
object (alertRuleEvaluate) | |
delayEvaluateAfterViolationMinutes | integer |
scheduledEvaluateSeconds | integer |
object (workingDays) | |
object (workingTime) | |
Array of objects (notificationChannel) | |
version | integer |
dtype | string |
object (teamAccessList) | |
readOnly | boolean |
alertEmailTemplate | string |
evaluateSummaryEmailTemplate | string |
alertSmsTemplate | string |
alertFixedSmsTemplate | string |
Responses
Request samples
- Payload
- CURL
{- "@type": "DeviceOffline",
- "name": "string",
- "id": 0,
- "comment": "string",
- "enabled": true,
- "condition": {
- "inactiveMinutes": 0,
- "deviceGroupId": "string",
- "recursive": true,
- "excludeDeviceIds": [
- "string"
], - "excludeDeviceGroupIds": [
- "string"
], - "tagFilter": {
- "tags": [
- "string"
], - "logicalOperator": "AND",
- "tagFilterType": "INCLUDE"
}
}, - "evaluate": {
- "id": 0,
- "lastEvaluationDate": 1683802510,
- "lastViolationDate": 1683802510,
- "evaluateCount": 0,
- "violationCount": 0
}, - "delayEvaluateAfterViolationMinutes": 0,
- "scheduledEvaluateSeconds": 0,
- "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "from": 1683802510,
- "end": 1683802510,
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "notificationChannels": [
- {
- "name": "string",
- "id": 0,
- "comment": "string",
- "channelType": "EMAIL",
- "notify": [
- "string"
]
}
], - "version": 0,
- "dtype": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "readOnly": true,
- "alertEmailTemplate": "string",
- "evaluateSummaryEmailTemplate": "string",
- "alertSmsTemplate": "string",
- "alertFixedSmsTemplate": "string"
}
Response samples
- 200
{- "@type": "DeviceOffline",
- "name": "string",
- "id": 0,
- "comment": "string",
- "enabled": true,
- "condition": {
- "inactiveMinutes": 0,
- "deviceGroupId": "string",
- "recursive": true,
- "excludeDeviceIds": [
- "string"
], - "excludeDeviceGroupIds": [
- "string"
], - "tagFilter": {
- "tags": [
- "string"
], - "logicalOperator": "AND",
- "tagFilterType": "INCLUDE"
}
}, - "evaluate": {
- "id": 0,
- "lastEvaluationDate": 1683802510,
- "lastViolationDate": 1683802510,
- "evaluateCount": 0,
- "violationCount": 0
}, - "delayEvaluateAfterViolationMinutes": 0,
- "scheduledEvaluateSeconds": 0,
- "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "from": 1683802510,
- "end": 1683802510,
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "notificationChannels": [
- {
- "name": "string",
- "id": 0,
- "comment": "string",
- "channelType": "EMAIL",
- "notify": [
- "string"
]
}
], - "version": 0,
- "dtype": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "readOnly": true,
- "alertEmailTemplate": "string",
- "evaluateSummaryEmailTemplate": "string",
- "alertSmsTemplate": "string",
- "alertFixedSmsTemplate": "string"
}
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 |
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",
- "name": "string",
- "id": 0,
- "comment": "string",
- "enabled": true,
- "condition": {
- "inactiveMinutes": 0,
- "deviceGroupId": "string",
- "recursive": true,
- "excludeDeviceIds": [
- "string"
], - "excludeDeviceGroupIds": [
- "string"
], - "tagFilter": {
- "tags": [
- "string"
], - "logicalOperator": "AND",
- "tagFilterType": "INCLUDE"
}
}, - "evaluate": {
- "id": 0,
- "lastEvaluationDate": 1683802510,
- "lastViolationDate": 1683802510,
- "evaluateCount": 0,
- "violationCount": 0
}, - "delayEvaluateAfterViolationMinutes": 0,
- "scheduledEvaluateSeconds": 0,
- "workingDays": {
- "monday": true,
- "tuesday": true,
- "wednesday": true,
- "thursday": true,
- "friday": true,
- "saturday": true,
- "sunday": true
}, - "workingTime": {
- "from": 1683802510,
- "end": 1683802510,
- "timeZone": "string",
- "allDay": true,
- "allowPartialStartingSegment": true,
- "allowPartialEndingSegment": true,
- "allowDayOfWeekOverflow": true
}, - "notificationChannels": [
- {
- "name": "string",
- "id": 0,
- "comment": "string",
- "channelType": "EMAIL",
- "notify": [
- "string"
]
}
], - "version": 0,
- "dtype": "string",
- "teamAccessList": {
- "teams": [
- {
- "id": "string"
}
]
}, - "readOnly": true,
- "alertEmailTemplate": "string",
- "evaluateSummaryEmailTemplate": "string",
- "alertSmsTemplate": "string",
- "alertFixedSmsTemplate": "string"
}
]
}
Get alert
This endpoint is used to retrieve alert 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 |
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": [
- {
- "id": 0,
- "createdAtDate": 1683802510,
- "alertRuleId": 0,
- "customerId": 0
}
]
}
Get datasource alert
This endpoint is used to retrieve datasource alert 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 |
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": [
- {
- "id": 0,
- "createdAtDate": 1683802510,
- "alertRuleId": 0,
- "alertRuleName": "string",
- "datasourceId": "string",
- "datasourceName": "string",
- "datasourceErrorCounter": 0,
- "datasourceLastError": "string"
}
]
}
Get device alert
This endpoint is used to retrieve device alert 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 |
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": [
- {
- "id": 0,
- "createdAtDate": 1683802510,
- "alertRuleId": 0,
- "alertRuleName": "string",
- "deviceId": "string",
- "deviceName": "string",
- "deviceLastActivity": 1683802510,
- "deviceLastStatusChange": 1683802510,
- "deviceGroupId": "string",
- "deviceGroupPath": "string"
}
]
}
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
{- "id": 0,
- "createdAtDate": 1683802510,
- "alertRuleId": 0,
- "alertRuleName": "string",
- "deviceId": "string",
- "deviceName": "string",
- "deviceLastActivity": 1683802510,
- "deviceLastStatusChange": 1683802510,
- "deviceGroupId": "string",
- "deviceGroupPath": "string"
}
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"
}