Fleet API Specification API Reference
Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage.
The API publishes a swagger specification that can be used to generate a client library for your language of choice.
The latest swagger file is available for download from the following link: https://api.eu1.kt1.io/fleet/v2/swagger.json
European Production Endpoint
https://api.eu1.kt1.io/fleet/v2US Production Endpoint
https://api.us1.kt1.io/fleet/v2UK Production Endpoint
https://api.uk1.kt1.io/fleet/v2Staging Endpoint
https://api.staging.kt1.io/fleet/v2Contact: support@keytelematics.com
Request Content-Types: application/json
Response Content-Types: application/json
Version: 2.75.0
Authentication
Before You Begin
You'll need to have a user account created in the Key Telematics platform before you can use the API. Once you have your credentials, you can proceed to retrieve your access token using the username and password you have been supplied.
Retrieve Access Token
curl --request POST \
--header "Content-Type: application/json" \
--data '{ "username":"api@example.com", "password":"12345678" }' \
https://api.eu1.kt1.io/fleet/v2/auth/signin
You'll receive a user authentication response if your login attempt was successfull:
{
"idToken": "eyJhbGciOiJ...82S-T0zt0TFrS8o",
"accessToken": "eyJhbGciOiJ...SCQRXCsXxFtx1ww",
"refreshToken": "eyJhbGciOiJ...DRvmu83p3q9A8",
"users": [{
"id": "be469ae1-2386-4788-9fcd-260b4435fe51",
"username": "api@example.com",
"name": "API User",
"owner": {
"id": "d4d4627b-f436-4d97-a25d-057d56d23605",
"name": "Example Inc",
"type": "client"
},
"defaultClient": {
"id": "d4d4627b-f436-4d97-a25d-057d56d23605",
"name": "Example Inc"
},
"timeZoneId": "GMT+0",
"language": "en-us"
}]
}
Retreive the accessToken value and use it with a x-access-token header in your future requests. See below.
curl --request POST \
--header "x-access-token:eyJhbGciOiJ...SCQRXCsXxFtx1ww" \
https://api.eu1.kt1.io/fleet/v2/entities/assets?owner=d4d4627b-f436-4d97-a25d-057d56d23605
Refreshing Access Tokens
The accessToken you've received will be valid for 1 hour, and the refreshToken for 30 days. You will need to refresh your token before the 1 hour limit passes. To refresh your token, you can either sign in again when you get an access denied error, or ask for a new token with the refreshTokens operation as follows:
curl --request POST \
--header "x-access-token:eyJhbGciOiJ...SCQRXCsXxFtx1ww" \
--header "Content-Type: application/json" \
--data '{ "refreshToken":"eyJhbGciOiJ...DRvmu83p3q9A8" }' \
https://api.eu1.kt1.io/fleet/v2/auth/refresh
Rate Limits
All requests to the API are rate limited. Should you violate the rate limit your request will fail and the following error will be returned:
{
"status": 429,
"message": "Too many signin attempts, please try again in a few seconds",
"name": "TooManyRequestsError"
}
The rate limits are as follows:
- Authentication Routes: 5 requests in an hour, after which you'll need to wait an hour to try again.
- Get & List routes: 10 requests per second.
- Update & Create routes: 1 request per second.
Soft Limits
Each client, vendor and distributor account has a set of soft limits associated with the number of entities that can be created in total, and also that can be in an active state at any one time.
Should you attempt to create an entity that exceeds a limit, a BadRequestError error will be thrown.
These limits are only in place to prevent accidental over provisioning and can be raised by sending a request to support@keytelematics.com.
You can view the limits for any client, vendor or distributor by examining the limits property of the response returned by getClient, getVendor and getDistributor.
Accounts - Clients
listClients
Retrieve a list of clients for a specified vendor.
The UUID of the vendor you are requesting data for.
An offset into the result set, useful for pagination.
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
A list of entity types to return counts for that belong to this client, comma delimited, i.e. counts=asset,device,simcard. Each additional entity affects the performance of the query and should be used sparingly.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
createClient
Creates a new client entity.
The ClientCreateRequest that contains the required properties for the new entity.
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getClient
Returns client details for the specified UUID.
The UUID of the client.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
updateClient
Updates an existing client entity by patching the existing object with the properties supplied in the ClientUpdateRequest.
The ClientUpdateRequest that contains only the properites that are to be changed on the entity.
The UUID of the client
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getClientByPin
Returns the client ID and name for the specified PIN. PINs are generated by the system and can be retrieved via the pin property on the ClientResponse object retrieved with getClient.
The PIN code of the client.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
updateClientDetails
Updates an existing client account details. Unlike updateClient, this route is available to client users.
undefined
The UUID of the client
Request Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"measurementUnits": {
"distanceUnit": "string",
"altitudeUnit": "string",
"speedUnit": "string",
"areaUnit": "string",
"volumeUnit": "string",
"weightUnit": "string",
"timeUnit": "string",
"dateUnit": "string",
"temperatureUnit": "string"
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getClientLogo
Return the specified client's logo in binary format. Should the client not have a custom logo, the logo of the vendor will be supplied.
The client UUID you are requesting data for.
The size of the returned image. Can be either "small" or "large".
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
updateClientLogo
Updates the specified client's logo.
The client UUID you are requesting data for.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
deleteClientLogo
Permanently deletes a custom client logo. The logo will revert to the client's parent logo.
The client UUID.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
Accounts - Companies
getCompany
Returns company details for the specified id
The UUID of the client
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompanyLogo
Return the specified company's logo in binary format.
The client UUID you are requesting data for.
The size of the returned image. Can be either "small" or "large".
Set recurse to true if you'd like the parent tree to be searched for a logo if none exists for this company.
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
Accounts - CompanyGroups
listCompanyGroups
Retrieve a list of company groups for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
createCompanyGroup
Creates a new company group
undefined
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getCompanyGroup
Returns company group details for the specified id
The UUID of the company group
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateCompanyGroup
Updates an existing company group
undefined
(no description)
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteCompanyGroup
Delete a company group
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Accounts - Distributors
listDistributors
Retrieve a list of distributors for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
A list of entity types to return counts for that belong to this distributor, comma delimited, i.e. counts=vendor,client,asset,device. Each additional entity affects the performance of the query and should be used sparingly.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
createDistributor
Creates a new distributor account
undefined
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getDistributor
Returns distributor details for the specified id
The UUID of the distributor
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
updateDistributor
Updates an existing distributor account
undefined
The UUID of the distributor
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
updateDistributorDetails
Updates an existing distributor account details. Unlike updateDistributor, this route is available to distributor users.
undefined
The UUID of the distributor
Request Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getDistributorLogo
Return the specified distributors's logo in binary format. Should the distributor not have a custom logo, the default Key Telematics logo will be supplied.
The distributor UUID you are requesting data for.
The size of the returned image. Can be either "small" or "large".
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
updateDistributorLogo
Updates the specified distributor's logo.
The distributor UUID you are requesting data for.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
deleteDistributorLogo
Permanently deletes a custom distributor logo. The logo will revert to the Key Telematics logo.
The distributor UUID.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
Accounts - Users
listUsers
Retrieve a list of users for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createUser
Creates a new user
undefined
Request Example
{
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"ownerId": "string",
"password": "string",
"inviteUrl": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"inviteError": {
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
}
getUser
Returns user details for the specified id
The UUID of the user
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateUser
Updates an existing user
undefined
The UUID of the user
Request Example
{
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"password": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getUserPolicies
Returns active security policies for the current user
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"policies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
]
}
resetUser
Optionally suspends the user and sends them a password reset email.
undefined
The UUID of the user
Request Example
{
"resetUrl": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"resetError": {
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
}
getUserAvatar
Return the user avatar in binary format
The UUID of the user
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
updateUserAvatar
Updates the specified user's avatar.
The user UUID you are requesting data for.
No content
Response Content-Types: application/json
deleteUserAvatar
Permanently deletes a user avatar.
The user UUID.
No content
Response Content-Types: application/json
createApiKey
Creates a new API key
undefined
(no description)
Request Example
{
"name": "string",
"policies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"policies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"key": "string"
}
deleteApiKey
Deletes an API key
(no description)
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
deleteOTPMethod
Deletes a previously configured OTP method for a user.
(no description)
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
Accounts - UserRoles
listUserRoles
Retrieve a list of user roles for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"modifiedDate": "string"
}
]
}
createUserRole
Creates a new user role entity
undefined
Request Example
{
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getUserRole
Returns export task details for the specified id
The UUID of the user role
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateUserRole
Updates an existing user role entity
undefined
The UUID of the user role
Request Example
{
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteUserRole
Permanently deletes a user role
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Accounts - Vendors
listVendors
Retrieve a list of vendors for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
A list of entity types to return counts for that belong to this vendor, comma delimited, i.e. counts=client,asset,device. Each additional entity affects the performance of the query and should be used sparingly.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
createVendor
Creates a new vendor account
undefined
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getVendor
Returns vendor details for the specified id
The UUID of the vendor
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
updateVendor
Updates an existing vendor account
undefined
The UUID of the vendor
Request Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
updateVendorDetails
Updates an existing vendor account details. Unlike updateVendor, this route is available to vendor users.
undefined
The UUID of the vendor
Request Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"emailServer": {
"smtpEnabled": "boolean",
"smtpServer": "string",
"smtpPort": "number (double)",
"fromAddress": "string",
"fromName": "string",
"username": "string",
"password": "string",
"enableSsl": "boolean",
"state": "string"
},
"clientGroups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string"
}
}
getVendorLogo
Return the specified vendor's logo in binary format. Should the vendor not have a custom logo, the logo of the distributor will be supplied.
The vendor UUID you are requesting data for.
The size of the returned image. Can be either "small" or "large".
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
updateVendorLogo
Updates the specified vendor's logo.
The vendor UUID you are requesting data for.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
deleteVendorLogo
Permanently deletes a custom vendor logo. The logo will revert to the vendor's parent logo.
The vendor UUID.
The size of the image. Can be either "small" or "large".
No content
Response Content-Types: application/json
Auth
signIn
Authenticate using a username and password
undefined
Request Example
{
"domain": "string",
"username": "string",
"password": "string",
"userId": "string",
"token": "string"
}
Ok
Invalid authentication credentials supplied
Too many sign in attempts
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"users": [
{
"id": "string",
"username": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"timeZoneId": "string",
"language": "string",
"otp": {
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
},
"passwordExpiresOn": "string"
}
]
}
Response Example (401 Unauthorized)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
signOut
Invalidate an active access token
undefined
Request Example
{
"session": "string"
}
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
selectUser
Selects a user from a list that has already been authenticated.
The user id you are requesting an access token for (previously retrieved using the /auth/signin route).
Ok
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"user": {
"id": "string",
"username": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"timeZoneId": "string",
"language": "string",
"otp": {
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
},
"passwordExpiresOn": "string"
}
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
refreshTokens
Refreshes a user's tokens by providing a valid refresh token
undefined
Request Example
{
"refreshToken": "string"
}
Ok
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
resetPassword
Sends a password reset email to the user.
undefined
Request Example
{
"resetUrl": "string",
"username": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
setPassword
Sends a password reset email to the user.
undefined
Request Example
{
"token": "string",
"newPassword": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
changePassword
Changes the currently authenticated user's password.
undefined
Request Example
{
"oldPassword": "string",
"newPassword": "string"
}
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getUserProfile
Retrieves the currently authenticated user's profile
Ok
Invalid auth token supplied
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"sessions": [
{
"id": "string",
"userId": "string",
"start": "string",
"expiry": "string",
"ip": "string",
"hostname": "string",
"agent": "string",
"invalidated": "boolean",
"current": "boolean"
}
]
}
Response Example (401 Unauthorized)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCurrentUserAvatar
Return the current user's avatar in binary format
Ok
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
enrolOTP
Generate a new TOTP secret for the current user
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"secret": "string",
"totpAuthUrl": "string"
}
sendOTP
Generate a new TOTP secret for the current user
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"method": "string",
"destination": "string"
}
verifyOTP
Verify a new TOTP token against the freshly generated user secret. Once successful, this route cannot be called again until TOTP is reset for the user.
undefined
(no description)
Request Example
{
"code": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"otpToken": "string",
"verified": "boolean"
}
validateOTP
Validate a user TOTP token against the user secret
undefined
(no description)
Request Example
{
"code": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"otpToken": "string",
"verified": "boolean"
}
Data - Feeds
getNotificationFeed
Retrieve the notification feed for the current user.
The sequence to continue from.
The direction to run the feed in.
Limit the number of results to this value.
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"sequence": "number (double)",
"eventType": "string",
"text": "string",
"data": {}
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getLocationFeed
Retrieve the current state for all assets for the specified client.
The client id you're requesting data for.
The sequence to continue from.
(no description)
Limit the number of results to this value.
(no description)
(no description)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {},
"meta": {},
"object": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"trip": {
"start": "string",
"startAddress": "string",
"startLon": "number (double)",
"startLat": "number (double)",
"distance": "number (double)",
"lastLon": "number (double)"
}
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getTripFeed
Retrieve a trip feed for the specified asset.
The client id you are requesting data for
The sequence to continue from.
The direction to run the feed in.
Limit the number of results to this value.
(no description)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getEventFeed
Retrieve an event feed for the specified asset.
The client id you are requesting data for
The sequence to continue from.
The direction to run the feed in.
Limit the number of results to this value.
Filter events for this asset only.
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string"
}
]
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getAuditFeedForEntity
Retrieve an audit log feed for the specified client and entity.
The client, vendor or distributor id you are requesting data for
(no description)
The sequence to continue from.
The direction to run the feed in.
Limit the number of results to this value.
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"eventClass": "string",
"eventType": "string",
"changes": [
{
"action": "string",
"field": "string",
"name": "string",
"oldValue": {
"key": "string",
"value": "string"
},
"newValue": {
"key": "string",
"value": "string"
}
}
]
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getAlertFeed
Retrieve an alert feed for the specified asset.
The client id you are requesting data for
The sequence to continue from.
The direction to run the feed in.
Limit the number of results to this value. This function may return slightly more results than requested.
Filter alerts for this asset only.
Filter alerts for this alert only.
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string"
}
]
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
commentAlert
Add a comment to an alert.
undefined
The client id you are requesting data for
The alert id you wish to comment on.
Request Example
{
"comment": "string",
"values": {}
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
],
"details": {}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
acknowledgeAlert
Acknowlege an alert.
undefined
The client id you are requesting data for
The alert id you wish to acknowledge.
Request Example
{
"comment": "string",
"values": {}
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
],
"details": {}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
Data - History
getTelemetryHistory
Retrieve telemetry records between two dates.
The asset id you are requesting data for
The start date (in ISO format)
The end date (in ISO format)
Limit the number of results to this value.
Ok
BadRequestError
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {}
}
]
}
Response Example (400 Bad Request)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getEventHistory
Retrieve event records between two dates.
The asset id you are requesting data for
The start date (in ISO format)
The end date (in ISO format)
Limit the number of results to this value.
Ok
BadRequestError
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string"
}
}
}
]
}
]
}
Response Example (400 Bad Request)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getAlertHistory
Retrieve alert records between two dates.
The client, alert or asset id you are requesting data for
The start date (in ISO format)
The end date (in ISO format)
Limit the number of results to this value.
Ok
BadRequestError
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string"
}
}
}
]
}
]
}
Response Example (400 Bad Request)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getTripHistory
Retrieve trip records between two dates.
The asset id you are requesting data for
The start date (in ISO format)
The end date (in ISO format)
Use the date parameter to find the specific trip that contains this date (start and end are ignored)
Limit the number of results to this value.
Ok
BadRequestError
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
]
}
Response Example (400 Bad Request)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
addTripLabels
Adds one or more labels to a trip.
undefined
The asset id for the trip
The trip start date (in ISO format)
Request Example
{
"labels": [
"string"
]
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
removeTripLabels
Adds one or more labels to a trip.
undefined
The asset id for the trip
The trip start date (in ISO format)
Request Example
{
"labels": [
"string"
]
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
setTripPrivate
Sets a trip to private.
The asset id for the trip
The trip start date (in ISO format)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
clearTripPrivate
Clears the private flag on a trip.
The asset id for the trip
The trip start date (in ISO format)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getLogHistoryForEntity
Restricted route, not available for general usage.
(no description)
(no description)
(no description)
(no description)
(no description)
(no description)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"items": [
{
"level": "string",
"timestamp": "string",
"message": "string"
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
Entities - Alerts
listAlerts
Retrieve a list of alerts for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"modifiedDate": "string"
}
]
}
createAlert
Creates a new Alert
undefined
Request Example
{
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getAlert
Returns alert details for the specified id
The UUID of the alert
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateAlert
Updates an existing Alert
undefined
The UUID of the Alert
Request Example
{
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - AssetCategories
listAssetCategories
Retrieve a list of asset categories for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
createAssetCategory
Creates a new asset category
undefined
Request Example
{
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getAssetCategory
Returns asset category details for the specified id
The UUID of the asset category
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateAssetCategory
Updates an existing asset category
undefined
(no description)
Request Example
{
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteAssetCategory
Delete an asset category
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - AssetGroups
listAssetGroups
Retrieve a list of asset groups for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
createAssetGroup
Creates a new Asset Group
undefined
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getAssetGroup
Returns asset group details for the specified id
The UUID of the asset group
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateAssetGroup
Updates an existing Asset Group
undefined
(no description)
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteAssetGroup
Delete an asset group
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - AssetRatingProfiles
listAssetRatingProfiles
Retrieve a list of asset rating profiles for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
]
}
createAssetRatingProfile
Creates a new Asset Rating Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getAssetRatingProfile
Returns asset rating profile details for the specified id
The UUID of the asset rating profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateAssetRatingProfile
Updates an existing Asset Rating Profile entity
undefined
The UUID of the Asset State Profile
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Assets
listAssets
Retrieve a list of assets for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"devices": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": "string",
"tags": [
"string"
],
"fields": {},
"color": "string",
"state": "string",
"geoLock": {
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"lat": "number (double)",
"lon": "number (double)",
"radiusKm": "number (double)",
"start": "string",
"end": "string"
},
"cameras": "number (double)"
}
]
}
createAsset
Creates a new asset entity
undefined
Request Example
{
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
getAsset
Returns asset details for the specified id
The UUID of the asset
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
updateAsset
Updates an existing asset
undefined
(no description)
Request Example
{
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
setAssetPrivacy
Update asset privacy mode
undefined
The UUID of the asset
Request Example
{
"conditions": {
"end": "string",
"trips": "number (double)"
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
getAssetAvatar
Return the asset avatar in binary format
The UUID of the asset
Ok
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
updateAssetAvatar
Updates the specified asset's avatar.
The asset UUID you are requesting data for.
No content
Response Content-Types: application/json
deleteAssetAvatar
Permanently deletes a asset avatar.
The asset UUID.
No content
Response Content-Types: application/json
getAssetLocation
Returns the latest known telemetry record for an asset
The UUID of the asset
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {},
"meta": {},
"object": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"trip": {
"start": "string",
"startAddress": "string",
"startLon": "number (double)",
"startLat": "number (double)",
"distance": "number (double)",
"lastLon": "number (double)",
"lastLat": "number (double)"
},
"lastMovement": "string",
"lastTripEnd": "string",
"privacy": {}
}
linkAssets
Links an asset from one account to one in another account. All data from the source asset will be duplicated for the destination asset. Returns both the source and destination asset if successful.
undefined
The source asset UUID you would like to link.
Request Example
{
"assetId": "string",
"asset": {
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string"
}
}
]
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"source": {
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string"
}
}
]
}
}
unlinkAssets
Unlinks an asset linked to another. Returns both the source and destination asset if successful.
The source asset UUID you would like to unlink from.
The destination asset UUID you would like to unlink from.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"source": {
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string"
}
}
]
}
}
moveAsset
Moves an asset from one client to another by deleting the asset in the source client and recreating it in the destination client. Also moves any associated device and simcard if assigned.
undefined
The asset UUID you would like to move.
Request Example
{
"destinationClientId": "string",
"includeDevice": "boolean",
"includeSimCard": "boolean"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
Entities - AssetStateProfiles
listAssetStateProfiles
Retrieve a list of asset state profiles for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
]
}
createAssetStateProfile
Creates a new Asset State Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getAssetStateProfile
Returns asset state profile details for the specified id
The UUID of the asset state profile
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateAssetStateProfile
Updates an existing Asset State Profile entity
undefined
The UUID of the Asset State Profile
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - AssetTags
Entities - AssetTagTypes
listAssetTagTypes
Retrieve a list of asset tag types for a specified owner.
The owner id you are requesting data for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
]
}
getAssetTagType
Returns asset tag type details for the specified id
The UUID of the entity
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
Entities - AssetTypes
listAssetTypes
Retrieve a list of asset types for a specified owner.
The owner id you are requesting data for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
]
}
getAssetType
Returns asset type details for the specified id
The UUID of the entity
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
Entities - CostCentres
listCostCentres
Retrieve a list of cost centres for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
createCostCentre
Creates a new cost centre
undefined
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getCostCentre
Returns cost centre details for the specified id
The UUID of the cost centre
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateCostCentre
Updates an existing cost centre
undefined
(no description)
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteCostCentre
Delete a cost centre
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Dashboards
listDashboards
Retrieve a list of Dashboards for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"public": "boolean",
"description": "string",
"modifiedDate": "string"
}
]
}
createDashboard
Creates a new dashboard entity
undefined
Request Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"ownerId": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDashboard
Returns dashboard entity details for the specified id
The UUID of the Dashboard
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateDashboard
Updates an existing dashboard entity
undefined
The UUID of the Dashboard
Request Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteDashboard
Permanently deletes a dashboard
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
rebuildDashboardWidget
Rebuilds a widget
The UUID of the dashboard to which the widget belongs
The UUID of the widget to rebuild
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string"
}
Entities - DashboardTemplates
listDashboardTemplates
Retrieve a list of Dashboard templates for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"modifiedDate": "string"
}
]
}
createDashboardTemplate
Creates a new dashboard template
undefined
Request Example
{
"dashboardId": "string",
"ownerId": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDashboardTemplate
Returns dashboard template entity details for the specified id
The UUID of the Dashboard
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateDashboardTemplate
Updates an existing dashboard template entity
undefined
The UUID of the Dashboard
Request Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Devices
listDevices
Retrieve a list of devices for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {},
"state": "string"
}
]
}
createDevice
Creates a new device entity
undefined
Request Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDevice
Returns device details for the specified id
The UUID of the device
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateDevice
Updates an existing device
undefined
(no description)
Request Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDeviceByName
Returns device details for the specified device type and device IMEI or serial number
The UUID of the device type
The name of the device (usually an IMEI or serial number)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - DeviceConfigProfiles
listDeviceConfigProfiles
Retrieve a list of device config profiles for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createDeviceConfigProfile
Creates a new DeviceConfig Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"features": {}
}
getDeviceConfigProfile
Returns device config profile details for the specified id
The UUID of the device config profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"features": {}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateDeviceConfigProfile
Updates an existing DeviceConfig Profile entity
undefined
The UUID of the DeviceConfig Profile
Request Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"features": {}
}
Entities - DeviceTypes
listDeviceTypes
Retrieve a list of device types for a specified owner.
The owner id you are requesting data for
Load items from the parent company tree as well (defaults to "true")
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createDeviceType
Creates a new device type entity
undefined
Request Example
{
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDeviceType
Returns device type details for the specified id
The UUID of the device
The optional UUID of a Client. The device type may be customized based on settings and features in the client.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateDeviceType
Updates an existing device type
undefined
(no description)
Request Example
{
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - DeviceProviders
listDeviceProviders
Retrieve a list of device providers for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createDeviceProvider
Creates a new device provider entity
undefined
Request Example
{
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string",
"parameters": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getDeviceProvider
Returns device provider details for the specified id
The UUID of the device
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateDeviceProvider
Updates an existing device provider
undefined
(no description)
Request Example
{
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - DeviceProviderTypes
listDeviceProviderTypes
Retrieve a list of device provider types for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"companyTypes": [
"string"
],
"state": "string"
}
]
}
getDeviceProviderType
Returns device provider type details for the specified id
The UUID of the device
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"companyTypes": [
"string"
],
"state": "string",
"parameters": "string"
}
Entities - EmailProviders
listEmailProviders
Retrieve a list of email providers.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"modifiedDate": "string"
}
]
}
createEmailProvider
Creates a new email provider entity
undefined
Request Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getEmailProvider
Returns email provider details for the specified id
The UUID of the email provider
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateEmailProvider
Updates an existing email provider entity
undefined
The UUID of the email provider
Request Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - ExportTasks
listExportTasks
Retrieve a list of export tasks for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"username": "string",
"modifiedDate": "string"
}
]
}
createExportTask
Creates a new export task entity
undefined
Request Example
{
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"endpoint": "string",
"username": "string",
"password": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getExportTask
Returns export task details for the specified id
The UUID of the export task
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"endpoint": "string",
"username": "string",
"password": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateExportTask
Updates an existing export task entity
undefined
The UUID of the export task
Request Example
{
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"endpoint": "string",
"username": "string",
"password": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - FuelCards
listFuelCards
Retrieve a list of fuel cards for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createFuelCard
Creates a new fuel card
undefined
Request Example
{
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getFuelCard
Returns fuel card details for the specified id
The UUID of the fuel card
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateFuelCard
Updates an existing fuel card
undefined
(no description)
Request Example
{
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - GeoLockProfiles
listGeoLockProfiles
Retrieve a list of GeoLock profiles for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"modifiedDate": "string"
}
]
}
createGeoLockProfile
Creates a new GeoLock Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getGeoLockProfile
Returns GeoLock profile details for the specified id
The UUID of the GeoLock profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateGeoLockProfile
Updates an existing GeoLock Profile entity
undefined
The UUID of the GeoLock Profile
Request Example
{
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - IoTypes
listIoTypes
Retrieve a list of I/O types for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"modifiedDate": "string"
}
]
}
createIoType
Creates a new I/O type entity
undefined
Request Example
{
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getIoType
Returns I/O type details for the specified id
The UUID of the I/O type
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateIoType
Updates an existing I/O type entity
undefined
The UUID of the I/O type
Request Example
{
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Labels
listLabels
Retrieve a list of I/O types for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"modifiedDate": "string"
}
]
}
createLabel
Creates a new I/O type entity
undefined
Request Example
{
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getLabel
Returns I/O type details for the specified id
The UUID of the I/O type
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateLabel
Updates an existing I/O type entity
undefined
The UUID of the I/O type
Request Example
{
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Lookups
getLookups
Retrieve a list of lookups for a specified entity.
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{}
Entities - MapSets
listMapSets
Retrieve a list of map sets for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
createMapSet
Creates a new map set entity
undefined
Request Example
{
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
getMapSet
Retrieve a map set by it's ID.
The Map Set UUID to retrieve.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
updateMapSet
Updates an existing map set entity
undefined
The UUID of the mapset
Request Example
{
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Entities - OverspeedProfiles
listOverspeedProfiles
Retrieve a list of overspeed profiles for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"modifiedDate": "string"
}
]
}
createOverspeedProfile
Creates a new Overspeed Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getOverspeedProfile
Returns overspeed profile details for the specified id
The UUID of the overspeed profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateOverspeedProfile
Updates an existing Overspeed Profile entity
undefined
The UUID of the Overspeed Profile
Request Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - PrivacyProfiles
listPrivacyProfiles
Retrieve a list of Privacy profiles for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"modifiedDate": "string"
}
]
}
createPrivacyProfile
Creates a new Privacy Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getPrivacyProfile
Returns Privacy profile details for the specified id
The UUID of the Privacy profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updatePrivacyProfile
Updates an existing Privacy Profile entity
undefined
The UUID of the Privacy Profile
Request Example
{
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - ReportDefinitions
listReportDefinitions
Retrieve a list of report definitions for a specified owner.
The owner id you are requesting data for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"source": "string",
"schedulable": "boolean",
"styles": [
{
"id": "string",
"name": "string",
"schedulable": "boolean",
"limits": {
"days": "number (double)"
},
"parameters": "string",
"layout": {
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
}
]
}
]
}
getReportDefinition
Retrieve a report definition by it's ID.
The UUID to retrieve.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"source": "string",
"schedulable": "boolean",
"styles": [
{
"id": "string",
"name": "string",
"schedulable": "boolean",
"limits": {
"days": "number (double)"
},
"parameters": "string",
"layout": {
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
}
]
}
Entities - ReportTemplates
listReportTemplates
Retrieve a list of report templates for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
]
}
createReportTemplate
Creates a new report template
undefined
Request Example
{
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
getReportTemplate
Retrieve a report template by it's ID.
The UUID to retrieve.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
updateReportTemplate
Updates an existing report template
undefined
(no description)
Request Example
{
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
deleteReportTemplate
Deletes a report template
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
Entities - Reminders
listReminders
Retrieve a list of reminders for a specified owner.
The owner id you are requesting data for
The target entity you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"modifiedDate": "string"
}
]
}
createReminder
Creates a new reminder entity
undefined
Request Example
{
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"lastTriggered": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getReminder
Retrieve a reminder by it's ID.
The reminder UUID.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"lastTriggered": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateReminder
Updates an existing reminder entity
undefined
The reminder UUID.
Request Example
{
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"lastTriggered": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteReminder
Deletes an existing reminder entity
The reminder UUID.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"lastTriggered": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - RoadProfiles
listRoadProfiles
Retrieve a list of road profiles for a specified owner.
The owner id you are requesting data for
Load items from the parent as well
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"modifiedDate": "string"
}
]
}
createRoadProfile
Creates a new Road Profile entity
undefined
Request Example
{
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getRoadProfile
Returns road profile details for the specified id
The UUID of the road profile
Ok
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateRoadProfile
Updates an existing Road Profile entity
undefined
The UUID of the Road Profile
Request Example
{
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - ScheduledReports
listScheduledReports
Retrieve a list of scheduled reports for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": "number (double)",
"recipients": "number (double)",
"modifiedDate": "string"
}
]
}
createScheduledReport
Creates a new scheduled report entity
undefined
Request Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getScheduledReport
Returns scheduled report details for the specified id
The UUID of the scheduled report
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateScheduledReport
Updates an existing scheduled report entity
undefined
The UUID of the scheduled report
Request Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - SimCards
listSimCards
Retrieve a list of SIM cards for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
]
}
createSimCard
Creates a new SIM card
undefined
Request Example
{
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getSimCard
Returns SIM card details for the specified id
The UUID of the SIM card
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateSimCard
Updates an existing SIM card
undefined
(no description)
Request Example
{
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - SmsGatewayProviders
listSmsGatewayProviders
Retrieve a list of sms gateway providers.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
createSmsGatewayProvider
Creates a new sms gateway provider entity
undefined
Request Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getSmsGatewayProvider
Returns sms gateway provider details for the specified id
The UUID of the entity
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateSmsGatewayProvider
Updates an existing sms gateway provider entity
undefined
The UUID of the sms gateway provider
Request Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - SmsGatewayProvidersTypes
listSmsGatewayProviderTypes
Retrieve a list of sms gateway provider types.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
getSmsGatewayProviderType
Returns sms gateway provider type details for the specified id
The UUID of the entity
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"direction": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - EmailProvidersTypes
listEmailProviderTypes
Retrieve a list of email provider types.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
getEmailProviderType
Returns email provider type details for the specified id
The UUID of the entity
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Themes
listThemes
Retrieve a list of themes for a specified owner.
The owner id you are requesting data for
(no description)
(no description)
(no description)
(no description)
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string"
}
]
}
createTheme
Creates a new Theme entity
undefined
Request Example
{
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getTheme
Returns Theme details for the specified id
The UUID of the Theme
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateTheme
Updates an existing Theme entity
undefined
The UUID of the Theme
Request Example
{
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getThemeForDomain
Returns client details for the specified id
The domain name to look up
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"domain": {
"domain": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"auth": {
"availableAuth": [
"string"
],
"endpoints": [
{
"id": "string",
"type": "string",
"name": "string",
"endpoint": "string",
"clientId": "string"
}
]
},
"message": "string"
},
"theme": {
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
}
Entities - ZoneGroups
listZoneGroups
Retrieve a list of zone groups for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
createZoneGroup
Creates a new Zone Group
undefined
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getZoneGroup
Returns zone group details for the specified id
The UUID of the zone group
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateZoneGroup
Updates an existing Zone Group
undefined
(no description)
Request Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
deleteZoneGroup
Delete a Zone Group
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Entities - Zones
listZones
Retrieve a list of zones for a specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
A bounding rectangle to restrict the result set to in string format as left,top,right,bottom
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"modifiedDate": "string"
}
]
}
createZone
Creates a new zone
undefined
Request Example
{
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getZone
Retrieve a Map Set by it's ID.
The Map Set UUID to retrieve.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateZone
Updates an existing zone
undefined
(no description)
Request Example
{
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
Media
listMedia
Retrieve a list of media information items for the specified owner.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
]
}
getMedia
Retrieve a media information item.
The media ID you are requesting data for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
cancelMedia
Cancel a pending or queued media item.
The media ID you are canceling
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
deleteMediaFile
Delete a media item media file
The media ID you are deleting
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
getMediaFile
Retrieve a media item.
The UUID of the asset you are requesting media for.
The filename of the media item.
No content
Response Content-Types: application/json
getMediaInfo
Returns information for a media item.
The UUID of the asset you are requesting media for.
The filename of the media item.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
getMediaInfoDeprecated
[DEPRECATED] Use getMediaInfo instead
(no description)
(no description)
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
startVideoLiveStream
Requests a live stream endpoint for a video.
undefined
The UUID of the asset you are requesting media for.
Request Example
{
"duration": "number (double)",
"input": "string",
"record": "boolean"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"status": "string",
"endpoints": [
"string"
]
}
createVideoEvent
Creates a new video event for a specified date time.
undefined
Request Example
{
"duration": "number (double)",
"offset": "number (double)",
"inputs": [
"string"
],
"assetId": "string",
"date": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
],
"details": {}
}
updateVideoEvent
Request a video from a camera enabled device for a particular event.
undefined
The owner id of the company that owns the event
The GUID of the event for which you wish to retrieve the video
Request Example
{
"duration": "number (double)",
"offset": "number (double)",
"inputs": [
"string"
]
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
],
"details": {}
}
Notifications
testNotification
Sends dummy notifications to the requesting user
undefined
Request Example
{
"ownerId": "string",
"notificationChannels": [
"string"
],
"siteUrl": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"message": "string"
}
Reports - Analytics
listAnalyticsBaseReports
Retrieve a list of base reports for a specified owner, client or user.
(no description)
(no description)
(no description)
(no description)
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"title": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"taskId": "number (double)",
"date": "string",
"completionDate": "string",
"status": "string",
"progress": "number (double)",
"completedTasks": "number (double)",
"totalTasks": "number (double)",
"firstPassComplete": "boolean",
"priority": "number (double)",
"mode": "string",
"maxRunning": "number (double)",
"runEndDate": "string",
"lastCompletedDate": "string",
"dashboards": [
{
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"id": "string",
"name": "string"
}
]
}
]
}
getAnalyticsBaseReport
Retrieve an analytics base report by its ID.
The UUID to retrieve.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"name": "string",
"title": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"taskId": "number (double)",
"date": "string",
"completionDate": "string",
"status": "string",
"progress": "number (double)",
"completedTasks": "number (double)",
"totalTasks": "number (double)",
"firstPassComplete": "boolean",
"priority": "number (double)",
"mode": "string",
"maxRunning": "number (double)",
"runEndDate": "string",
"lastCompletedDate": "string",
"dashboards": [
{
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"id": "string",
"name": "string"
}
]
}
rebuildAnalyticsBaseReport
Rebuilds a base report
(no description)
No content
Response Content-Types: application/json
Reports - History
listCompletedReports
Retrieve a list of queued reports for a specified owner.
(no description)
(no description)
The client id you are requesting reports for
(no description)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean"
}
]
}
}
]
}
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompletedReport
Retrieve a queued report by it's ID.
The UUID to retrieve.
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string"
}
}
]
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
updateCompletedReport
Update a report by it's ID.
The data with which to update an existing report.
The UUID of the report to update
Request Example
{
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
}
}
]
}
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string"
}
}
]
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompletedReportWithOptions
Retrieve a queued report by it's ID.
undefined
The UUID to retrieve.
Request Example
{
"outputOptions": {
"row": "string",
"group": "string"
}
}
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string"
}
}
]
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompletedReportData
Retrieve the binary data for a queued report by it's ID.
The UUID to retrieve.
The filename and type your want the to be returned as, can be '.pdf', '.csv' or '.json'
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
"string (byte)"
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompletedReportDataWithOptions
Retrieve the binary data for a queued report by it's ID.
undefined
The UUID to retrieve.
The filename and type your want the data to be returned as, can be '.pdf', '.csv' or '.json'
Request Example
{
"outputOptions": {
"rowLevel": "number (double)",
"groupLevel": "number (double)",
"time": "string",
"flipped": "boolean",
"measures": [
"string"
],
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"row": "string",
"group": "string",
"filters": {
"group": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
},
"row": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
}
}
}
}
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getCompletedReportDataStream
Retrieve the binary data for a queued report by it's ID.
The UUID to retrieve.
The filename and type your want the to be returned as, can be '.pdf', '.csv' or '.json'
(no description)
No content
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
Reports - Queues
listQueuedReports
Retrieve a list of queued reports for a specified owner.
The client id you are requesting reports for
(no description)
An optional server identifier (will be inferred from client settings if possible)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
queueReport
Queue a new report
undefined
Request Example
{
"clientId": "string",
"source": "string",
"serverId": "string",
"name": "string",
"title": "string",
"outputFormat": "string",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
}
}
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
getQueuedReport
Retrieve a queued report by it's ID.
The UUID to retrieve.
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
cancelReport
Cancel a queued or running report
(no description)
Ok
ForbiddenError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
Stats
getOutputForEntity
Retrieve data for a stats report.
undefined
(no description)
The type of the entity. The UUID of the entity. The stats metric.
(no description)
Request Example
{
"groupLevel": "string",
"rowLevel": "string",
"time": "string",
"flip": "boolean"
}
Ok
ForbiddenError
NotFoundError
Too many requests
UnexpectedError
Response Content-Types: application/json
Response Example (200 OK)
{
"cellset": {
"rowLevels": "number (double)",
"filters": {
"row": {},
"group": {}
},
"average": {
"value": [
"string"
],
"raw": [
"number (double)"
]
},
"cellset": [
[
{
"value": "object",
"type": "string",
"properties": {
"raw": "object",
"format": {
"align": "string",
"width": "number (double)"
},
"doNotShowOnChart": "boolean",
"type": "string",
"seriesKey": "string",
"uniquename": "string",
"dimension": "string",
"level": "string"
}
}
]
],
"status": "string"
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (429 Too Many Requests)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (500 Internal Server Error)
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
Search
searchEntities
Perform a free text search against the entities available to the user.
The free text query you'd like to search for
Specify whether to include deleted items in the response
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"type": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"fields": "string",
"tags": "string"
}
]
}
Health
listIssues
Retrieve a list of health issues.
The owner id you are requesting data for
The id of the entity on which to filter issues for
Filter issues by their resolved status
An offset into the result set, useful for pagination
Limit the number of results to this value.
Ok
ForbiddenError
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"topic": "string",
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": {
"created": "string",
"updated": "string"
},
"count": "number (double)",
"resolved": {
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
}
]
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
getIssue
Returns a health issue for the specified id
The UUID of the health issue
Ok
ForbiddenError
NotFoundError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"topic": "string",
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": {
"created": "string",
"updated": "string"
},
"count": "number (double)",
"resolved": {
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
updateIssue
Update a health issue for the specified id
undefined
The UUID of the health issue
Request Example
{
"resolved": {
"message": "string"
}
}
Ok
BadRequestError
ForbiddenError
NotFoundError
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"topic": "string",
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": {
"created": "string",
"updated": "string"
},
"count": "number (double)",
"resolved": {
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
}
Response Example (400 Bad Request)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (403 Forbidden)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Response Example (404 Not Found)
{
"status": "number (double)",
"name": "string",
"message": "string"
}
Redirect
redirect
Handles SSO redirects.
The redirect ID
(no description)
Redirect
Response Content-Types: application/json
Tasks
listTasks
Retrieve a list of ACTIVE tasks for a specific entity.
The entity id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
]
}
createTask
Creates a new task
undefined
Request Example
{
"ownerId": "string",
"type": "string",
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"data": {}
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
getTask
Returns a task for the specified id
The UUID of the task
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
cancelTask
Cancels a task
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
Translate
exportLanguage
Exports the language strings for the specified language.
The language code
Ok
Response Content-Types: application/json
Response Example (200 OK)
{}
Map
geocodeForward
Perform a free text search against map addresses and zones.
The client UUID for whom geocoding is being done
The free text query you'd like to search for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
}
}
]
}
geocodeReverse
Perform a reverse geocode text search against map addresses.
The client UUID for whom geocoding is being done
The latitude to search for
The longitude to search for
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
},
"geometry": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"speed": "number (double)"
}
]
}
getRoute
Route between two points on a map.
The client UUID for whom geocoding is being done
The routing strategy to employ while calculating the route, in the format fastest,longest
The coordinate pairs to route between in the format [lon,lat],[lon,lat]
(no description)
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"routes": [
{
"strategy": "string",
"segments": [
{
"distance": "number (double)",
"time": "number (double)",
"geom": {
"type": "string",
"coordinates": [
[
"number (double)"
]
]
}
}
]
}
]
}
Entities - SslCertificates
listSslCertificates
Retrieve a list of ssl certificates.
The owner id you are requesting data for
An offset into the result set, useful for pagination
Limit the number of results to this value.
Sorting column or attribute name with an optional direction, e.g. sort=name:desc
A filter to apply to the data in RQL format.
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
createSslCertificate
Creates a new ssl certificate entity
undefined
Request Example
{
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"ownerId": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
getSslCertificate
Returns ssl certificate details for the specified id
The UUID of the ssl certificate
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
updateSslCertificate
Updates an existing ssl certificate entity
undefined
The UUID of the ssl certificate
Request Example
{
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string"
}
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
validateSslCertificate
Validates the ssl certificate and all prerequisites
The UUID of the ssl certificate
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"provisioned": "boolean",
"verified": "boolean",
"domain": "string",
"valid": "boolean",
"errors": [
"string"
]
}
provisionSslCertificate
Attempts to provision the ssl certificate
The UUID of the ssl certificate
Ok
Response Content-Types: application/json
Response Example (200 OK)
{
"domain": "string",
"success": "boolean",
"errors": [
"string"
]
}
Schema Definitions
ErrorBase: object
- name: string | null
- message: string
Example
{
"name": "string",
"message": "string"
}
IdName: object
- id: string
-
The unique ID of the object
- name: string | null
-
The name of the object (can be undefined if an error occurs)
- err: ErrorBase | null
-
Will be populated if an error occurs retrieving the name for the object.
Example
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
ClientListItem: object
Summary client information returned in lists.
- id: string
-
The client's unique UUID
- name: string
-
The client's display name
- website: string
-
The client website (if available)
- owner: IdName
-
The vendor that owns this client.
- group: string
-
The group to which this client belongs.
- state: string inactive, active, suspended, deleted
-
The state of this client.
- counts: NumberDictionary | null
-
A dictionary of child entity names and their counts, present if the
countsparameter is supplied. - creationDate: string
-
The date this client was created.
- modifiedDate: string
-
The date that this client was last modified.
Example
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
ClientListResponse: object
A paginated list of client items.
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ClientListItem
-
ClientListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
EntityInfo: object
- creationDate: string
-
The ISO date this company was created
- modifiedDate: string
-
The ISO date that this company was last modified
Example
{
"creationDate": "string",
"modifiedDate": "string"
}
IdNameType: object
- id: string
-
The unique ID of the object
- name: string | null
-
The name of the object (can be undefined if an error occurs)
- type: string | null
-
The type of the object (can be undefined if an error occurs)
- err: ErrorBase | null
-
Will be populated if an error occurs retrieving the name for the object.
Example
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
ClientMeta: object
The meta structure contains information that has been resolved dynamically for this client.
- currentMapSetId: string
-
The map set that should be used by this client, it may have been passed down from the parent vendor.
- mergedFlags: FlagsBucket
-
A set of user defined flags that have been merged with the client group tree that this client belongs to.
Example
{
"currentMapSetId": "string",
"mergedFlags": {}
}
Shift: object
- id: string
-
A UUID V4 id for the shift
- name: string
-
The name of the shift
- start: string
-
The start time of the shift (hh:mm). This time is inclusive.
- end: string
-
The end time of the shift (hh:mm). This time is exclusive
Example
{
"id": "string",
"name": "string",
"start": "string",
"end": "string"
}
EntitySoftLimit: object
- max: number | null (double)
- total: number | null (double)
- active: number | null (double)
Example
{
"max": "number (double)",
"total": "number (double)",
"active": "number (double)"
}
SoftLimits: object
- entities: EntitySoftLimits | null
Example
{
"entities": {}
}
CompanyDataRetentionSettings: object
- source: IdNameType | null
-
[READ-ONLY] The entity from which the active data retention settings are being calculated
- retainFor: number | null (double)
-
The amount of days, months or years to retain data for
- retainForUnit: string | null days, months, years
-
The unit of the retainFor value
- horizonDate: string | null
-
[READ-ONLY] The current event horizon before which all data will be deleted
Example
{
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
}
PasswordComplexity: object
Defines the expected complexity of user supplied passwords
- mixedCase: boolean
-
If enabled, forces the user to use both uppercase and lowercase characters in their password.
- alphaNumerical: boolean
-
If enabled, forces users to use both alpha and numerical characters in their password.
- specialCharacters: boolean
-
If enabled, forces users to use at least once character that is not alphanumberical.
- noCommonPasswords: boolean
-
If enabled, passwords will be compared to a list of the most common passwords found in breaches, and rejected if it matches.
Example
{
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
}
OTPMethodSettings: object
- tokenValidityDays: number (double)
-
Setting that defines the number of days that the front-end will cache the OTP token so that users do not have do OTP auth on every sign in.
Example
{
"tokenValidityDays": "number (double)"
}
OTPSettings: object
Settings for One Time Password requirements
- methods: object
-
The one time password methods that are allowed
-
OTPMethodSettings - mandatoryFor: string optional, everyone, administrators
-
Define who is forced to enable OTP. If set to "optional", users can opt themselves into OTP but do not need to do so.
- gracePeriodDays: number (double)
-
The number of days grace that will be given to new users when their account is created before they are forced to enable OTP on their account.
Example
{
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
UserPasswordPolicy: object
Settings that define the user password policy
- source: IdNameType | null
-
[READ-ONLY] The entity from which the active password polict settings are being calculated
- passwordLength: number (double)
-
The minimum length allowed for passwords
- passwordComplexity: PasswordComplexity
-
Defines the password complexity rules
- passwordExpirationDays: number (double)
-
Determines when users are prompted to change their password. Set to zero to disable password expiration.
- otpSettings: OTPSettings | null
-
Settings for One Time Password authentication. Set to null to disable OTP requirements
Example
{
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
}
ThemeInfo: object
- id: string | null
-
The unique ID of the theme
- name: string | null
-
The name of the theme
- settings: ThemeSettings | null
-
[DEPRECATED] A set of theme specific overrides
Example
{
"id": "string",
"name": "string",
"settings": {}
}
CompanyAddress: object
- address: string | null
- city: string | null
- state: string | null
- country: string | null
- code: string | null
Example
{
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
}
CustomFieldKeyValue: object
- key: string
- value: string
Example
{
"key": "string",
"value": "string"
}
CustomFieldDefinition: object
- owner: string | null
- id: string
- title: string
- type: string
- required: boolean
- values: CustomFieldKeyValue
-
CustomFieldKeyValue
Example
{
"owner": "string",
"id": "string",
"title": "string",
"type": "string",
"required": "boolean",
"values": [
{
"key": "string",
"value": "string"
}
]
}
CompanySupportDetails: object
- email: string | null
- phone: string | null
Example
{
"email": "string",
"phone": "string"
}
CompanyMessages: object
- login: string | null
-
A custom message that will be displayed on the login screen
- suspended: string | null
-
A custom message that will be displayed if a user of this company attempts to log in, but the company is suspended.
Example
{
"login": "string",
"suspended": "string"
}
OpenIdConnectIssuer: object
- name: string | null
-
A friendly name for the OpenId Connect issuer.
- issuer: string | null
-
The issuer endpoint, i.e. https://accounts.google.com
- clientId: string | null
-
The unique client ID provided by the issuer
- clientSecret: string | null
-
[OPTIONAL] The client secret provided by the issuer
Example
{
"name": "string",
"issuer": "string",
"clientId": "string",
"clientSecret": "string"
}
IdNameState: object
- id: string
-
The unique ID of the object
- name: string | null
-
The name of the object (can be undefined if an error occurs)
- state: string | null active, inactive, suspended, deleted
-
The name of the object (can be undefined if an error occurs)
- err: ErrorBase | null
-
Will be populated if an error occurs retrieving the name for the object.
Example
{
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
}
CompanySSLCertificate: object
- id: string
-
The unique ID of the ssl certificate
- domain: string
-
The domain for which the ssl certificate was provisioned
- modifiedDate: string
-
The date the entity was last modified
- state: string | null
-
The state of this certificate
Example
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
ClientMeasurementUnits: object
- distanceUnit: string | null kilometres, metres, feet, inches, miles, nauticalMiles, yards
- altitudeUnit: string | null metres, kilometres, feet, inches, miles, nauticalMiles, yards
- speedUnit: string | null kilometresPerHour, metresPerSecond, milesPerHour, knots
- areaUnit: string | null squareKilometres, acres, hectares, squareFeet, squaremetres, squareInches, squareMiles, squareYards
- volumeUnit: string | null litres, cubicmetres, cubicFeet, gallons, ounces, gallonsUs, ouncesUs
- weightUnit: string | null kilograms, ounces, pounds, tonnes
- timeUnit: string | null HHmmss, Hmmss, hmmssa
- dateUnit: string | null yyyymmdd1, yyyymmdd2, yyyymmdd3, ddmmyyyy1, ddmmyyyy2, ddmmyyyy3, dmyyyy1, dmyyyy2, dmyyyy3, mmddyyyy1, mdyyyy1
- temperatureUnit: string | null celsius, fahrenheit
Example
{
"distanceUnit": "string",
"altitudeUnit": "string",
"speedUnit": "string",
"areaUnit": "string",
"volumeUnit": "string",
"weightUnit": "string",
"timeUnit": "string",
"dateUnit": "string",
"temperatureUnit": "string"
}
ClientResponse: object
The ClientResponse contains details for a client entity.
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo
-
Entity specific metadata.
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - mapSet: IdName | null
-
The map set that has been defined for this client. It may be empty in which case the default will be used.
- features: Features | null
-
[DEPRECATED] use the
flagsproperty instead. - pin: string | null
-
A user friendly pin that uniquely identifies this client.
- group: string | null
-
The group that this client belongs to
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this client is allowed to use. An empty list means all device types.
-
IdName - meta: ClientMeta | null
-
Dynamically resolved meta information for the client
- shiftPattern: ShiftPattern | null
-
A shift pattern for the client
- measurementUnits: ClientMeasurementUnits | null
-
Measurement unit configuration for this client.
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {}
}
}
ClientUpdateRequest: object
The ClientUpdateRequest is used to update an existing entity. All fields are optional and can be individually supplied to the update method.
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - mapSet: IdName | null
-
The map set that has been defined for this client. It may be empty in which case the default will be used.
- features: Features | null
-
[DEPRECATED] use the
flagsproperty instead. - pin: string | null
-
A user friendly pin that uniquely identifies this client.
- group: string | null
-
The group that this client belongs to
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this client is allowed to use. An empty list means all device types.
-
IdName - meta: ClientMeta | null
-
Dynamically resolved meta information for the client
- shiftPattern: ShiftPattern | null
-
A shift pattern for the client
- measurementUnits: ClientMeasurementUnits | null
-
Measurement unit configuration for this client.
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
ClientDetailsUpdateRequest: object
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - measurementUnits: ClientMeasurementUnits | null
-
Measurement unit configuration for this client.
Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"measurementUnits": {
"distanceUnit": "string",
"altitudeUnit": "string",
"speedUnit": "string",
"areaUnit": "string",
"volumeUnit": "string",
"weightUnit": "string",
"timeUnit": "string",
"dateUnit": "string",
"temperatureUnit": "string"
}
}
ClientCreateRequest: object
The ClientCreateRequest is used to create a new entity.
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - mapSet: IdName | null
-
The map set that has been defined for this client. It may be empty in which case the default will be used.
- features: Features | null
-
[DEPRECATED] use the
flagsproperty instead. - pin: string | null
-
A user friendly pin that uniquely identifies this client.
- group: string | null
-
The group that this client belongs to
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this client is allowed to use. An empty list means all device types.
-
IdName - meta: ClientMeta | null
-
Dynamically resolved meta information for the client
- shiftPattern: ShiftPattern | null
-
A shift pattern for the client
- measurementUnits: ClientMeasurementUnits | null
-
Measurement unit configuration for this client.
- ownerId: string
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
CompanyResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - type: string distributor, vendor, client
-
The type of company
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {}
}
}
UnexpectedError: object
An unexpected error is thrown when the API experiences an unexpected internal exception.
- status: number | null (double) 500
- name: string | null UnexpectedError
- message: string | null Internal server error
- data: object | null
- stack: string | null
Example
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
TooManyRequestsError: object
Returned when a request cannot be served due to the application’s rate limit having been exhausted for the resource.
- status: number | null (double) 429
- name: string | null TooManyRequestsError
- message: string | null Rate limit exceeded.
Example
{
"status": "number (double)",
"name": "string",
"message": "string"
}
ForbiddenError: object
The request has been refused. See the accompanying message for the specific reason.
- status: number | null (double) 403
- name: string | null ForbiddenError
- message: string | null Forbidden
Example
{
"status": "number (double)",
"name": "string",
"message": "string"
}
NotFoundError: object
The URI requested is invalid or the resource requested does not exists.
- status: number | null (double) 404
- name: string | null NotFoundError
- message: string | null The resource you requested could not be found
Example
{
"status": "number (double)",
"name": "string",
"message": "string"
}
EmailTemplateConfig: object
- template: IdName | null
-
The email template to use for this customization. If an empty GUID is passed the
defaultTemplateIdvalue will be used. - subject: string | null
- body: string | null
Example
{
"template": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"subject": "string",
"body": "string"
}
EmailConfig: object
- defaultTemplate: IdName | null
-
The default email template to use for all of configured email types (can be overridden individually). If an empty GUID is passed the system default will be used.
- templates: EmailTemplateConfigDictionary | null
-
A number of email template customizations
Example
{
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
}
CompanyGroupResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- flags: FlagsBucket | null
-
A set of user defined flags
- email: EmailConfig | null
-
Email configuration
- limits: SoftLimits | null
-
Soft limits that apply to companies in this group.
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent company will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users of companies that belong to this group.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
CompanyGroupListResponse: object
A list of company group items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: CompanyGroupResponse
-
CompanyGroupResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
CompanyGroupUpdateRequest: object
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- flags: FlagsBucket | null
-
A set of user defined flags
- email: EmailConfig | null
-
Email configuration
- limits: SoftLimits | null
-
Soft limits that apply to companies in this group.
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent company will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users of companies that belong to this group.
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
}
}
CompanyGroupCreateRequest: object
- name: string
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- flags: FlagsBucket | null
-
A set of user defined flags
- email: EmailConfig | null
-
Email configuration
- limits: SoftLimits | null
-
Soft limits that apply to companies in this group.
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent company will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users of companies that belong to this group.
- ownerId: string
-
The client that owns this entity
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"flags": {},
"email": {
"defaultTemplate": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"templates": {}
},
"limits": {
"entities": {}
},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"ownerId": "string"
}
DistributorListItem: object
Summary distributor information returned in lists.
- id: string
-
The distributor's unique ID
- name: string
-
The distributor's display name
- website: string
-
The distributor website (if available)
- owner: IdName
-
The distributor that owns this distributor
- state: string inactive, active, suspended, deleted
-
The state of this distributor
- counts: NumberDictionary | null
-
A dictionary of child entity names and their counts, present if the
countsparameter is supplied. - creationDate: string
-
The date this distributor was created
- modifiedDate: string
-
The date that this distributor was last modified
Example
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
DistributorListResponse: object
A list of distributor items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DistributorListItem
-
DistributorListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
DistributorResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo
-
entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - vendorGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName - features: Features | null
-
A set of features that are enabled for this distributor.
- availableMapSets: IdName | null
-
A list of maps sets that are available to this distributor
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are available to this distributor
-
IdNameState
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {}
}
}
DistributorUpdateRequest: object
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - vendorGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName - features: Features | null
-
A set of features that are enabled for this distributor.
- availableMapSets: IdName | null
-
A list of maps sets that are available to this distributor
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are available to this distributor
-
IdNameState
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"vendorGroups": [
null
]
}
DistributorDetailsUpdateRequest: object
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate
Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
DistributorCreateRequest: object
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - vendorGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName - features: Features | null
-
A set of features that are enabled for this distributor.
- availableMapSets: IdName | null
-
A list of maps sets that are available to this distributor
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are available to this distributor
-
IdNameState - ownerId: string
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"vendorGroups": [
null
]
}
UserListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz datbase for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- defaultClient: IdName | null
-
The default client to load for this user
- costCentre: IdName | null
-
The cost centre that this user belongs to
- modifiedDate: string
-
The date the user was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
UserListResponse: object
A list of users
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: UserListItem
-
UserListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
PolicyStatement: object
- id: string | null
-
An optional UUID for the policy statement
- effect: string allow, deny
-
The type of policy
- actions: string[]
-
The actions the policy operates on
-
string - resources: string[]
-
The resources to which the policy applies
-
string
Example
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
Policy: object
- id: string
-
The UUID of the policy
- name: string
-
A name describing the policy
- statements: PolicyStatement
-
The statements used to create a policy
-
PolicyStatement
Example
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
ApiKey: object
An API Key entry
Example
{
"name": "string",
"policies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
]
}
UserOtpMethod: object
- type: string
-
The OTP method type
- date: string
-
The date this method was configured
- verfied: boolean
-
Whether this method has been verified. If false, this method may require further enrolment before it can be used.
Example
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
TimeRange: object
- from: string | null
-
The start time range
- to: string | null
Example
{
"from": "string",
"to": "string"
}
NotificationActions: object
- low: string | null none, email, sms, emailsms
- medium: string | null none, email, sms, emailsms
- high: string | null none, email, sms, emailsms
Example
{
"low": "string",
"medium": "string",
"high": "string"
}
NotificationSettings: object
- smsTime: TimeRange | null
-
The times in which it is acceptable to send the user an sms
- actions: NotificationActions | null
-
The actions to take for the different alert levels
Example
{
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
}
EventActorFilter: object
- actorType: string asset, user, client
- actorTypeId: string
- actorTypeName: string
- actorSelectionType: string any, group, accessGroup, specific
- actorId: string
- actorName: string | null
- text: string
Example
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
UserClientPermissions: object
- assets: EventActorFilter
-
EventActorFilter
Example
{
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
]
}
UserPermissions: object
- clients: object | null
-
UserClientPermissions
Example
{
"clients": {}
}
UserResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- apiKeys: ApiKeys | null
-
An optional set of API keys generated by the user
- otp: UserOtpMethod | null
-
Lists the types of one time password methods that have been configured for this user
-
UserOtpMethod - entity: EntityInfo
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
UserUpdateRequest: object
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- password: string | null
-
The users password
Example
{
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"password": "string"
}
UserCreateResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- apiKeys: ApiKeys | null
-
An optional set of API keys generated by the user
- otp: UserOtpMethod | null
-
Lists the types of one time password methods that have been configured for this user
-
UserOtpMethod - entity: EntityInfo
- inviteError: UnexpectedError | null
-
If you've populate the
inviteUrlproperty when creating the user, and there was an error sending the invite email, it will be available in this field.
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"inviteError": {
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
}
UserCreateRequest: object
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- ownerId: string
-
The company that owns this user
- password: string | null
-
The users password
- inviteUrl: string | null
-
Populate only if you wish to send an invitation email on account creation. The full URL where the user will be redirected for completing their profile. Include a {token} template variable so the API can insert the reset token, and optionally a {domain} template variable into which the configured domain for this user will be inserted. i.e. https://{domain}/reset?token={token}
Example
{
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"ownerId": "string",
"password": "string",
"inviteUrl": "string"
}
UserResetResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- apiKeys: ApiKeys | null
-
An optional set of API keys generated by the user
- otp: UserOtpMethod | null
-
Lists the types of one time password methods that have been configured for this user
-
UserOtpMethod - entity: EntityInfo
- resetError: UnexpectedError | null
-
If there were any errors initiating the reset email the
resetErrorproperty will be populated.
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"resetError": {
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object",
"stack": "string"
}
}
UserResetRequest: object
- resetUrl: string | null
-
The full URL where the user will be redirected for password reset. Include a {token} template variable so the API can insert the reset token, and optionally a {domain} template variable into which the configured domain for this user will be inserted. i.e. https://{domain}/#/login?token={token}
Example
{
"resetUrl": "string"
}
SuccessResponse: object
- message: string | null
-
A generic success message
Example
{
"message": "string"
}
UserRoleListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the user role
- description: string | null
-
An optional description for the role
- modifiedDate: string | null
-
The date the user role was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"modifiedDate": "string"
}
UserRoleListResponse: object
A list of user role items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: UserRoleListItem
-
The list of user role items in this response
-
UserRoleListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"modifiedDate": "string"
}
]
}
UserRoleResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the user role
- description: string | null
-
An optional description for the role
- legacyRights: LegacyRights | null
-
The api rights of the policy. Legacy only
- inlinePolicies: Policy | null
-
This applies to v2 API only
-
Policy - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
UserRoleUpdateRequest: object
- name: string | null
-
The name of the user role
- description: string | null
-
An optional description for the role
- legacyRights: LegacyRights | null
-
The api rights of the policy. Legacy only
- inlinePolicies: Policy | null
-
This applies to v2 API only
-
Policy
Example
{
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
]
}
UserRoleCreateRequest: object
- name: string | null
-
The name of the user role
- description: string | null
-
An optional description for the role
- legacyRights: LegacyRights | null
-
The api rights of the policy. Legacy only
- inlinePolicies: Policy | null
-
This applies to v2 API only
-
Policy - ownerId: string
Example
{
"name": "string",
"description": "string",
"legacyRights": {},
"inlinePolicies": [
{
"id": "string",
"name": "string",
"statements": [
{
"id": "string",
"effect": "string",
"actions": [
"string"
],
"resources": [
"string"
]
}
]
}
],
"ownerId": "string"
}
VendorListItem: object
Summary vendor information returned in lists.
- id: string
-
The vendor's unique ID
- name: string
-
The vendor's display name
- website: string
-
The vendor website (if available)
- owner: IdName
-
The vendor that owns this vendor
- group: string
-
The group to which this vendor belongs
- state: string inactive, active, suspended, deleted
-
The state of this vendor
- counts: NumberDictionary | null
-
A dictionary of child entity names and their counts, present if the
countsparameter is supplied. - creationDate: string
-
The date this vendor was created
- modifiedDate: string
-
The date that this vendor was last modified
Example
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
VendorListResponse: object
A list of vendor items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: VendorListItem
-
VendorListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"website": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"group": "string",
"state": "string",
"counts": {},
"creationDate": "string",
"modifiedDate": "string"
}
]
}
EmailServerConfiguration: object
- smtpEnabled: boolean | null
- smtpServer: string | null
- smtpPort: number | null (double)
- fromAddress: string | null
- fromName: string | null
- username: string | null
- password: string | null
- enableSsl: boolean | null
- state: string | null active, suspended
Example
{
"smtpEnabled": "boolean",
"smtpServer": "string",
"smtpPort": "number (double)",
"fromAddress": "string",
"fromName": "string",
"username": "string",
"password": "string",
"enableSsl": "boolean",
"state": "string"
}
VendorResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo
-
entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - features: Features | null
-
A set of features that are enabled for this distributor.
- group: string | null
-
The group to which this vendor belongs
- availableMapSets: IdName | null
-
A list of map sets that are made available to the client's of this vendor.
-
IdName - defaultMapSet: IdName | null
-
The default map set that has been defined for this vendor. It may be empty in which case the distributor default will be used.
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this vendor is allowed to use. An empty list means all device types.
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are made available to the client's of this vendor.
-
IdNameState - emailServer: EmailServerConfiguration | null
-
The configuration of a custom email server for this vendor
- clientGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {}
}
}
VendorUpdateRequest: object
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - features: Features | null
-
A set of features that are enabled for this distributor.
- group: string | null
-
The group to which this vendor belongs
- availableMapSets: IdName | null
-
A list of map sets that are made available to the client's of this vendor.
-
IdName - defaultMapSet: IdName | null
-
The default map set that has been defined for this vendor. It may be empty in which case the distributor default will be used.
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this vendor is allowed to use. An empty list means all device types.
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are made available to the client's of this vendor.
-
IdNameState - emailServer: EmailServerConfiguration | null
-
The configuration of a custom email server for this vendor
- clientGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
VendorDetailsUpdateRequest: object
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - emailServer: EmailServerConfiguration | null
-
The configuration of a custom email server for this vendor
- clientGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName
Example
{
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
],
"emailServer": {
"smtpEnabled": "boolean",
"smtpServer": "string",
"smtpPort": "number (double)",
"fromAddress": "string",
"fromName": "string",
"username": "string",
"password": "string",
"enableSsl": "boolean",
"state": "string"
},
"clientGroups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
VendorCreateRequest: object
- name: string | null
-
The display name of the company
- tags: string[] | null
-
A list of custom ID's for this company. Can be queried using the getClientByTag, getVendorByTag and getDistributorByTag methods.
-
string - website: string | null
-
The company website (if available)
- state: string | null inactive, active, suspended, deleted
-
The state of this company
- entity: EntityInfo | null
-
Entity specific metadata
- limits: SoftLimits | null
-
Soft limits that apply to this company. This includes overrides only, see
getLookupsfor defaults. - flags: FlagsBucket | null
-
A set of user defined flags
- retention: CompanyDataRetentionSettings | null
-
Data retention settings. If this is null, settings from the parent or group will be used instead.
- passwordPolicy: UserPasswordPolicy | null
-
Password policy to apply to users. If this is null, settings from the group will be used instead.
- theme: ThemeInfo | null
-
The theme that this company uses
- address: CompanyAddress | null
-
Address information for this company
- timeZoneId: string | null
-
The default timezone for this company
- customFields: CustomFields | null
-
A set of custom fields for this company
- domains: string[] | null
-
A list of custom domains to use for this company
-
string - language: string | null
-
The default language to user for this client.
- support: CompanySupportDetails | null
-
Support contact information that will be displayed to user of this company
- messages: CompanyMessages | null
-
Customized messages that are displayed to users of this company.
- oidc: OpenIdConnectIssuers | null
-
A set of OpenId Connect issuers that are able to authenticate users on our behalf.
- emailProvider: IdNameState | null
-
The email provider to be used when sending emails
- sslCertificates: CompanySSLCertificate | null
-
A list of ssl certificates provisioned for this company
-
CompanySSLCertificate - features: Features | null
-
A set of features that are enabled for this distributor.
- group: string | null
-
The group to which this vendor belongs
- availableMapSets: IdName | null
-
A list of map sets that are made available to the client's of this vendor.
-
IdName - defaultMapSet: IdName | null
-
The default map set that has been defined for this vendor. It may be empty in which case the distributor default will be used.
- availableDeviceTypes: IdName | null
-
UUID's of the device types that this vendor is allowed to use. An empty list means all device types.
-
IdName - availableEmailProviders: IdNameState | null
-
A list of email providers that are made available to the client's of this vendor.
-
IdNameState - emailServer: EmailServerConfiguration | null
-
The configuration of a custom email server for this vendor
- clientGroups: IdName | null
-
[DEPRECATED] Use the listCompanyGroups operation instead
-
IdName - ownerId: string
Example
{
"name": "string",
"tags": [
"string"
],
"website": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"limits": {
"entities": {}
},
"flags": {},
"retention": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"retainFor": "number (double)",
"retainForUnit": "string",
"horizonDate": "string"
},
"passwordPolicy": {
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"passwordLength": "number (double)",
"passwordComplexity": {
"mixedCase": "boolean",
"alphaNumerical": "boolean",
"specialCharacters": "boolean",
"noCommonPasswords": "boolean"
},
"passwordExpirationDays": "number (double)",
"otpSettings": {
"methods": {},
"mandatoryFor": "string",
"gracePeriodDays": "number (double)"
}
},
"theme": {
"id": "string",
"name": "string",
"settings": {}
},
"address": {
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"code": "string"
},
"timeZoneId": "string",
"customFields": {},
"domains": [
"string"
],
"language": "string",
"support": {
"email": "string",
"phone": "string"
},
"messages": {
"login": "string",
"suspended": "string"
},
"oidc": {},
"emailProvider": {
"id": "string",
"name": "string",
"state": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sslCertificates": [
{
"id": "string",
"domain": "string",
"modifiedDate": "string",
"state": "string"
}
]
}
UserOTPMethod: object
- type: string
-
The type of OTP
- date: string | null
-
The date on which this OTP method was configured
- verified: boolean
-
Whether this OTP method has been verified or not. If false, enrolment may be required before using this method.
Example
{
"type": "string",
"date": "string",
"verified": "boolean"
}
AuthOtpStatus: object
- methods: UserOTPMethod
-
The type of OTP that is required for this user.
-
UserOTPMethod - requiredFrom: string
-
Date by which the user is required to use OTP authentication.
- authenticated: boolean
-
If true, the cached OTP token for the user has been accepted, and OTP can be skipped.
- tokenValidityDays: number (double)
-
The number of days for which any OTP tokens returned by the API will be valid for
Example
{
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
}
AuthUserResponse: object
- id: string
-
The unique user identifier
- username: string
-
The user's username (usually his email address)
- name: string
-
The user's full name
- owner: IdNameType
-
The entity that owns this user
- defaultClient: IdName
-
The client that has been configured as the default for this user
- costCentre: IdName
-
The cost centre to which this user belongs
- timeZoneId: string
-
The user's timezone, either as a region/city value (i.e. America/New_York) or a specific timezone (i.e. GMT+2)
- language: string
-
The user's chosen language
- otp: AuthOtpStatus
-
Information about one time password requirements
- passwordExpiresOn: string
-
The ISO date on which the users current password expires
Example
{
"id": "string",
"username": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"timeZoneId": "string",
"language": "string",
"otp": {
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
},
"passwordExpiresOn": "string"
}
UserSessionResponse: object
- idToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. Additional information is also included in this token such as the default client id and user's full name and surname. The id token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- accessToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. The access token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- refreshToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token can be used to refresh a user's access and id tokens. The access token expires one hour after the user authenticates and the refresh token is valid for 30 days. You should not process the access token in your client or web API after it has expired.
- users: AuthUserResponse
-
An array of users that match the authentication information
-
AuthUserResponse
Example
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"users": [
{
"id": "string",
"username": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"timeZoneId": "string",
"language": "string",
"otp": {
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
},
"passwordExpiresOn": "string"
}
]
}
AuthRequest: object
- domain: string | null
-
Optionally pass the domain for which this login is restricted to. Required for OpenId Connect
id_tokenbased authentication. - username: string | null
-
The username to authenticate against, usually an email address. Required for password validation.
- password: string | null
-
The password for the specified username. Required if you passed a username.
- userId: string | null
-
Optional - if multiple matching users are expected, you can pre-select the user you want by passing in the user id
- token: string | null
-
Optional token based authentication. This could be a password reset token or an OpenId Connect
id_token. Username and password are ignored if a token is passed.
Example
{
"domain": "string",
"username": "string",
"password": "string",
"userId": "string",
"token": "string"
}
SignOutRequest: object
- session: string | null
-
Pass a session ID if you want to sign out a particular session, leave empty to sign out from the current session
Example
{
"session": "string"
}
SelectedUserTokenResponse: object
- idToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. Additional information is also included in this token such as the default client id and user's full name and surname. The id token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- accessToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. The access token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- refreshToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token can be used to refresh a user's access and id tokens. The access token expires one hour after the user authenticates and the refresh token is valid for 30 days. You should not process the access token in your client or web API after it has expired.
- user: AuthUserResponse | null
-
The user that was selected
Example
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"user": {
"id": "string",
"username": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"timeZoneId": "string",
"language": "string",
"otp": {
"methods": [
{
"type": "string",
"date": "string",
"verified": "boolean"
}
],
"requiredFrom": "string",
"authenticated": "boolean",
"tokenValidityDays": "number (double)"
},
"passwordExpiresOn": "string"
}
}
TokenResponse: object
- idToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. Additional information is also included in this token such as the default client id and user's full name and surname. The id token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- accessToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. The access token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- refreshToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token can be used to refresh a user's access and id tokens. The access token expires one hour after the user authenticates and the refresh token is valid for 30 days. You should not process the access token in your client or web API after it has expired.
Example
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string"
}
AuthRefreshTokenRequest: object
- refreshToken: string
-
A valid user refresh token
Example
{
"refreshToken": "string"
}
AuthResetPasswordRequest: object
- resetUrl: string
-
The full URL where the user will be redirected for password reset. Include a {token} template variable so the API can insert the reset token. i.e. https://example.com/reset?token={token}
- username: string
-
The username to reset, usually an email address.
Example
{
"resetUrl": "string",
"username": "string"
}
AuthSetPasswordRequest: object
- token: string
-
The reset token that was sent to the user.
- newPassword: string
-
The user's new password
Example
{
"token": "string",
"newPassword": "string"
}
UpdateUserPasswordRequest: object
- oldPassword: string
-
The user's current password.
- newPassword: string
-
The user's new password
Example
{
"oldPassword": "string",
"newPassword": "string"
}
UserSession: object
Information about a logged in user session
- id: string
-
The unique ID of this session
- userId: string
-
The user UUID
- start: string
-
The ISO date when the session was started
- expiry: string
-
The expiry date of the session (can be extended with token refreshes)
- ip: string
-
The IP address of the user that initiated or last refreshed the session
- hostname: string
-
The hostname of the front-end from which the session was created
- agent: string
-
The browser user agent string of the user
- invalidated: boolean | null
-
A flag indicating if the session has been invalidated
- current: boolean
-
True if this session is the same session from which this request was made
Example
{
"id": "string",
"userId": "string",
"start": "string",
"expiry": "string",
"ip": "string",
"hostname": "string",
"agent": "string",
"invalidated": "boolean",
"current": "boolean"
}
UserProfileResponse: object
Information about a users profile
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
- emailAddress: string | null
-
The user's email address, used to log into the system
- mobile: string | null
-
An optional mobile number used for SMS notifications
- timeZoneId: string | null
-
The time zone identifier for the user (uses the tz database for timezones, see https://en.wikipedia.org/wiki/Tz_database)
- language: string | null
-
The language code for this user
- state: string | null inactive, active, suspended, deleted
-
The state of the user object
- notifySettings: NotificationSettings | null
-
notification settings
- defaultClient: IdName | null
-
The default client to load for this user
- roles: IdName | null
-
A list of user roles that apply to this user
-
IdName - costCentre: IdName | null
-
The cost centre that this user belongs to
- oidcTags: OidcTags | null
-
When OpenId Connect is enabled for a client, you need to tie the user to the issuer's internal user ID. Specificy them in the oidcTags bucket
- permissions: UserPermissions | null
- apiKeys: ApiKeys | null
-
An optional set of API keys generated by the user
- otp: UserOtpMethod | null
-
Lists the types of one time password methods that have been configured for this user
-
UserOtpMethod - entity: EntityInfo
- sessions: UserSession
-
A list of user session information
-
UserSession
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"emailAddress": "string",
"mobile": "string",
"timeZoneId": "string",
"language": "string",
"state": "string",
"notifySettings": {
"smsTime": {
"from": "string",
"to": "string"
},
"actions": {
"low": "string",
"medium": "string",
"high": "string"
}
},
"defaultClient": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"oidcTags": {},
"permissions": {
"clients": {}
},
"apiKeys": {},
"otp": [
{
"type": "string",
"date": "string",
"verfied": "boolean"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"sessions": [
{
"id": "string",
"userId": "string",
"start": "string",
"expiry": "string",
"ip": "string",
"hostname": "string",
"agent": "string",
"invalidated": "boolean",
"current": "boolean"
}
]
}
AuthOTPGenerateResponse: object
- secret: string
-
The shared secret used to configure authenticator applications
- totpAuthUrl: string
-
A url that can be used to generate a QR code to configure an authenticator application
Example
{
"secret": "string",
"totpAuthUrl": "string"
}
AuthOTPSendResponse: object
- method: string
-
The method by which the OTP was sent
- destination: string
-
The destination to which the OTP was sent
Example
{
"method": "string",
"destination": "string"
}
AuthOTPValidateResponse: object
- idToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. Additional information is also included in this token such as the default client id and user's full name and surname. The id token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- accessToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token contains claims about the identity of the authenticated user. The access token expires one hour after the user authenticates. You should not process the access token in your client or web API after it has expired.
- refreshToken: string
-
The JWT token is represented as a JSON Web Token (JWT). The token can be used to refresh a user's access and id tokens. The access token expires one hour after the user authenticates and the refresh token is valid for 30 days. You should not process the access token in your client or web API after it has expired.
- otpToken: string
-
Returns a token that can be used to skip OTP on the next sign in
- verified: boolean
-
Will be true if the OTP code passed in was successfully verified
Example
{
"idToken": "string",
"accessToken": "string",
"refreshToken": "string",
"otpToken": "string",
"verified": "boolean"
}
AuthOTPValidateRequest: object
- code: string
-
A OTP code generated by the users authenticator application
Example
{
"code": "string"
}
NotificationResponse: object
- id: string
-
The unique ID for the notification event
- owner: IdNameType
-
The owner company of the notification event
- user: IdName
-
The user that triggered the notification event
- date: string
-
The UTC date when the notification event was recorded in the system
- sequence: number (double)
-
A sequence number that can be used to traverse the notification feed
- eventType: string
-
The type of event in the given class
- text: string
-
The text description of the event
- data: Dictionary
-
Event specific information
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"sequence": "number (double)",
"eventType": "string",
"text": "string",
"data": {}
}
NotificationFeedResponse: object
Example
{
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"sequence": "number (double)",
"eventType": "string",
"text": "string",
"data": {}
}
]
}
TelemetryTrip: object
- start: string
- startAddress: string
- startLon: number (double)
- startLat: number (double)
- distance: number (double)
- lastLon: number (double)
- lastLat: number (double)
Example
{
"start": "string",
"startAddress": "string",
"startLon": "number (double)",
"startLat": "number (double)",
"distance": "number (double)",
"lastLon": "number (double)",
"lastLat": "number (double)"
}
PrivacyScheduleItem: object
- id: string
-
The unique ID of this item
- days: number[]
-
The days of the week that this profile is active for (0 - 6, 0 = Sunday)
-
number (double) - from: string
-
The time from which this privacy starts (HH:mm:ss)
- to: string
-
The time at which this privacy ends (HH:mm:ss)
- timeZoneId: string
-
The time zone ID of the time values
Example
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
PrivacyStateItem: object
- id: string
-
The unique ID of this item
- stateProfileId: string
-
The asset state profile id
- stateValue: string
-
The state profile value to trigger on
Example
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
AssetPrivacyResponse: object
- end: string
-
The date and time (YYYY/MM/DD HH:mm:ss) when the privacy mode should end.
- trips: number (double)
-
The number of subsequent trips that should be marked as private. Set to 0 to mark all trips as private until the end date or this privacy mode is removed.
- user: IdName
-
The user that initiated the privacy mode
- start: string
-
The date and time (YYYY/MM/DD HH:mm:ss) when the privacy mode was initiated.
Example
{
"end": "string",
"trips": "number (double)",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"start": "string"
}
TelemetryStatePrivacy: object
- source: string
-
The source of the current privacy mode (scheduled, assetstate or user)
- scheduleTrigger: PrivacyScheduleItem | null
-
The scheduled trigger (if source is scheduled)
- assetStateTrigger: PrivacyStateItem | null
-
The asset state trigger responsible (if source is assetstate)
- userTrigger: AssetPrivacyResponse | null
-
Information about the user initiated privacy mode (if source is user)
Example
{
"source": "string",
"scheduleTrigger": {
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
},
"assetStateTrigger": {
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
},
"userTrigger": {
"end": "string",
"trips": "number (double)",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"start": "string"
}
}
TelemetryState: object
- state: string
- color: string
Example
{
"state": "string",
"color": "string"
}
SpeedLimits: object
- rd: number (double)
-
likely road speed
- mx: number (double)
-
maximum road speed in the vicinity
- un: number (double)
-
speed unit (0 = kph, 1 = mph)
- md: number | null (double)
-
road speed modifier limit (if available)
Example
{
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
}
ReverseGeocode: object
- rd: string | null
-
Road name
- rt: string | null
-
Route Name
- sb: string | null
-
Suburb name
- tw: string | null
-
Town name
- pr: string | null
-
Province or state namee
- pc: string | null
-
Post code
- ct: string | null
-
City name
- dc: number | null (double)
-
Dual Carriage (0 = single, 1 = dual)
Example
{
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
TelemetryLocation: object
- lon: number (double)
-
The WGS84 longitude in decimal degrees
- lat: number (double)
-
The WGS84 latitude in decimal degrees
- speed: number (double)
-
The speed in km/h
- altitude: number (double)
-
The altitude above sea level in meters
- heading: number (double)
-
The heading in degrees
- accuracy: number (double)
-
The accuracy of the location (usually the number of satellites visible, but varies by device)
- address: string | null
-
The reverse geocoded address of this location. May also be the name of a zone that is currently been entered.
- age: number | null (double)
-
The age of the gps position. Not sent by all devices.
- gc: ReverseGeocode | null
-
Detailed reverse geoding information
Example
{
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
}
TelemetryIOValue: object
- type: string
- input: string
- name: string | null
- value: object | null
- text: object | null
- unit: string | null
- err: string | null
Example
{
"type": "string",
"input": "string",
"name": "string",
"value": "object",
"text": "object",
"unit": "string",
"err": "string"
}
TelemetryStateResponse: object
- origin: IdName | null
-
The device that generated this telemetry message
- date: string
-
The ISO8601 UTC date that the message was generated by the device
- received: string
-
The ISO8601 UTC date that the message was received by the system
- active: boolean | null
-
True if the device is in an active state
- linked: IdNameType
-
A list of assets linked to this telemetry message
-
IdNameType - zones: IdNameType | null
-
A list of zones which are relevant to this location
-
IdNameType - routes: IdName | null
-
A list of routes which are relevant to this location
-
IdName - state: TelemetryStateDictionary | null
-
The relevant asset state for this message
- spd: SpeedLimits | null
-
If road speed is enabled, the speed limit information retrieved from reverse geocoding
- location: TelemetryLocation | null
-
The current location where this message was generated
- telemetry: Dictionary | null
-
A list of telemetry states and values for this message
- counters: NumberDictionary | null
-
A list of counter values for this message
- io: TelemetryIOValues | null
-
Parsed IO values for this message
- meta: Dictionary | null
-
A dictionary of meta information generated in the system during processing
- object: IdNameType | null
-
The asset that this information belongs to
- trip: TelemetryTrip | null
-
Details about the last in progress trip
- lastMovement: string | null
-
The last time that the asset moved.
- lastTripEnd: string | null
-
The time when the last trip ended.
- privacy: TelemetryStatePrivacy | null
-
Information about any privacy state that currently applies to this asset
Example
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {},
"meta": {},
"object": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"trip": {
"start": "string",
"startAddress": "string",
"startLon": "number (double)",
"startLat": "number (double)",
"distance": "number (double)",
"lastLon": "number (double)",
"lastLat": "number (double)"
},
"lastMovement": "string",
"lastTripEnd": "string",
"privacy": {
"source": "string"
}
}
TelemetryFeedResponse: object
A list of telemetry items
- sequence: number (double)
-
sequence for the feed
- count: number (double)
-
number of items in the feed
- items: TelemetryStateResponse
-
TelemetryStateResponse
Example
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {},
"meta": {},
"object": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"trip": {
"start": "string",
"startAddress": "string",
"startLon": "number (double)",
"startLat": "number (double)",
"distance": "number (double)",
"lastLon": "number (double)",
"lastLat": "number (double)"
}
}
]
}
TripLocation: object
- lon: number (double)
-
The WGS84 longitude in decimal degrees
- lat: number (double)
-
The WGS84 latitude in decimal degrees
- address: string
-
The reverse geocoded address of this location. May also be the name of a zone that is currently been entered.
- counters: Dictionary
-
The telemetry counter values at this point
- odometer: number | null (double)
-
The calculated odometer, in km
- hours: number | null (double)
-
The calculated hours
Example
{
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
}
TripStats: object
- driveTime: number (double)
-
The number of seconds spend driving (active and speed > 0)
- idleTime: number (double)
-
The number of seconds spend idling (active and speed < 0)
- distance: number (double)
-
The distance driven in km
Example
{
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
}
TripRatingPenalty: object
- id: string
-
The unique id for this penalty
- name: string
-
Name of the penalty
- instances: number (double)
-
Number of instances that this penalty occurred
- score: number (double)
-
Score for this penalty
- max: number (double)
- cost: number (double)
-
The monetary cost incurred each time this incident occurs
Example
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
TripRating: object
- profile: string
- score: number (double)
- penalties: TripRatingPenalty
-
TripRatingPenalty
Example
{
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
}
LabelValuePayload: object
- label: string
-
A lowercase alphanumeric label value
- name: string
-
A friendly descriptive name for label
- color: string | null
-
An optional color for this label
Example
{
"label": "string",
"name": "string",
"color": "string"
}
TripResponse: object
- id: string
-
Unique id for this trip
- asset: IdName
-
The asset that generated this trip
- assetType: IdName
-
The type of this asset
- tripType: string inactive, active, mixed
-
The type of this trip
- dateStart: string
-
The ISO8601 UTC date that the trip was started
- dateEnd: string
-
The ISO8601 UTC date that the trip was ended
- start: TripLocation | null
-
The location where the trip started
- end: TripLocation | null
-
The location where the trip ended
- stats: TripStats | null
-
Statistics about the trip
- rating: TripRating | null
-
Trip rating information
- records: number | null (double)
-
The number of telemetry records that comprised this trip
- linkedAssets: IdNameType
-
Any other assets that were linked to this trip
-
IdNameType - maxes: NumberDictionary | null
-
Max values for the trip
- labels: LabelValuePayload | null
-
An optional list of labels assigned to this trip
-
LabelValuePayload - private: boolean | null
-
Indication of whether this trip is private or not
Example
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
TripFeedResponse: object
A list of trip items
- sequence: number (double)
-
sequence for the feed
- count: number (double)
-
number of items in the feed
- items: TripResponse
-
TripResponse
Example
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
]
}
EventMedia: object
- input: string
- date: string
- user: IdName | null
- mediaType: string video, photo
- filename: string
- error: string | null
Example
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
EventHandled: object
- date: string
-
The UTC date that the event was handled
- user: IdName
-
The user that handled the event
Example
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
EventComment: object
- date: string
-
The UTC date that the comment was created
- user: IdName
-
The user that created the comment
- comment: string
-
The comment text
- values: Dictionary | null
-
Values populated from custom field controls
Example
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
EventResponse: object
- id: string
-
The unique ID for the event
- owner: IdNameType
-
The owner company of the event
- origin: IdNameType | null
-
The originator of the event
- linked: IdNameType
-
Assets and devices that are linked to this event
-
IdNameType - alerts: IdNameType
-
Any alerts this event may have triggered
-
IdNameType - notify: IdName
-
Users that were notified of this event
-
IdName - media: EventMedia
-
Media that's linked to this event
-
EventMedia - eventDate: string
-
The UTC date of the event as recorded by the device that triggered it
- creationDate: string
-
The UTC date when the evetn was created in the system
- modifiedDate: string
-
The UTC date when this event was last modified
- eventClass: string
-
The class of the event
- eventType: string
-
The type of event in the given class
- handledBy: EventHandled | null
-
Populated if the event/alert has been handled by a user
- comments: EventComment
-
List of comments that users have left on this event
-
EventComment - details: Dictionary
-
An event class specific bag of details relating to this event
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string",
"values": {}
}
],
"details": {}
}
EventFeedResponse: object
A list of trip items
- sequence: number (double)
-
sequence for the feed
- count: number (double)
-
number of items in the feed
- items: EventResponse
-
EventResponse
Example
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"comment": "string"
}
]
}
]
}
AuditEventKeyValue: object
- key: string
- value: string
Example
{
"key": "string",
"value": "string"
}
AuditEventChange: object
- action: string added, modified, removed
- field: string
- name: string
- oldValue: AuditEventKeyValue | null
- newValue: AuditEventKeyValue | null
Example
{
"action": "string",
"field": "string",
"name": "string",
"oldValue": {
"key": "string",
"value": "string"
},
"newValue": {
"key": "string",
"value": "string"
}
}
AuditEventResponse: object
- id: string
-
The unique ID for the event
- owner: IdNameType
-
The owner company of the event
- entity: IdNameType
-
The user that triggered the event
- user: IdName
-
The user that triggered the event
- date: string
-
The UTC date when the event was recorded in the system
- eventClass: string
-
The class of the event
- eventType: string created, modified, deleted
-
The type of event in the given class
- changes: AuditEventChange
-
A list of changes that were applied
-
AuditEventChange
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"eventClass": "string",
"eventType": "string",
"changes": [
{
"action": "string",
"field": "string",
"name": "string",
"oldValue": {
"key": "string",
"value": "string"
},
"newValue": {
"key": "string",
"value": "string"
}
}
]
}
AuditEventFeedResponse: object
A list of audit event items
- sequence: number (double)
-
sequence for the feed
- count: number (double)
-
number of items in the feed
- items: AuditEventResponse
-
AuditEventResponse
Example
{
"sequence": "number (double)",
"count": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"eventClass": "string",
"eventType": "string",
"changes": [
{
"action": "string",
"field": "string",
"name": "string",
"oldValue": {
"key": "string",
"value": "string"
},
"newValue": {
"key": "string",
"value": "string"
}
}
]
}
]
}
EventCommentRequest: object
- comment: string | null
-
The comment text
- values: Dictionary | null
Example
{
"comment": "string",
"values": {}
}
TelemetryResponse: object
- origin: IdName | null
-
The device that generated this telemetry message
- date: string
-
The ISO8601 UTC date that the message was generated by the device
- received: string
-
The ISO8601 UTC date that the message was received by the system
- active: boolean | null
-
True if the device is in an active state
- linked: IdNameType
-
A list of assets linked to this telemetry message
-
IdNameType - zones: IdNameType | null
-
A list of zones which are relevant to this location
-
IdNameType - routes: IdName | null
-
A list of routes which are relevant to this location
-
IdName - state: TelemetryStateDictionary | null
-
The relevant asset state for this message
- spd: SpeedLimits | null
-
If road speed is enabled, the speed limit information retrieved from reverse geocoding
- location: TelemetryLocation | null
-
The current location where this message was generated
- telemetry: Dictionary | null
-
A list of telemetry states and values for this message
- counters: NumberDictionary | null
-
A list of counter values for this message
- io: TelemetryIOValues | null
-
Parsed IO values for this message
Example
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {}
}
TelemetryListResponse: object
A list of telemetry items
- count: number (double)
-
total number of records in the result set
- limit: number (double)
-
the max number of items returned in the result set
- start: string
-
ISO start date of the request
- end: string
-
ISO end date of the request
- items: TelemetryResponse
-
Telemetry items
-
TelemetryResponse
Example
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"origin": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": "string",
"received": "string",
"active": "boolean",
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"zones": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"routes": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"state": {},
"spd": {
"rd": "number (double)",
"mx": "number (double)",
"un": "number (double)",
"md": "number (double)"
},
"location": {
"lon": "number (double)",
"lat": "number (double)",
"speed": "number (double)",
"altitude": "number (double)",
"heading": "number (double)",
"accuracy": "number (double)",
"address": "string",
"age": "number (double)",
"gc": {
"rd": "string",
"rt": "string",
"sb": "string",
"tw": "string",
"pr": "string",
"pc": "string",
"ct": "string",
"dc": "number (double)"
}
},
"telemetry": {},
"counters": {},
"io": {}
}
]
}
BadRequestError: object
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
- status: number | null (double) 400
- name: string | null BadRequestError
- message: string | null Invalid request
- data: object | null
Example
{
"status": "number (double)",
"name": "string",
"message": "string",
"data": "object"
}
EventListResponse: object
A list of event items
- count: number (double)
-
total number of records in the result set
- limit: number (double)
-
the max number of items returned in the result set
- start: string
-
ISO start date of the request
- end: string
-
ISO end date of the request
- items: EventResponse
-
Event items
-
EventResponse
Example
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"alerts": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"notify": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"media": [
{
"input": "string",
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mediaType": "string",
"filename": "string",
"error": "string"
}
],
"eventDate": "string",
"creationDate": "string",
"modifiedDate": "string",
"eventClass": "string",
"eventType": "string",
"handledBy": {
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
},
"comments": [
{
"date": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
]
}
]
}
TripListResponse: object
A list of trip items
- count: number (double)
-
total number of records in the result set
- limit: number (double)
-
the max number of items returned in the result set
- start: string
-
ISO start date of the request
- end: string
-
ISO end date of the request
- items: TripResponse
-
Trip items
-
TripResponse
Example
{
"count": "number (double)",
"limit": "number (double)",
"start": "string",
"end": "string",
"items": [
{
"id": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tripType": "string",
"dateStart": "string",
"dateEnd": "string",
"start": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"end": {
"lon": "number (double)",
"lat": "number (double)",
"address": "string",
"counters": {},
"odometer": "number (double)",
"hours": "number (double)"
},
"stats": {
"driveTime": "number (double)",
"idleTime": "number (double)",
"distance": "number (double)"
},
"rating": {
"profile": "string",
"score": "number (double)",
"penalties": [
{
"id": "string",
"name": "string",
"instances": "number (double)",
"score": "number (double)",
"max": "number (double)",
"cost": "number (double)"
}
]
},
"records": "number (double)",
"linkedAssets": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"maxes": {},
"labels": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"private": "boolean"
}
]
}
LogMessage: object
- level: string
- timestamp: string
- message: string
Example
{
"level": "string",
"timestamp": "string",
"message": "string"
}
LogResponse: object
- items: LogMessage
-
LogMessage
Example
{
"items": [
{
"level": "string",
"timestamp": "string",
"message": "string"
}
]
}
EventActionFilter: object
- eventClass: string
- eventType: string | null
- targetType: string | null
- text: string
Example
{
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
}
EventTargetFilter: object
- targetType: string | null
- targetTypeId: string | null
- targetTypeName: string | null
- targetSelectionType: string any, group, specific
- targetId: string | null
- targetName: string | null
- text: string | null
Example
{
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
}
EventFilterCondition: object
- type: string
- values: EventFilterConditionDictionary
- text: EventFilterConditionDictionary
Example
{
"type": "string",
"values": {},
"text": {}
}
EventFilter: object
- actor: EventActorFilter | null
- action: EventActionFilter | null
- target: EventTargetFilter | null
- conditions: EventFilterCondition | null
-
EventFilterCondition
Example
{
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
AlertListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
A unique name for this alert
- state: string active, deleted
-
The current state of this alert
- costCentre: IdName
-
The cost centre that this alert applies to
- priority: string low, medium, high
-
The priority of this alert
- filter: EventFilter | null
-
The filter that this alert matches on
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"modifiedDate": "string"
}
AlertListResponse: object
A list of alert items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AlertListItem
-
AlertListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"modifiedDate": "string"
}
]
}
AlertNotify: object
- type: string user, role
- id: string
- name: string
Example
{
"type": "string",
"id": "string",
"name": "string"
}
AlertAction: object
- type: string request_video, request_photo, label_current_trip
- id: string
- options: object
Example
{
"type": "string",
"id": "string",
"options": "object"
}
AlertResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this alert
- state: string | null active, deleted
-
The current state of this alert
- costCentre: IdName | null
-
The cost centre that this alert applies to
- priority: string | null low, medium, high
-
The priority of this alert
- filter: EventFilter | null
-
The filter that this alert matches on
- notify: AlertNotify | null
-
A list of users and roles that will be notified if this alert triggers.
-
AlertNotify - actions: AlertAction | null
-
A list of actions to be performed once this alert triggers.
-
AlertAction - entity: EntityInfo | null
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AlertUpdateRequest: object
- name: string | null
-
A unique name for this alert
- state: string | null active, deleted
-
The current state of this alert
- costCentre: IdName | null
-
The cost centre that this alert applies to
- priority: string | null low, medium, high
-
The priority of this alert
- filter: EventFilter | null
-
The filter that this alert matches on
- notify: AlertNotify | null
-
A list of users and roles that will be notified if this alert triggers.
-
AlertNotify - actions: AlertAction | null
-
A list of actions to be performed once this alert triggers.
-
AlertAction
Example
{
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
]
}
AlertCreateRequest: object
- name: string | null
-
A unique name for this alert
- state: string | null active, deleted
-
The current state of this alert
- costCentre: IdName | null
-
The cost centre that this alert applies to
- priority: string | null low, medium, high
-
The priority of this alert
- filter: EventFilter | null
-
The filter that this alert matches on
- notify: AlertNotify | null
-
A list of users and roles that will be notified if this alert triggers.
-
AlertNotify - actions: AlertAction | null
-
A list of actions to be performed once this alert triggers.
-
AlertAction - ownerId: string
-
The client that owns this Alert
Example
{
"name": "string",
"state": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"priority": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"notify": [
{
"type": "string",
"id": "string",
"name": "string"
}
],
"actions": [
{
"type": "string",
"id": "string",
"options": "object"
}
],
"ownerId": "string"
}
Contact: object
Contacts can be assigned to assets and will be displayed along side any asset related information.
- id: string
-
A unique id for this contact
- type: string emergency, administrative, technical, operational, management, owner
-
The type of contact
- name: string
-
The name of the contact person or company
- emailAddress: string | null
-
The contact person's email address
- phoneMobile: string | null
-
The mobile phone number of the contact
- phoneOffice: string | null
-
An optional office number for the contact
- notes: string | null
-
Any notes regarding this contact
Example
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
AssetCategoryResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- index: number | null (double)
-
The index number of this asset category (0 - 4)
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- contacts: Contact | null
-
A list of contacts applicable to this asset category
-
Contact - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AssetCategoryListResponse: object
A list of asset category items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetCategoryResponse
-
AssetCategoryResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
AssetCategoryUpdateRequest: object
Example
{
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
AssetCategoryCreateRequest: object
- index: number | null (double)
-
The index number of this asset category (0 - 4)
- name: string
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- contacts: Contact | null
-
A list of contacts applicable to this asset category
-
Contact - ownerId: string
-
The client that owns this entity
Example
{
"index": "number (double)",
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
AssetGroupResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- contacts: Contact | null
-
A list of contacts applicable to this asset group
-
Contact - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AssetGroupListResponse: object
A list of asset group items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetGroupResponse
-
AssetGroupResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
AssetGroupUpdateRequest: object
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
AssetGroupCreateRequest: object
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
AssetRatingPenalty: object
- id: string
-
The unique ID of this penalty item
- name: string
-
A descriptive name for this penalty item
- penalty: number (double)
-
A penalty to apply when this penalty is matched
- max: number (double)
-
The maximum penalty that can be applied for this penalty
- cost: number (double)
-
The monetary cost incurred each time this incident occurs
- filter: EventFilter
-
The filter that this penalty matches on
Example
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
AssetRatingProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetRatingPenalty | null
-
The penalty items for this profile
-
AssetRatingPenalty - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
AssetRatingProfileListResponse: object
A list of asset rating profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetRatingProfileListItem
-
AssetRatingProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
]
}
AssetRatingProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetRatingPenalty | null
-
The penalty items for this profile
-
AssetRatingPenalty - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AssetRatingProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetRatingPenalty | null
-
The penalty items for this profile
-
AssetRatingPenalty
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
]
}
AssetRatingProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetRatingPenalty | null
-
The penalty items for this profile
-
AssetRatingPenalty - ownerId: string
-
The client that owns this Asset Rating Profile
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"penalty": "number (double)",
"max": "number (double)",
"cost": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"ownerId": "string"
}
AssetGeoLock: object
A user can geo lock an asset to a specific location, and be notified should the asset move from that location.
- user: IdName
-
The user that initiated the geo-lock
- lat: number (double)
-
The latitude of the location (in milliarcseconds format)
- lon: number (double)
-
The longitude of the location (in milliarcseconds format)
- radiusKm: number (double)
-
The radius of the geo-lock in kilometers
- start: string
-
The date and time (YYYY/MM/DD HH:mm:ss) when the geolock was initiated.
- end: string
-
The date and time (YYYY/MM/DD HH:mm:ss) when the geolock was ended.
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"lat": "number (double)",
"lon": "number (double)",
"radiusKm": "number (double)",
"start": "string",
"end": "string"
}
AssetListItem: object
- id: string
-
The unique ID for this asset
- name: string
-
A client unique name for this asset. This can be any value that is relevant for the client.
- owner: IdName
-
The client that owns this asset
- sharedWith: IdName
-
One or more clients to which this asset has been shared.
-
IdName - assetType: IdName
-
The type of asset
- groups: IdName
-
One of more asset groups that this asset belongs to
-
IdName - categories: IdName
-
Up to 5 different categories that this asset belongs to
-
IdName - costCentre: IdName
-
The cost centre to which this asset belongs
- devices: IdName
-
One or more devices that provide telemetry data for this asset.
-
IdName - assetTag: string
- tags: string[]
-
string - fields: CustomFieldValues
-
A number of custom field values for this asset.
- color: string blue, lightblue, green, olive, orange, pink, purple, red, teal, yellow, white, gray
-
The color of the icon for this asset
- state: string inactive, active, suspended, deleted
-
The current state of the asset object
- geoLock: AssetGeoLock | null
-
Details about an active geo-lock on this asset (if any)
- cameras: number (double)
-
The number of cameras connected to this asset
Example
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"devices": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": "string",
"tags": [
"string"
],
"fields": {},
"color": "string",
"state": "string",
"geoLock": {
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"lat": "number (double)",
"lon": "number (double)",
"radiusKm": "number (double)",
"start": "string",
"end": "string"
},
"cameras": "number (double)"
}
AssetListResponse: object
A list of asset items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetListItem
-
The list of asset items in this response
-
AssetListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"devices": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": "string",
"tags": [
"string"
],
"fields": {},
"color": "string",
"state": "string",
"geoLock": {
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"lat": "number (double)",
"lon": "number (double)",
"radiusKm": "number (double)",
"start": "string",
"end": "string"
},
"cameras": "number (double)"
}
]
}
AssetLinkage: object
Example
{
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"start": "string",
"end": "string"
}
AssetAnalogParameter: object
- id: string
- name: string
- ioType: string
- minRange: number (double)
- maxRange: number (double)
- rangeDebounce: number (double)
- decValue: number (double)
- incValue: number (double)
Example
{
"id": "string",
"name": "string",
"ioType": "string",
"minRange": "number (double)",
"maxRange": "number (double)",
"rangeDebounce": "number (double)",
"decValue": "number (double)",
"incValue": "number (double)"
}
AssetTemperatureParameter: object
- id: string
- name: string
- ioType: string
- minRange: number (double)
- maxRange: number (double)
- rangeDebounce: number (double)
Example
{
"id": "string",
"name": "string",
"ioType": "string",
"minRange": "number (double)",
"maxRange": "number (double)",
"rangeDebounce": "number (double)"
}
AssetCurfewParameter: object
- id: string
- from: string
- to: string
- days: string[]
-
string - timeZoneId: string
Example
{
"id": "string",
"from": "string",
"to": "string",
"days": [
"string"
],
"timeZoneId": "string"
}
AssetParameters: object
- overspeed: number | null (double)
- overspeedTolerance: number | null (double)
- excessiveIdle: number | null (double)
- borders: string[] | null
-
string - analogs: AssetAnalogParameter | null
-
AssetAnalogParameter - temperatures: AssetTemperatureParameter | null
-
AssetTemperatureParameter - curfews: AssetCurfewParameter | null
-
AssetCurfewParameter - maxTripTime: number | null (double)
- maxTripDistance: number | null (double)
- maxInactiveTime: number | null (double)
Example
{
"overspeed": "number (double)",
"overspeedTolerance": "number (double)",
"excessiveIdle": "number (double)",
"borders": [
"string"
],
"analogs": [
{
"id": "string",
"name": "string",
"ioType": "string",
"minRange": "number (double)",
"maxRange": "number (double)",
"rangeDebounce": "number (double)",
"decValue": "number (double)",
"incValue": "number (double)"
}
],
"temperatures": [
{
"id": "string",
"name": "string",
"ioType": "string",
"minRange": "number (double)",
"maxRange": "number (double)",
"rangeDebounce": "number (double)"
}
],
"curfews": [
{
"id": "string",
"from": "string",
"to": "string",
"days": [
"string"
],
"timeZoneId": "string"
}
],
"maxTripTime": "number (double)",
"maxTripDistance": "number (double)",
"maxInactiveTime": "number (double)"
}
AssetLocation: object
Fixed assets can have their location statically assigned
- address: string
-
An address for this location
- lat: number (double)
-
The latitude of the location (in milliarcseconds format)
- lon: number (double)
-
The longitude of the location (in milliarcseconds format)
Example
{
"address": "string",
"lat": "number (double)",
"lon": "number (double)"
}
AssetZoneTarget: object
- zoneType: string | null location, keepin, nogo, route
- targetSelectionType: string | null any, group, specific
- targetId: string | null
- targetName: string | null
Example
{
"zoneType": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string"
}
AssetResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A client unique name for this asset. This can be any value that is relevant for the client.
- assetType: IdName | null
-
The type of asset
- color: string | null blue, lightblue, green, olive, orange, pink, purple, red, teal, yellow, white, gray
-
The color of the icon for this asset
- tags: string[] | null
-
string - costCentre: IdName | null
-
The cost centre to which this asset belongs
- ratingProfile: IdName | null
-
The trip rating profile to use for this assets trip rating
- assetStateProfiles: IdName | null
-
One or more asset state profiles to use for this asset
-
IdName - overspeedProfile: IdName | null
-
The overspeed profile to use for this asset
- geoLockProfile: IdName | null
-
The geo lock profile to use for this asset
- roadProfile: IdName | null
-
The road profile to use for this asset
- privacyProfile: IdName | null
-
The privacy profile to use for this asset
- groups: IdName | null
-
One of more asset groups that this asset belongs to
-
IdName - categories: IdName | null
-
Up to 5 different categories that this asset belongs to
-
IdName - sharedWith: IdName | null
-
One or more clients to which this asset has been shared.
-
IdName - assetTag: IdName | null
- state: string | null inactive, active, suspended, deleted
-
The current state of the asset object
- fields: CustomFieldValues | null
-
A number of custom field values for this asset.
- parameters: AssetParameters | null
- geoLock: AssetGeoLock | null
-
Details about an active geo-lock on this asset (if any)
- contacts: Contact | null
-
One or more contacts that are relevant to this asset
-
Contact - location: AssetLocation | null
-
For static assets this field can be set with the known location of the asset
- zones: AssetZoneTarget | null
-
A list of zones and routes that are relevant to this asset
-
AssetZoneTarget - defaultTripLabels: string[] | null
-
A list of labels that will be applied to trips from this asset by default.
-
string - devices: IdName | null
-
One or more devices that provide telemetry data for this asset. Can only be modified using the
updateDeviceoperation. -
IdName - linkedFrom: AssetLinkage | null
-
Information about asset linkage, can only be modified with the
linkAssetsoperation. - linkedTo: AssetLinkage | null
-
A list of assets this asset it linked to, can only be modified with the
linkAssetsoperation. -
AssetLinkage - privacy: AssetPrivacyResponse | null
-
If this is set (and the conditions are valid), the asset will run in privacy mode.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
null
]
}
AssetCounterValue: object
Describes a counter value (odometer, engine hours, etc.) at a specific date.
- value: number (double)
-
The value of the counter at a specific point in time (must me km for odometer, and hours for hour couters).
- date: string
-
The date and time at which this counter was recorded.
Example
{
"value": "number (double)",
"date": "string"
}
AssetCounterValues: object
A collection of counter values
- odometer: AssetCounterValue | null
-
The odometer of the asset, expressed as kilometers.
- hours: AssetCounterValue | null
-
The engine hours of the asset, expressed as hours.
Example
{
"odometer": {
"value": "number (double)",
"date": "string"
},
"hours": {
"value": "number (double)",
"date": "string"
}
}
AssetUpdateRequest: object
- name: string | null
-
A client unique name for this asset. This can be any value that is relevant for the client.
- assetType: IdName | null
-
The type of asset
- color: string | null blue, lightblue, green, olive, orange, pink, purple, red, teal, yellow, white, gray
-
The color of the icon for this asset
- tags: string[] | null
-
string - costCentre: IdName | null
-
The cost centre to which this asset belongs
- ratingProfile: IdName | null
-
The trip rating profile to use for this assets trip rating
- assetStateProfiles: IdName | null
-
One or more asset state profiles to use for this asset
-
IdName - overspeedProfile: IdName | null
-
The overspeed profile to use for this asset
- geoLockProfile: IdName | null
-
The geo lock profile to use for this asset
- roadProfile: IdName | null
-
The road profile to use for this asset
- privacyProfile: IdName | null
-
The privacy profile to use for this asset
- groups: IdName | null
-
One of more asset groups that this asset belongs to
-
IdName - categories: IdName | null
-
Up to 5 different categories that this asset belongs to
-
IdName - sharedWith: IdName | null
-
One or more clients to which this asset has been shared.
-
IdName - assetTag: IdName | null
- state: string | null inactive, active, suspended, deleted
-
The current state of the asset object
- fields: CustomFieldValues | null
-
A number of custom field values for this asset.
- parameters: AssetParameters | null
- geoLock: AssetGeoLock | null
-
Details about an active geo-lock on this asset (if any)
- contacts: Contact | null
-
One or more contacts that are relevant to this asset
-
Contact - location: AssetLocation | null
-
For static assets this field can be set with the known location of the asset
- zones: AssetZoneTarget | null
-
A list of zones and routes that are relevant to this asset
-
AssetZoneTarget - defaultTripLabels: string[] | null
-
A list of labels that will be applied to trips from this asset by default.
-
string - counterValues: AssetCounterValues | null
-
Populate this field to supply new odometer and/or engine hours values for the asset.
Example
{
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": {
"id": "string"
}
}
AssetCreateRequest: object
- name: string
-
A client unique name for this asset. This can be any value that is relevant for the client.
- assetType: IdName
-
The type of asset
- color: string | null blue, lightblue, green, olive, orange, pink, purple, red, teal, yellow, white, gray
-
The color of the icon for this asset
- tags: string[] | null
-
string - costCentre: IdName
-
The cost centre to which this asset belongs
- ratingProfile: IdName | null
-
The trip rating profile to use for this assets trip rating
- assetStateProfiles: IdName | null
-
One or more asset state profiles to use for this asset
-
IdName - overspeedProfile: IdName | null
-
The overspeed profile to use for this asset
- geoLockProfile: IdName | null
-
The geo lock profile to use for this asset
- roadProfile: IdName | null
-
The road profile to use for this asset
- privacyProfile: IdName | null
-
The privacy profile to use for this asset
- groups: IdName
-
One of more asset groups that this asset belongs to
-
IdName - categories: IdName | null
-
Up to 5 different categories that this asset belongs to
-
IdName - sharedWith: IdName | null
-
One or more clients to which this asset has been shared.
-
IdName - assetTag: IdName | null
- state: string | null inactive, active, suspended, deleted
-
The current state of the asset object
- fields: CustomFieldValues | null
-
A number of custom field values for this asset.
- parameters: AssetParameters | null
- geoLock: AssetGeoLock | null
-
Details about an active geo-lock on this asset (if any)
- contacts: Contact | null
-
One or more contacts that are relevant to this asset
-
Contact - location: AssetLocation | null
-
For static assets this field can be set with the known location of the asset
- zones: AssetZoneTarget | null
-
A list of zones and routes that are relevant to this asset
-
AssetZoneTarget - defaultTripLabels: string[] | null
-
A list of labels that will be applied to trips from this asset by default.
-
string - ownerId: string
- counterValues: AssetCounterValues | null
-
Populate this field to supply new odometer and/or engine hours values for the asset.
Example
{
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"assetTag": {
"id": "string"
}
}
DestinationAddress: object
- lon: number (double)
-
The WGS84 longitude in decimal degrees
- lat: number (double)
-
The WGS84 latitude in decimal degrees
- address: string | null
-
The reverse geocoded address of this location.
Example
{
"lon": "number (double)",
"lat": "number (double)",
"address": "string"
}
AssetPrivacyPayload: object
Sets up the conditions for manual user initiated privacy mode.
- end: string
-
The date and time (YYYY/MM/DD HH:mm:ss) when the privacy mode should end.
- trips: number (double)
-
The number of subsequent trips that should be marked as private. Set to 0 to mark all trips as private until the end date or this privacy mode is removed.
Example
{
"end": "string",
"trips": "number (double)"
}
AssetPrivacyRequest: object
- conditions: AssetPrivacyPayload | null
-
Set the conditions to put the asset into privacy mode. Set the conditions to "null" to clear privacy mode.
Example
{
"conditions": {
"end": "string",
"trips": "number (double)"
}
}
AssetLinkResponse: object
- source: AssetResponse
-
The source asset for the link
- destination: AssetResponse
-
The destination asset for the link
Example
{
"source": {
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
}
AssetLinkRequest: object
- assetId: string | null
-
The destination UUID of an existing asset. This asset must not be already linked, nor have any devices linked to it.
- asset: AssetCreateRequest | null
-
Details of a new asset to create and link. Cannot be used with 'destinationAddressId'.
- start: string
-
The ISO date/time when the linkage should start
- end: string
-
The ISO date/time when the linkage should end
Example
{
"assetId": "string",
"asset": {
"name": "string",
"assetType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"color": "string",
"tags": [
"string"
],
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ratingProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"assetStateProfiles": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"overspeedProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"geoLockProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"roadProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"privacyProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"groups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"categories": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"sharedWith": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
}
AssetMoveRequest: object
- destinationClientId: string
-
The UUID of the client into which this asset should be moved.
- includeDevice: boolean
-
Whether the linked device should be moved as well
- includeSimCard: boolean
-
Whether the linked SimCard should be moved as well
Example
{
"destinationClientId": "string",
"includeDevice": "boolean",
"includeSimCard": "boolean"
}
AssetStateItem: object
- id: string
-
The unique ID of this state item
- name: string
-
A descriptive name for this state item
- state: string
-
A short name for the state
- color: string
-
A color for the state, defined as a CSS color code (i.e. #3359e6)
- radius: number | null (double)
-
An optional radius (in meters) that describes the width of the path that the asset creates. Useful for coverage applications.
- filter: EventFilter
-
The filter that this state matches on
Example
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
AssetStateProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
A unique name for this entity
- state: string active, deleted
-
The current state of this entity
- items: AssetStateItem
-
The state items for this profile
-
AssetStateItem - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
AssetStateProfileListResponse: object
A list of asset state profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetStateProfileListItem
-
AssetStateProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"modifiedDate": "string"
}
]
}
AssetStateProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetStateItem | null
-
The state items for this profile
-
AssetStateItem - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AssetStateProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetStateItem | null
-
The state items for this profile
-
AssetStateItem
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
]
}
AssetStateProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: AssetStateItem | null
-
The state items for this profile
-
AssetStateItem - ownerId: string
-
The client that owns this Asset State Profile
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"state": "string",
"color": "string",
"radius": "number (double)",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
}
}
],
"ownerId": "string"
}
AssetTagListItem: object
- id: string
-
The unique UUID for this Asset Tag
- owner: IdName
-
The client that owns this Asset Tag
- name: string
-
The serial number of the Asset Tag that is used to uniquely identify it.
- serialNumber: string
-
The serial number of the Asset Tag that is used to uniquely identify it.
- assetTagType: IdName
-
The type of asset tag
- mode: string movable, fixed, stock
-
The asset tag operation mode. Options are 'movable' for movable assets, 'fixed' for fixed assets and 'stock' for temporary stock control uses.
- state: string active, deleted
-
The current state of the object
- asset: IdName
-
The asset to which this tag is currently assigned
- fields: CustomFieldValues
-
A number of custom field values for this assettag.
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"serialNumber": "string",
"assetTagType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mode": "string",
"state": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
AssetTagListResponse: object
A list of Asset Tag items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetTagListItem
-
The list of Asset Tag items in this response
-
AssetTagListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"serialNumber": "string",
"assetTagType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mode": "string",
"state": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
]
}
AssetTagResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A friendly name to identify this tag
- serialNumber: string | null
-
The serial number of the Asset Tag that is used to uniquely identify it.
- assetTagType: IdName | null
-
The type of asset tag
- mode: string | null movable, fixed, stock
-
The asset tag operation mode. Options are 'movable' for movable assets, 'fixed' for fixed assets and 'stock' for temporary stock control uses.
- state: string | null active, deleted
-
The current state of the object
- asset: IdName | null
-
The asset to which this tag is currently assigned
- fields: CustomFieldValues | null
-
A number of custom field values for this assettag.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"serialNumber": "string",
"assetTagType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mode": "string",
"state": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
AssetTagUpdateRequest: object
- name: string | null
-
A friendly name to identify this tag
- serialNumber: string | null
-
The serial number of the Asset Tag that is used to uniquely identify it.
- assetTagType: IdName | null
-
The type of asset tag
- mode: string | null movable, fixed, stock
-
The asset tag operation mode. Options are 'movable' for movable assets, 'fixed' for fixed assets and 'stock' for temporary stock control uses.
- state: string | null active, deleted
-
The current state of the object
- asset: IdName | null
-
The asset to which this tag is currently assigned
- fields: CustomFieldValues | null
-
A number of custom field values for this assettag.
Example
{
"name": "string",
"serialNumber": "string",
"assetTagType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mode": "string",
"state": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
AssetTagCreateRequest: object
- name: string | null
-
A friendly name to identify this tag
- serialNumber: string
-
The serial number of the Asset Tag that is used to uniquely identify it.
- assetTagType: IdName
-
The type of asset tag
- mode: string movable, fixed, stock
-
The asset tag operation mode. Options are 'movable' for movable assets, 'fixed' for fixed assets and 'stock' for temporary stock control uses.
- state: string | null active, deleted
-
The current state of the object
- asset: IdName | null
-
The asset to which this tag is currently assigned
- fields: CustomFieldValues | null
-
A number of custom field values for this assettag.
- ownerId: string
Example
{
"name": "string",
"serialNumber": "string",
"assetTagType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mode": "string",
"state": "string",
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {},
"ownerId": "string"
}
AssetTagTypeResponse: object
- id: string
-
The unique ID of this asset tag type
- owner: IdNameType
-
The client that owns this entity
- name: string
-
A unique name for this entity
- parent: IdName
-
The parent of this entity
- tag: string
-
A unique tag for this entity
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
AssetTagTypeListResponse: object
A list of asset tag type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetTagTypeResponse
-
AssetTagTypeResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
]
}
AssetTypeResponse: object
- id: string
-
The unique ID of this asset type
- owner: IdNameType
-
The client that owns this entity
- name: string
-
A unique name for this entity
- parent: IdName
-
The parent of this entity
- tag: string
-
A unique tag for this entity
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
AssetTypeListResponse: object
A list of asset type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AssetTypeResponse
-
AssetTypeResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string"
}
]
}
CostCentreResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- contacts: Contact | null
-
A list of contacts applicable to this cost centre
-
Contact - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
CostCentreListResponse: object
A list of cost centre items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: CostCentreResponse
-
CostCentreResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
]
}
CostCentreUpdateRequest: object
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
]
}
CostCentreCreateRequest: object
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"contacts": [
{
"id": "string",
"type": "string",
"name": "string",
"emailAddress": "string",
"phoneMobile": "string",
"phoneOffice": "string",
"notes": "string"
}
],
"ownerId": "string"
}
DashboardListItem: object
- id: string
-
The unique UUID for this Dashboard
- owner: IdNameType
-
The client that owns this Dashboard
- parent: IdName | null
-
The template dashboard from which this dashboard was constructed. This dashboard will track all of the widgets on the parent dashboard.
- source: IdName | null
-
The source dashboard if this dashboard was cloned from another.
- costCentre: IdName | null
-
The cost centre the dashboard belongs to
- level: string | null system, distributor, vendor, client
-
The company level the dashboard is intended for
- user: IdName
-
The user to whom this dashboard belongs
- name: string
-
The name of the dashboard.
- public: boolean
-
Whethere or not other users can see the dashboard
- description: string
-
A short description of the dashboard.
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"public": "boolean",
"description": "string",
"modifiedDate": "string"
}
DashboardListResponse: object
A list of Dashboard items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DashboardListItem
-
The list of Dashboard items in this response
-
DashboardListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"public": "boolean",
"description": "string",
"modifiedDate": "string"
}
]
}
AnalyticsLevels: object
- name: string
- headings: string[]
-
string
Example
{
"name": "string",
"headings": [
"string"
]
}
AnalyticsDimension: object
- dim: string time, asset, costCentre, zoneCostCentre, assetGroup, zoneGroup, device, ioType, alert, event, assetState, assetCategory0, assetCategory1, assetCategory2, assetCategory3, assetCategory4, overspeed, shift, company, geography, deviceType
- level: number (double)
- filter: string[]
-
string - levels: AnalyticsLevels
Example
{
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
}
MeasureDescription: object
- key: string
-
The key of the measure
- value: string
-
The name of the measure
- format: string | null duration, number, integer, percent
-
The formatting type of the measure. Durations are hh:mm:ss. Numbers can be postive or negative values to 2 decimal places, integers can be postive or negative; and percent is an integer between 0 and 100
- generic: boolean | null
-
Whether or not the measure is generic. This is useful to indicate that the measure is specific to a client and should not be used in dashboard templates
- validFrom: string | null
-
The date YYYY/MM/DD HH:mm:ss (UTC) from which the measure is valid
- validTo: string | null
-
The date YYYY/MM/DD HH:mm:ss (UTC) to which the measure is valid
Example
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
SelectedMeasureValues: object
- key: string
-
The key of the measure
- value: string
-
The name of the measure
- generic: boolean | null
-
Whether or not the measure is generic. This is useful to indicate that the measure is specific to a client and should not be used in dashboard templates
- validFrom: string | null
-
The date YYYY/MM/DD HH:mm:ss (UTC) from which the measure is valid
- validTo: string | null
-
The date YYYY/MM/DD HH:mm:ss (UTC) to which the measure is valid
Example
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
AnalyticsTable: object
- measures: SelectedMeasureValues
-
SelectedMeasureValues - layout: string
Example
{
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
}
AnalyticsSortOptions: object
- type: string alphabetic, numeric
- direction: string asc, desc
- limit: number | null (double)
- measureKey: string | null
Example
{
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
}
ChartAxisMaxMin: object
- max: string | null
- min: string | null
Example
{
"max": "string",
"min": "string"
}
ChartYAxis: object
- left: ChartAxisMaxMin | null
- right: ChartAxisMaxMin | null
Example
{
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
}
ChartXAxis: object
- labels: ChartXAxisLabels
Example
{
"labels": {
"layout": "string"
}
}
ChartLabel: object
- visible: boolean
- placement: string
- position: string
- overlay: boolean
Example
{
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
}
TargetLine: object
- id: string
- name: string
- value: number (double)
- color: string | null
- borderWidth: number | null (double)
- borderDash: number[] | null
-
number (double) - showLabel: boolean | null
- type: string | null dashed, solid
Example
{
"id": "string",
"name": "string",
"value": "number (double)",
"color": "string",
"borderWidth": "number (double)",
"borderDash": [
"number (double)"
],
"showLabel": "boolean",
"type": "string"
}
ChartSeriesItem: object
- visible: boolean
- average: boolean | null
- type: string
- orientation: string | null horizontal, vertical
- fill: boolean | null
- color: string | null
- yAxis: string | null left, right
- targetLines: TargetLine | null
-
TargetLine
Example
{
"visible": "boolean",
"average": "boolean",
"type": "string",
"orientation": "string",
"fill": "boolean",
"color": "string",
"yAxis": "string",
"targetLines": [
{
"id": "string",
"name": "string",
"value": "number (double)",
"color": "string",
"borderWidth": "number (double)",
"borderDash": [
"number (double)"
],
"showLabel": "boolean",
"type": "string"
}
]
}
ChartOptions: object
- yAxis: ChartYAxis | null
- xAxis: ChartXAxis | null
- stacked: boolean
- label: ChartLabel
- series: ChartSeries
- dataLabels: boolean | null
Example
{
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
}
PieChartOptions: object
- label: ChartLabel
- series: PieChartSeries
- dataLabels: boolean | null
- data: string average, total
- fill: boolean
Example
{
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
}
StatChartOptions: object
- data: string average, total, first, last
- key: string | null
- color: string | null
- trend: string | null none, percentage, actual
- sparkline: boolean | null
Example
{
"data": "string",
"key": "string",
"color": "string",
"trend": "string",
"sparkline": "boolean"
}
CalculatedMeasureFormat: object
- key: string
- value: string
Example
{
"key": "string",
"value": "string"
}
CalculatedMeasure: object
- id: string
- name: string
- expression: string
- average: boolean
- total: boolean
- format: string distance, speed, volume, number, integer, duration, consumption, distanceRate
Example
{
"id": "string",
"name": "string",
"expression": "string",
"average": "boolean",
"total": "boolean",
"format": "string"
}
CalculatedMeasureSettings: object
- formatOptions: CalculatedMeasureFormat
-
CalculatedMeasureFormat - measures: CalculatedMeasure
-
CalculatedMeasure
Example
{
"formatOptions": [
{
"key": "string",
"value": "string"
}
],
"measures": [
{
"id": "string",
"name": "string",
"expression": "string",
"average": "boolean",
"total": "boolean",
"format": "string"
}
]
}
AnalyticsOutputRangeFilter: object
- level: string
- start: string
- end: string
Example
{
"level": "string",
"start": "string",
"end": "string"
}
AnalyticsOutputFilter: object
- mode: string include, exclude, range
- items: string[] | null
-
string - range: AnalyticsOutputRangeFilter | null
Example
{
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
}
AnalyticsOutputFilters: object
- group: AnalyticsOutputFilter
- row: AnalyticsOutputFilter
Example
{
"group": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
},
"row": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
}
}
AnalyticsUpdateFrequencyOffset: object
- frequency: number (double)
- offset: number (double)
Example
{
"frequency": "number (double)",
"offset": "number (double)"
}
AnalyticsUpdateSettings: object
- daily: object | null
-
- time: string
- hourly: AnalyticsUpdateFrequencyOffset | null
- shifts: AnalyticsUpdateFrequencyOffset | null
Example
{
"daily": {
"time": "string"
},
"hourly": {
"frequency": "number (double)",
"offset": "number (double)"
},
"shifts": {
"frequency": "number (double)",
"offset": "number (double)"
}
}
AnalyticsOutputSettings: object
- name: string
- description: string
- dateRange: string
- row: AnalyticsDimension
- group: AnalyticsDimension
- flipped: boolean
- measures: MeasureDescription
-
MeasureDescription - table: AnalyticsTable
- sort: AnalyticsSortOptions
- graph: ChartOptions | null
- pie: PieChartOptions | null
- stat: StatChartOptions | null
- calculatedMeasures: CalculatedMeasureSettings | null
- filters: AnalyticsOutputFilters | null
- timeOptions: string[] | null
-
string days, hours - shiftsEnabled: boolean | null
- doNotTemplate: boolean | null
- updates: AnalyticsUpdateSettings | null
Example
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
},
"stat": {
"data": "string",
"key": "string",
"color": "string",
"trend": "string",
"sparkline": "boolean"
}
}
WidgetOptions: object
- analytics: AnalyticsOutputSettings | null
Example
{
"analytics": {
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
},
"stat": {
"data": "string",
"key": "string",
"color": "string"
}
}
}
DashboardWidgetPlacement: object
- col: number (double)
-
The placement of the widget on the X access
- row: number (double)
-
The placement of the widget on the Y access
- colSpan: number (double)
-
The number of columns that the widget spans on the X access
- rowSpan: number (double)
-
The number of rows that the widget spans on the Y access
Example
{
"col": "number (double)",
"row": "number (double)",
"colSpan": "number (double)",
"rowSpan": "number (double)"
}
AnalyticsDataSourceOptions: object
- definitionId: string
-
Definition ID of the analytics report which the widget is compatible with
- parameterDefinition: string | null
-
The parameter definition string used to generate widget settings
- parameters: Dictionary | null
-
Additional parameters used on the instantiated widget
- filters: Dictionary | null
-
filters for the widget's report
- rollup: string | null hour, day
-
The time rollup level of the report
Example
{
"definitionId": "string",
"parameterDefinition": "string",
"parameters": {},
"filters": {},
"rollup": "string"
}
DashboardWidgetDataSourceOptions: object
- analytics: AnalyticsDataSourceOptions | null
Example
{
"analytics": {
"definitionId": "string",
"parameterDefinition": "string",
"parameters": {},
"filters": {},
"rollup": "string"
}
}
DailyShift: object
- firstShift: boolean | null
-
Boolean indicating whether or not this is the first shift of the day
- name: string
-
The name of the shift
- start: string
-
The start time of the shift (hh:mm). The shift includes this time
- end: string
-
The end time of the shift (hh:mm). The shift exludes this time
Example
{
"firstShift": "boolean",
"name": "string",
"start": "string",
"end": "string"
}
ShiftConfig: object
- type: ShiftOptionType
-
The type of shift
- dailyShift: DailyShiftConfig
-
Details for a daily shift
Example
{
"type": {},
"dailyShift": {}
}
WidgetExtraData: object
- shifts: ShiftConfig | null
- categoryMap: CategoryMap | null
Example
{
"shifts": {
"type": {},
"dailyShift": {}
},
"categoryMap": {}
}
DashboardWidgetDataSource: object
- id: string | null
- type: string analytics-report, analytics-mock
- options: DashboardWidgetDataSourceOptions
- data: WidgetExtraData | null
Example
{
"id": "string",
"type": "string",
"options": {
"analytics": {
"definitionId": "string",
"parameterDefinition": "string",
"parameters": {},
"filters": {},
"rollup": "string"
}
},
"data": {
"shifts": {
"type": {},
"dailyShift": {}
},
"categoryMap": {}
}
}
DashboardWidget: object
- inherited: boolean | null
-
Inherited widgets are tied to a parent dashboard and cannot have their
widgetTypeoroptionsmodified, as they are tracked with the parent dashboard widget. - sourceId: string | null
-
If a widget was cloned from another widget, the ID of the source widget will be stored here.
- name: string | null
-
The name of the widget.
- description: string | null
-
A short description of the widget.
- widgetType: string | null chart, grid, text, stat, pie
-
The type of widget
- options: WidgetOptions | null
-
A number of custom field values for this widget.
- hidden: boolean | null
-
Should the widget be displayed on the dashboard or not.
- placement: DashboardWidgetPlacement | null
-
Information about the placement of the widget
- dataSource: DashboardWidgetDataSource | null
-
Data source information
Example
{
"inherited": "boolean",
"sourceId": "string",
"name": "string",
"description": "string",
"widgetType": "string",
"options": {
"analytics": {
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
}
}
}
}
DashboardResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- user: IdName | null
-
The user to whom this dashboard belongs
- name: string | null
-
The name of the dashboard.
- description: string | null
-
A short description of the dashboard.
- public: boolean | null
-
Whether or not other users can see the dashboard
- options: Dictionary | null
-
A number of custom field values for this dashboard.
- widgets: DashboardWidgetDictionary | null
-
A dictionary of the widgets in this dashboard
- parent: IdName | null
-
The template dashboard from which this dashboard was constructed. This dashboard will track all of the widgets on the parent dashboard.
- source: IdName | null
-
The source dashboard if this dashboard was cloned from another.
- level: string | null system, distributor, vendor, client
-
The company level of the dashboard target audience
- costCentre: IdName | null
-
The cost centre the dashboard belongs to
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
DashboardUpdateRequest: object
- user: IdName | null
-
The user to whom this dashboard belongs
- name: string | null
-
The name of the dashboard.
- description: string | null
-
A short description of the dashboard.
- public: boolean | null
-
Whether or not other users can see the dashboard
- options: Dictionary | null
-
A number of custom field values for this dashboard.
- widgets: DashboardWidgetDictionary | null
-
A dictionary of the widgets in this dashboard
- parent: IdName | null
-
The template dashboard from which this dashboard was constructed. This dashboard will track all of the widgets on the parent dashboard.
- source: IdName | null
-
The source dashboard if this dashboard was cloned from another.
- level: string | null system, distributor, vendor, client
-
The company level of the dashboard target audience
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string"
}
DashboardCreateRequest: object
- user: IdName | null
-
The user to whom this dashboard belongs
- name: string | null
-
The name of the dashboard.
- description: string
-
A short description of the dashboard.
- public: boolean | null
-
Whether or not other users can see the dashboard
- options: Dictionary | null
-
A number of custom field values for this dashboard.
- widgets: DashboardWidgetDictionary | null
-
A dictionary of the widgets in this dashboard
- parent: IdName | null
-
The template dashboard from which this dashboard was constructed. This dashboard will track all of the widgets on the parent dashboard.
- source: IdName | null
-
The source dashboard if this dashboard was cloned from another.
- level: string system, distributor, vendor, client
-
The company level of the dashboard target audience
- ownerId: string
- costCentre: IdName | null
-
The cost centre the dashboard belongs to
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"source": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"level": "string",
"ownerId": "string",
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
RebuildDashboardWidgetResponse: object
- status: string ok, failed
Example
{
"status": "string"
}
DashboardTemplateListItem: object
- id: string
-
The unique UUID for this Dashboard
- owner: IdNameType
-
The client that owns this Dashboard
- state: string active, deleted
-
The state of the entity
- user: IdName
-
The user to whom this dashboard belongs
- name: string
-
The name of the dashboard.
- description: string
-
A short description of the dashboard.
- public: boolean | null
-
Determines if the dashboard can be added by downstream users
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"modifiedDate": "string"
}
DashboardTemplateListResponse: object
A list of Dashboard items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DashboardTemplateListItem
-
The list of Dashboard items in this response
-
DashboardTemplateListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"modifiedDate": "string"
}
]
}
DashboardTemplateResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- user: IdName | null
-
The user to whom this dashboard belongs
- name: string | null
-
The name of the dashboard.
- description: string | null
-
A short description of the dashboard.
- public: boolean | null
-
Determines if the template can be added by downstream users
- options: Dictionary | null
-
A number of custom field values for this dashboard.
- widgets: DashboardWidgetDictionary | null
-
A dictionary of the widgets in this dashboard
- state: string | null active, deleted
-
The state of dashboard template
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
DashboardTemplateUpdateRequest: object
- user: IdName | null
-
The user to whom this dashboard belongs
- name: string | null
-
The name of the dashboard.
- description: string | null
-
A short description of the dashboard.
- public: boolean | null
-
Determines if the template can be added by downstream users
- options: Dictionary | null
-
A number of custom field values for this dashboard.
- widgets: DashboardWidgetDictionary | null
-
A dictionary of the widgets in this dashboard
- state: string | null active, deleted
-
The state of dashboard template
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean",
"options": {},
"widgets": {},
"state": "string"
}
DashboardTemplateCreateRequest: object
- dashboardId: string
-
The id of the dashboard to turn into a template
- ownerId: string
-
The ownerId of the template
- user: IdName
-
The id of the user who created the template
- name: string
-
The name of the dashboard template.
- description: string
-
A short description of the dashboard.
- public: boolean
-
Determines if the dashboard can be added by downstream users
Example
{
"dashboardId": "string",
"ownerId": "string",
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"public": "boolean"
}
DeviceListItem: object
- id: string
-
The unique UUID for this device
- name: string
-
The serial or IMEI of the device that is used to uniquely identify it. The value used will depend on the device type.
- owner: IdName
-
The client that owns this device
- deviceType: IdName | null
-
The type of device
- provider: IdName | null
-
The device provider, if the device requires one to function.
- asset: IdName | null
-
The asset to which this device has been assigned.
- simcard: IdName | null
-
The sim card which has been assigned to this device.
- configProfile: IdName | null
-
The config profile which has been assigned to this device.
- fields: CustomFieldValues
-
A number of custom field values for this device.
- state: string inactive, active, suspended, deleted
-
The current state of the device object
Example
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {},
"state": "string"
}
DeviceListResponse: object
A list of device items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DeviceListItem
-
The list of deviceitems in this response
-
DeviceListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {},
"state": "string"
}
]
}
DeviceDigitalConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- invert: boolean
-
Invert the state of the input value
Example
{
"input": "string",
"invert": "boolean"
}
DeviceOutputConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- invert: boolean
-
Invert the state of the input value
- pulsed: boolean
-
Send a pulse signal to the device output
Example
{
"input": "string",
"invert": "boolean",
"pulsed": "boolean"
}
DeviceAnalogConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- minVolts: number (double)
-
The minumum voltage range of the analog input
- maxVolts: number (double)
-
The maximum voltage range of the analog input
- minValue: number (double)
-
The minumum real world value (litres etc.) that 'minVolts' maps to.
- maxValue: number (double)
-
The maximum real world value (litres etc.) that 'maxVolts' maps to.
Example
{
"input": "string",
"minVolts": "number (double)",
"maxVolts": "number (double)",
"minValue": "number (double)",
"maxValue": "number (double)"
}
DeviceTemperatureConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
Example
{
"input": "string"
}
DeviceCANConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- minValue: number (double)
-
The minumum value that is expected
- maxValue: number (double)
-
The maximum value that is expected
- multiplier: number (double)
-
Multiply the received value by this number to get a real world number
Example
{
"input": "string",
"minValue": "number (double)",
"maxValue": "number (double)",
"multiplier": "number (double)"
}
DeviceCounterConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- multiplier: number (double)
-
Multiply the received value by this number to get a real world number
Example
{
"input": "string",
"multiplier": "number (double)"
}
DeviceCameraConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
- enableLiveStream: boolean | null
-
Should the user be able to live stream from this camera?
Example
{
"input": "string",
"enableLiveStream": "boolean"
}
DeviceValueConfig: object
- input: string
-
The text input that is matched from the device telemetry, i.e. 'digital_01'
Example
{
"input": "string"
}
DeviceIOParameters: object
- digital_input: DeviceDigitalConfigDictionary | null
-
Digital input configuration
- digital_output: DeviceOutputConfigDictionary | null
-
Digital output configuration
- analog_input: DeviceAnalogConfigDictionary | null
-
Analog input configuration
- temperature_input: DeviceTemperatureConfigDictionary | null
-
Temperature input configuration
- can_input: DeviceCANConfigDictionary | null
-
CAN bus configuration
- counter_input: DeviceCounterConfigDictionary | null
-
Counter input configuration
- camera_input: DeviceCameraConfigDictionary | null
-
Camera configuration
- value_input: DeviceValueConfigDictionary | null
-
Value configuration
Example
{
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
}
DeviceBitmapConfiguration: object
The DeviceBitmapConfiguration is used to pick out specific bits from a telemetry value and create a new telemetry input with the extracted value. target_input = (source_input >> bitshift) & bitmask For example, to get the 3rd bit (indexed as 2) as a digital input (0 or 1), you'd specify: target_input = (source_input >> 2) & 0x01
- source_input: string
-
The source input from which to retreive the source value
- bitshift: number (double)
-
The number of bits to be shifted right in the source value
- bitmask: number (double)
-
The bitmask to be applied to after shifting
- target_input: string
-
The new input that will store the resulting value
- target_type: string digital_input, digital_output, can_input, value_input
-
The IO type of the new value
Example
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
DeviceParameters: object
- active_input: string | null
-
The input that is used to determine when the device becomes active (ignition on for vehicles). Determines when trips are started and ended.
- hours_input: string | null
-
The input that is used to start counting engine hours. This is usually the same as 'active_input'.
- idling_input: string | null
-
The input that is used to determine when the device is idling. Defaults to "speed" where idling is calulated based on device speed.
- idling_input_invert: boolean | null
-
Set to true to invert the input value that is being used for the idling input
- io: DeviceIOParameters | null
-
Mappings between IoTypes and the device's telemetry inputs and outputs
- io_whitelist: string[] | null
-
If this array is populated, only the IOs listed in this array will be persisted in the system, and everything else will be discarded
-
string - bitmaps: DeviceBitmapConfiguration | null
-
A list of inputs derived using a bitmap operation
-
DeviceBitmapConfiguration
Example
{
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
}
DeviceAccessory: object
Device accessories add extra optional functionality to a device.
- name: string
-
The name of the device accessory
- settings: Dictionary
-
Device accessory specific settings
Example
{
"name": "string",
"settings": {}
}
DeviceResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The serial or IMEI of the device that is used to uniquely identify it. The value used will depend on the device type.
- state: string | null inactive, active, suspended, deleted
-
The current state of the device object
- deviceType: IdName | null
-
The type of device
- provider: IdName | null
-
The device provider, if the device requires one to function.
- asset: IdName | null
-
The asset to which this device has been assigned.
- simcard: IdName | null
-
The sim card which has been assigned to this device.
- configProfile: IdName | null
-
An optional configuration profile
- parameters: DeviceParameters | null
-
A number of device specific parameters (only available if configProfile is null)
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form (only available if configProfile is null)
- accessories: DeviceAccessories | null
-
Accessory settings for this device (only available if configProfile is null)
- fields: CustomFieldValues | null
-
A number of custom field values for this device.
- features: Dictionary | null
-
A number of features that have been enabled on this device (only available if configProfile is null)
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
DeviceUpdateRequest: object
- name: string | null
-
The serial or IMEI of the device that is used to uniquely identify it. The value used will depend on the device type.
- state: string | null inactive, active, suspended, deleted
-
The current state of the device object
- deviceType: IdName | null
-
The type of device
- provider: IdName | null
-
The device provider, if the device requires one to function.
- asset: IdName | null
-
The asset to which this device has been assigned.
- simcard: IdName | null
-
The sim card which has been assigned to this device.
- configProfile: IdName | null
-
An optional configuration profile
- parameters: DeviceParameters | null
-
A number of device specific parameters (only available if configProfile is null)
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form (only available if configProfile is null)
- accessories: DeviceAccessories | null
-
Accessory settings for this device (only available if configProfile is null)
- fields: CustomFieldValues | null
-
A number of custom field values for this device.
Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {}
}
DeviceCreateRequest: object
- name: string | null
-
The serial or IMEI of the device that is used to uniquely identify it. The value used will depend on the device type.
- state: string | null inactive, active, suspended, deleted
-
The current state of the device object
- deviceType: IdName
-
The type of device
- provider: IdName | null
-
The device provider, if the device requires one to function.
- asset: IdName | null
-
The asset to which this device has been assigned.
- simcard: IdName | null
-
The sim card which has been assigned to this device.
- configProfile: IdName | null
-
An optional configuration profile
- parameters: DeviceParameters | null
-
A number of device specific parameters (only available if configProfile is null)
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form (only available if configProfile is null)
- accessories: DeviceAccessories | null
-
Accessory settings for this device (only available if configProfile is null)
- fields: CustomFieldValues | null
-
A number of custom field values for this device.
- ownerId: string
Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"provider": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"simcard": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"configProfile": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"fields": {},
"ownerId": "string"
}
DeviceConfigProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- deviceType: IdName | null
-
The device type that this profile applies to
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
DeviceConfigProfileListResponse: object
A list of device config profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DeviceConfigProfileListItem
-
DeviceConfigProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
DeviceConfigProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- deviceType: IdName | null
-
The device type that this profile applies to
- parameters: DeviceParameters | null
-
A number of device specific parameters
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form
- accessories: DeviceAccessories | null
-
Accessory settings for this device
- entity: EntityInfo
-
entity specific metadata
- features: Dictionary | null
-
A number of features that have been enabled on this device
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"features": {}
}
DeviceConfigProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- deviceType: IdName | null
-
The device type that this profile applies to
- parameters: DeviceParameters | null
-
A number of device specific parameters
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form
- accessories: DeviceAccessories | null
-
Accessory settings for this device
Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {}
}
DeviceConfigProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- deviceType: IdName | null
-
The device type that this profile applies to
- parameters: DeviceParameters | null
-
A number of device specific parameters
- settings: Dictionary | null
-
Values for the DeviceType's setting definition form
- accessories: DeviceAccessories | null
-
Accessory settings for this device
- ownerId: string
-
The client that owns this DeviceConfig Profile
Example
{
"name": "string",
"state": "string",
"deviceType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {
"active_input": "string",
"hours_input": "string",
"idling_input": "string",
"idling_input_invert": "boolean",
"io": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {}
},
"io_whitelist": [
"string"
],
"bitmaps": [
{
"source_input": "string",
"bitshift": "number (double)",
"bitmask": "number (double)",
"target_input": "string",
"target_type": "string"
}
]
},
"settings": {},
"accessories": {},
"ownerId": "string"
}
DeviceTypeListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- shortName: string | null
-
A short name for this device type (usually just a model number)
- parent: IdName | null
-
The parent of this entity
- tag: string | null
-
A unique tag for this entity
- state: string | null active, deleted
-
The current state of the device type object
- deviceProviderType: IdName | null
-
An optional link to a device provider that supplies the data for this device type. If this is set, the user will be required to select the device provider on device configuration.
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
DeviceTypeListResponse: object
A list of device type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DeviceTypeListItem
-
DeviceTypeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
DeviceTypeIOProperties: object
- optional: boolean | null
-
If true, the IO won't be persisted unless it is explicitly included in the device's IO whitelist
Example
{
"optional": "boolean"
}
DeviceTypeIOCapabilities: object
- digital_input: DeviceTypeIOPropertiesDictionary | null
- digital_output: DeviceTypeIOPropertiesDictionary | null
- analog_input: DeviceTypeIOPropertiesDictionary | null
- temperature_input: DeviceTypeIOPropertiesDictionary | null
- can_input: DeviceTypeIOPropertiesDictionary | null
- counter_input: DeviceTypeIOPropertiesDictionary | null
- camera_input: DeviceTypeIOPropertiesDictionary | null
- value_input: DeviceTypeIOPropertiesDictionary | null
- cached_fields: string[] | null
-
string
Example
{
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
}
DeviceTypeFeature: object
- settings: Dictionary | null
- webhook: Dictionary | null
Example
{
"settings": {},
"webhook": {}
}
DeviceTypeAccessory: object
- name: string | null
-
A descriptive name for the accessory
- settingsDefinition: string | null
-
A form definition for custom settings in this device type accessory
- ioCapabilities: DeviceTypeIOCapabilities | null
-
Defines the types of IOs that are available on this accessory
- features: DeviceTypeFeatures | null
-
A list of features for this accessory
Example
{
"name": "string",
"settingsDefinition": "string",
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"features": {}
}
DeviceTypeResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- shortName: string | null
-
A short name for this device type (usually just a model number)
- parent: IdName | null
-
The parent of this entity
- tag: string | null
-
A unique tag for this entity
- state: string | null active, deleted
-
The current state of the device type object
- deviceProviderType: IdName | null
-
An optional link to a device provider that supplies the data for this device type. If this is set, the user will be required to select the device provider on device configuration.
- ioCapabilities: DeviceTypeIOCapabilities | null
-
Defines the types of IOs that are available on this device type
- settingsDefinition: string | null
-
A form definition for custom settings in this device type
- accessories: DeviceTypeAccessories | null
-
A list of available accessories for this device type
- features: DeviceTypeFeatures | null
-
A map of features for this device type
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
DeviceTypeUpdateRequest: object
- name: string | null
-
A unique name for this entity
- shortName: string | null
-
A short name for this device type (usually just a model number)
- parent: IdName | null
-
The parent of this entity
- tag: string | null
-
A unique tag for this entity
- state: string | null active, deleted
-
The current state of the device type object
- deviceProviderType: IdName | null
-
An optional link to a device provider that supplies the data for this device type. If this is set, the user will be required to select the device provider on device configuration.
- ioCapabilities: DeviceTypeIOCapabilities | null
-
Defines the types of IOs that are available on this device type
- settingsDefinition: string | null
-
A form definition for custom settings in this device type
- accessories: DeviceTypeAccessories | null
-
A list of available accessories for this device type
- features: DeviceTypeFeatures | null
-
A map of features for this device type
Example
{
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {}
}
DeviceTypeCreateRequest: object
- name: string | null
-
A unique name for this entity
- shortName: string | null
-
A short name for this device type (usually just a model number)
- parent: IdName | null
-
The parent of this entity
- tag: string | null
-
A unique tag for this entity
- state: string | null active, deleted
-
The current state of the device type object
- deviceProviderType: IdName | null
-
An optional link to a device provider that supplies the data for this device type. If this is set, the user will be required to select the device provider on device configuration.
- ioCapabilities: DeviceTypeIOCapabilities | null
-
Defines the types of IOs that are available on this device type
- settingsDefinition: string | null
-
A form definition for custom settings in this device type
- accessories: DeviceTypeAccessories | null
-
A list of available accessories for this device type
- features: DeviceTypeFeatures | null
-
A map of features for this device type
- ownerId: string
Example
{
"name": "string",
"shortName": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"tag": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ioCapabilities": {
"digital_input": {},
"digital_output": {},
"analog_input": {},
"temperature_input": {},
"can_input": {},
"counter_input": {},
"camera_input": {},
"value_input": {},
"cached_fields": [
"string"
]
},
"settingsDefinition": "string",
"accessories": {},
"features": {},
"ownerId": "string"
}
DeviceProviderListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the device provider.
- state: string | null active, suspended, deleted
-
The current state of the device provider object
- deviceProviderType: IdName | null
-
The type of device provider
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
DeviceProviderListResponse: object
A list of device provider items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DeviceProviderListItem
-
The list of device provider items in this response
-
DeviceProviderListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
DeviceProviderResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the device provider.
- state: string | null active, suspended, deleted
-
The current state of the device provider object
- deviceProviderType: IdName | null
-
The type of device provider
- parameters: Dictionary | null
-
A number of device provider specific parameters
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
DeviceProviderUpdateRequest: object
- name: string | null
-
The name of the device provider.
- state: string | null active, suspended, deleted
-
The current state of the device provider object
- deviceProviderType: IdName | null
-
The type of device provider
- parameters: Dictionary | null
-
A number of device provider specific parameters
Example
{
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"parameters": {}
}
DeviceProviderCreateRequest: object
- name: string | null
-
The name of the device provider.
- state: string | null active, suspended, deleted
-
The current state of the device provider object
- deviceProviderType: IdName | null
-
The type of device provider
- ownerId: string
- parameters: Dictionary | null
-
A number of device provider specific parameters
Example
{
"name": "string",
"state": "string",
"deviceProviderType": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string",
"parameters": {}
}
DeviceProviderTypeListItem: object
- id: string
-
The unique ID of this device provider type
- owner: IdNameType
-
The company that owns this entity
- name: string
-
A unique name for this entity
- tag: string
-
A unique tag for this entity
- companyTypes: string[]
-
The company types that this provider type can be instantiated in. Valid values are 'client', 'vendor' and 'distributor'
-
string - state: string | null active, suspended, deleted
-
The current state of the object
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"companyTypes": [
"string"
],
"state": "string"
}
DeviceProviderTypeListResponse: object
A list of device provider type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: DeviceProviderTypeListItem
-
DeviceProviderTypeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"companyTypes": [
"string"
],
"state": "string"
}
]
}
DeviceProviderTypeResponse: object
- id: string
-
The unique ID of this device provider type
- owner: IdNameType
-
The company that owns this entity
- name: string
-
A unique name for this entity
- tag: string
-
A unique tag for this entity
- companyTypes: string[]
-
The company types that this provider type can be instantiated in. Valid values are 'client', 'vendor' and 'distributor'
-
string - state: string | null active, suspended, deleted
-
The current state of the object
- parameters: string
-
A JSON string that describes the parameter input fields for this device provider type
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"companyTypes": [
"string"
],
"state": "string",
"parameters": "string"
}
EmailProviderListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the email provider
- type: IdName | null
-
The type of the email provider
- state: string | null active, suspended, deleted
-
The state of the email provider
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"modifiedDate": "string"
}
EmailProviderListResponse: object
A list of email provider items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: EmailProviderListItem
-
EmailProviderListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"modifiedDate": "string"
}
]
}
EmailProviderResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the email provider
- type: IdName | null
-
The type of the email provider
- state: string | null active, suspended, deleted
-
The state of the email provider
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
EmailProviderUpdateRequest: object
- name: string | null
-
The name of the email provider
- type: IdName | null
-
The type of the email provider
- state: string | null active, suspended, deleted
-
The state of the email provider
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {}
}
EmailProviderCreateRequest: object
- name: string | null
-
The name of the email provider
- type: IdName | null
-
The type of the email provider
- state: string | null active, suspended, deleted
-
The state of the email provider
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
- ownerId: string
-
The client that owns this email provider
Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"parameters": {},
"ownerId": "string"
}
ExportTaskListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- client: IdName | null
-
The client to export data from. In the case of a Firehose export task, this will be the Vendor and not a client.
- name: string | null
-
The name of the export task
- state: string | null suspended, active, deleted
-
The state of the export task
- deliveryMethod: string | null http, stream, firehose
-
The delivery method of the export tasks
- assets: EventActorFilter | null
-
The filters used to get the assets to be included in the export task
-
EventActorFilter - documentTypes: string[] | null
-
The document types to include in the export task
-
string - documentVersion: string | null v1, v2
-
The document layout version
- settings: Dictionary | null
-
A set of delivery method specific options
- username: string | null
-
Export task username
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"username": "string",
"modifiedDate": "string"
}
ExportTaskListResponse: object
A list of I/O type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ExportTaskListItem
-
ExportTaskListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"username": "string",
"modifiedDate": "string"
}
]
}
ExportTaskResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- client: IdName | null
-
The client to export data from. In the case of a Firehose export task, this will be the Vendor and not a client.
- name: string | null
-
The name of the export task
- state: string | null suspended, active, deleted
-
The state of the export task
- deliveryMethod: string | null http, stream, firehose
-
The delivery method of the export tasks
- assets: EventActorFilter | null
-
The filters used to get the assets to be included in the export task
-
EventActorFilter - documentTypes: string[] | null
-
The document types to include in the export task
-
string - documentVersion: string | null v1, v2
-
The document layout version
- settings: Dictionary | null
-
A set of delivery method specific options
- endpoint: string | null
-
The connection endpoint for the export task
- username: string | null
-
Export task username
- password: string | null
-
Export task password
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"endpoint": "string",
"username": "string",
"password": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ExportTaskUpdateRequest: object
- client: IdName | null
-
The client to export data from. In the case of a Firehose export task, this will be the Vendor and not a client.
- name: string | null
-
The name of the export task
- state: string | null suspended, active, deleted
-
The state of the export task
- deliveryMethod: string | null http, stream, firehose
-
The delivery method of the export tasks
- assets: EventActorFilter | null
-
The filters used to get the assets to be included in the export task
-
EventActorFilter - documentTypes: string[] | null
-
The document types to include in the export task
-
string - documentVersion: string | null v1, v2
-
The document layout version
- settings: Dictionary | null
-
A set of delivery method specific options
Example
{
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {}
}
ExportTaskCreateRequest: object
- client: IdName | null
-
The client to export data from. In the case of a Firehose export task, this will be the Vendor and not a client.
- name: string | null
-
The name of the export task
- state: string | null suspended, active, deleted
-
The state of the export task
- deliveryMethod: string | null http, stream, firehose
-
The delivery method of the export tasks
- assets: EventActorFilter | null
-
The filters used to get the assets to be included in the export task
-
EventActorFilter - documentTypes: string[] | null
-
The document types to include in the export task
-
string - documentVersion: string | null v1, v2
-
The document layout version
- settings: Dictionary | null
-
A set of delivery method specific options
- ownerId: string
-
The client or vendor that owns this entity
Example
{
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"deliveryMethod": "string",
"assets": [
{
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
}
],
"documentTypes": [
"string"
],
"documentVersion": "string",
"settings": {},
"ownerId": "string"
}
FuelCardListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The serial number of the fuel card that is used to uniquely identify it.
- brandName: string | null
-
The brand of fuel card
- embossedName: string | null
-
The name embossed on the fuel card
- expiryDate: string | null
-
The expiry date of the fuel card in the format YYYY/MM/DD
- description: string | null
-
A short description of the fuel card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this fuelcard.
- asset: IdName | null
-
The asset to which this fuel card has been assigned.
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
FuelCardListResponse: object
A list of fuel card items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: FuelCardListItem
-
The list of fuel card items in this response
-
FuelCardListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
FuelCardResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The serial number of the fuel card that is used to uniquely identify it.
- brandName: string | null
-
The brand of fuel card
- embossedName: string | null
-
The name embossed on the fuel card
- expiryDate: string | null
-
The expiry date of the fuel card in the format YYYY/MM/DD
- description: string | null
-
A short description of the fuel card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this fuelcard.
- asset: IdName | null
-
The asset to which this fuel card has been assigned.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
FuelCardUpdateRequest: object
- name: string | null
-
The serial number of the fuel card that is used to uniquely identify it.
- brandName: string | null
-
The brand of fuel card
- embossedName: string | null
-
The name embossed on the fuel card
- expiryDate: string | null
-
The expiry date of the fuel card in the format YYYY/MM/DD
- description: string | null
-
A short description of the fuel card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this fuelcard.
- asset: IdName | null
-
The asset to which this fuel card has been assigned.
Example
{
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
FuelCardCreateRequest: object
- name: string | null
-
The serial number of the fuel card that is used to uniquely identify it.
- brandName: string | null
-
The brand of fuel card
- embossedName: string | null
-
The name embossed on the fuel card
- expiryDate: string | null
-
The expiry date of the fuel card in the format YYYY/MM/DD
- description: string | null
-
A short description of the fuel card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this fuelcard.
- asset: IdName | null
-
The asset to which this fuel card has been assigned.
- ownerId: string
Example
{
"name": "string",
"brandName": "string",
"embossedName": "string",
"expiryDate": "string",
"description": "string",
"state": "string",
"fields": {},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string"
}
GeoLockTimeItem: object
- id: string
-
The unique ID of this geo lock time item
- days: number[]
-
The days of the week that this profile is active for (0 - 6, 0 = Sunday)
-
number (double) - from: string
-
The time from which this geolock starts (HH:mm:ss)
- to: string
-
The time at which this geolock ends (HH:mm:ss)
- timeZoneId: string
-
The time zone ID of the time values
Example
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
GeoLockProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- radiusKm: number | null (double)
-
The radius of the geo lock (in kilometers)
- times: GeoLockTimeItem | null
-
The geo lock times for this profile
-
GeoLockTimeItem - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"modifiedDate": "string"
}
GeoLockProfileListResponse: object
A list of geo lock profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: GeoLockProfileListItem
-
GeoLockProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"modifiedDate": "string"
}
]
}
GeoLockProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- radiusKm: number | null (double)
-
The radius of the geo lock (in kilometers)
- times: GeoLockTimeItem | null
-
The geo lock times for this profile
-
GeoLockTimeItem - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
GeoLockProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- radiusKm: number | null (double)
-
The radius of the geo lock (in kilometers)
- times: GeoLockTimeItem | null
-
The geo lock times for this profile
-
GeoLockTimeItem
Example
{
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
]
}
GeoLockProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- radiusKm: number | null (double)
-
The radius of the geo lock (in kilometers)
- times: GeoLockTimeItem | null
-
The geo lock times for this profile
-
GeoLockTimeItem - ownerId: string
-
The client that owns this geo lock profile
Example
{
"name": "string",
"state": "string",
"radiusKm": "number (double)",
"times": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"ownerId": "string"
}
IoTypeTextConfig: object
- active: string | null
-
Text that can be substituted for the value when the io type is active
- inactive: string | null
-
Text that can be substituted for the value when the io type is inactive
Example
{
"active": "string",
"inactive": "string"
}
IoTypeRateConfig: object
- type: string | null none, val_per_km, km_per_val, val_per_mile, mile_per_val, val_per_hour, hour_per_val
-
The type of rate conversion to do
- multiplier: number | null (double)
-
A multiplier for the value
- unit: string | null
-
The unit once the rate conversion is done
Example
{
"type": "string",
"multiplier": "number (double)",
"unit": "string"
}
IoTypeListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- type: string | null digital_input, digital_output, analog_input, temperature_input, can_input, counter_input, camera_input, value_input
-
The type of the IO type
- unit: string | null
-
Optional units that this I/O type is measured in
- smoothingType: string | null none, moving_average_5, moving_average_10, moving_average_20, moving_average_50, moving_average_100, moving_average_200
-
The type of smoothing to apply to this input
- text: IoTypeTextConfig | null
-
Digital types can have their value substituted with the following text
- rate: IoTypeRateConfig | null
-
An optional rate conversion to do on this value
- lookups: IdName | null
-
A dictionary of lookup values. Only relevant for "value_input" types.
-
IdName - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"modifiedDate": "string"
}
IoTypeListResponse: object
A list of I/O type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: IoTypeListItem
-
IoTypeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"modifiedDate": "string"
}
]
}
IoTypeResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- type: string | null digital_input, digital_output, analog_input, temperature_input, can_input, counter_input, camera_input, value_input
-
The type of the IO type
- unit: string | null
-
Optional units that this I/O type is measured in
- smoothingType: string | null none, moving_average_5, moving_average_10, moving_average_20, moving_average_50, moving_average_100, moving_average_200
-
The type of smoothing to apply to this input
- text: IoTypeTextConfig | null
-
Digital types can have their value substituted with the following text
- rate: IoTypeRateConfig | null
-
An optional rate conversion to do on this value
- lookups: IdName | null
-
A dictionary of lookup values. Only relevant for "value_input" types.
-
IdName - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
IoTypeUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- type: string | null digital_input, digital_output, analog_input, temperature_input, can_input, counter_input, camera_input, value_input
-
The type of the IO type
- unit: string | null
-
Optional units that this I/O type is measured in
- smoothingType: string | null none, moving_average_5, moving_average_10, moving_average_20, moving_average_50, moving_average_100, moving_average_200
-
The type of smoothing to apply to this input
- text: IoTypeTextConfig | null
-
Digital types can have their value substituted with the following text
- rate: IoTypeRateConfig | null
-
An optional rate conversion to do on this value
- lookups: IdName | null
-
A dictionary of lookup values. Only relevant for "value_input" types.
-
IdName
Example
{
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
IoTypeCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- type: string | null digital_input, digital_output, analog_input, temperature_input, can_input, counter_input, camera_input, value_input
-
The type of the IO type
- unit: string | null
-
Optional units that this I/O type is measured in
- smoothingType: string | null none, moving_average_5, moving_average_10, moving_average_20, moving_average_50, moving_average_100, moving_average_200
-
The type of smoothing to apply to this input
- text: IoTypeTextConfig | null
-
Digital types can have their value substituted with the following text
- rate: IoTypeRateConfig | null
-
An optional rate conversion to do on this value
- lookups: IdName | null
-
A dictionary of lookup values. Only relevant for "value_input" types.
-
IdName - ownerId: string
-
The client or vendor that owns this entity
Example
{
"name": "string",
"state": "string",
"type": "string",
"unit": "string",
"smoothingType": "string",
"text": {
"active": "string",
"inactive": "string"
},
"rate": {
"type": "string",
"multiplier": "number (double)",
"unit": "string"
},
"lookups": [
{
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"ownerId": "string"
}
LabelListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- label: string | null
-
A lowercase alphanumeric label value
- name: string | null
-
A friendly descriptive name for label
- color: string | null
-
An optional color for this label
- state: string | null active, deleted
-
The current state of this entity
- values: LabelValuePayload | null
-
A list of sub labels that are mutually exclusive
-
LabelValuePayload - entities: string[] | null
-
The entities to which this label applies
-
string - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"modifiedDate": "string"
}
LabelListResponse: object
A list of I/O type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: LabelListItem
-
LabelListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"modifiedDate": "string"
}
]
}
LabelResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- label: string | null
-
A lowercase alphanumeric label value
- name: string | null
-
A friendly descriptive name for label
- color: string | null
-
An optional color for this label
- state: string | null active, deleted
-
The current state of this entity
- values: LabelValuePayload | null
-
A list of sub labels that are mutually exclusive
-
LabelValuePayload - entities: string[] | null
-
The entities to which this label applies
-
string - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
LabelUpdateRequest: object
- label: string | null
-
A lowercase alphanumeric label value
- name: string | null
-
A friendly descriptive name for label
- color: string | null
-
An optional color for this label
- state: string | null active, deleted
-
The current state of this entity
- values: LabelValuePayload | null
-
A list of sub labels that are mutually exclusive
-
LabelValuePayload - entities: string[] | null
-
The entities to which this label applies
-
string
Example
{
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
]
}
LabelCreateRequest: object
- label: string | null
-
A lowercase alphanumeric label value
- name: string | null
-
A friendly descriptive name for label
- color: string | null
-
An optional color for this label
- state: string | null active, deleted
-
The current state of this entity
- values: LabelValuePayload | null
-
A list of sub labels that are mutually exclusive
-
LabelValuePayload - entities: string[] | null
-
The entities to which this label applies
-
string - ownerId: string
-
The client or vendor that owns this entity
Example
{
"label": "string",
"name": "string",
"color": "string",
"state": "string",
"values": [
{
"label": "string",
"name": "string",
"color": "string"
}
],
"entities": [
"string"
],
"ownerId": "string"
}
MapSetLayer: object
- name: string
-
The name of the map layer
- projection: string
-
The projection of the map
- minZoom: number (double)
-
The minimum zoom level supported by this map layer
- maxZoom: number (double)
-
The maximum zoom level supported by this map layer
- serverType: string google, wms, osm, wmts, dds, tms, mbs
-
The map server type
- order: number (double)
-
The order of the layer amongst it's peers
- imageType: string png, jpg, jpeg, gif, mvt
-
The image type of the map tiles
- layerName: string
-
The name of the layer to present to the map server
- servers: string[]
-
A list of map server urls
-
string - overlays: MapSetLayer
-
An optional list of layers to overlay on this layer
-
MapSetLayer - attribution: string | null
-
The source attribution text to overlay on this map layer
Example
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MapSetListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this map set
- layers: MapSetLayer | null
-
One or more layers available in this map set
-
MapSetLayer - state: string | null active, deleted
-
The state of this map set
- overlays: MapSetLayer | null
-
One or more overlays for this map set
-
MapSetLayer - staticMapURL: string | null
-
The url to use for static maps when this map set is selected
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MapSetListResponse: object
A list of map set items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: MapSetListItem
-
MapSetListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MapSetResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this map set
- layers: MapSetLayer | null
-
One or more layers available in this map set
-
MapSetLayer - state: string | null active, deleted
-
The state of this map set
- overlays: MapSetLayer | null
-
One or more overlays for this map set
-
MapSetLayer - staticMapURL: string | null
-
The url to use for static maps when this map set is selected
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MapsetUpdateRequest: object
- name: string | null
-
A unique name for this map set
- layers: MapSetLayer | null
-
One or more layers available in this map set
-
MapSetLayer - state: string | null active, deleted
-
The state of this map set
- overlays: MapSetLayer | null
-
One or more overlays for this map set
-
MapSetLayer - staticMapURL: string | null
-
The url to use for static maps when this map set is selected
Example
{
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
MapsetCreateRequest: object
- name: string | null
-
A unique name for this map set
- layers: MapSetLayer | null
-
One or more layers available in this map set
-
MapSetLayer - state: string | null active, deleted
-
The state of this map set
- overlays: MapSetLayer | null
-
One or more overlays for this map set
-
MapSetLayer - staticMapURL: string | null
-
The url to use for static maps when this map set is selected
- ownerId: string
-
The client that owns this map set
Example
{
"name": "string",
"layers": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)",
"serverType": "string",
"order": "number (double)",
"imageType": "string",
"layerName": "string",
"servers": [
"string"
],
"overlays": [
{
"name": "string",
"projection": "string",
"minZoom": "number (double)",
"maxZoom": "number (double)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
OverspeedBandItem: object
- id: string
-
The unique ID of this overspeed band
- name: string
-
A descriptive name for this overspeed band
- min: number (double)
-
The minimum inclusive value to match this band on
- offset: number (double)
-
The offset in km/h to add to the minimum inclusive value to match this band on
Example
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
OverspeedProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: OverspeedBandItem | null
-
The overspeed band items for this profile
-
OverspeedBandItem - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"modifiedDate": "string"
}
OverspeedProfileListResponse: object
A list of overspeed profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: OverspeedProfileListItem
-
OverspeedProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"modifiedDate": "string"
}
]
}
OverspeedProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: OverspeedBandItem | null
-
The overspeed band items for this profile
-
OverspeedBandItem - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
OverspeedProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: OverspeedBandItem | null
-
The overspeed band items for this profile
-
OverspeedBandItem
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
]
}
OverspeedProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- items: OverspeedBandItem | null
-
The overspeed band items for this profile
-
OverspeedBandItem - ownerId: string
-
The client that owns this Overspeed Profile
Example
{
"name": "string",
"state": "string",
"items": [
{
"id": "string",
"name": "string",
"min": "number (double)",
"offset": "number (double)"
}
],
"ownerId": "string"
}
PrivacyProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleTriggers: PrivacyScheduleItem | null
-
The scheduled trigger times for this profile
-
PrivacyScheduleItem - stateTriggers: PrivacyStateItem | null
-
The state profiles to trigger on
-
PrivacyStateItem - enableManualTrigger: boolean | null
-
Set to true to allow manual privacy mode triggers via the API
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"modifiedDate": "string"
}
PrivacyProfileListResponse: object
A list of privacy profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: PrivacyProfileListItem
-
PrivacyProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"modifiedDate": "string"
}
]
}
PrivacyProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleTriggers: PrivacyScheduleItem | null
-
The scheduled trigger times for this profile
-
PrivacyScheduleItem - stateTriggers: PrivacyStateItem | null
-
The state profiles to trigger on
-
PrivacyStateItem - enableManualTrigger: boolean | null
-
Set to true to allow manual privacy mode triggers via the API
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
PrivacyProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleTriggers: PrivacyScheduleItem | null
-
The scheduled trigger times for this profile
-
PrivacyScheduleItem - stateTriggers: PrivacyStateItem | null
-
The state profiles to trigger on
-
PrivacyStateItem - enableManualTrigger: boolean | null
-
Set to true to allow manual privacy mode triggers via the API
Example
{
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean"
}
PrivacyProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleTriggers: PrivacyScheduleItem | null
-
The scheduled trigger times for this profile
-
PrivacyScheduleItem - stateTriggers: PrivacyStateItem | null
-
The state profiles to trigger on
-
PrivacyStateItem - enableManualTrigger: boolean | null
-
Set to true to allow manual privacy mode triggers via the API
- ownerId: string
-
The company that owns this privacy profile
Example
{
"name": "string",
"state": "string",
"scheduleTriggers": [
{
"id": "string",
"days": [
"number (double)"
],
"from": "string",
"to": "string",
"timeZoneId": "string"
}
],
"stateTriggers": [
{
"id": "string",
"stateProfileId": "string",
"stateValue": "string"
}
],
"enableManualTrigger": "boolean",
"ownerId": "string"
}
ReportDefinitionStyleLimits: object
Describes limits for this report
- days: number (double)
-
The maximum number of days that can be selected for this report
Example
{
"days": "number (double)"
}
ReportDefinitionGroupingOptions: object
Describes the fields that are used for a particular grouping option
- id: string
-
The id of this grouping option
- name: string
-
The display name of this grouping option
- fields: string[]
-
The dataset fields that will be combined for this group
-
string
Example
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
ReportDefinitionColumnOptions: object
Describes column options
- id: string
-
The id of the column
- title: string
-
The title of the column
- width: number (double)
-
The width of the column
- def: boolean
-
Indicates whether this column is suggested as a default
- required: boolean
-
Indicates whether this column is required
- align: string Left, Center, Right
-
The text alignment, either 'Left', 'Center' or 'Right'
- expression: string | null
-
The calculated measures expression to use
Example
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
ReportDefinitionLayoutOptions: object
Describes the report columns and other layout options
- grouping: ReportDefinitionGroupingOptions
-
Describes the fields that are used for a particular grouping option
-
ReportDefinitionGroupingOptions - columns: ReportDefinitionColumnOptions
-
Describes column options
-
ReportDefinitionColumnOptions - autoColumns: string[]
-
string
Example
{
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
ReportDefinitionStyleOptions: object
Describes a particular style of a report
- id: string
-
The ID of this report style
- name: string
-
The name of this report style
- schedulable: boolean
-
Indicates whether this report can be scheduled
- limits: ReportDefinitionStyleLimits
-
Describes limits for this report
- parameters: string
-
A JSON string that describes the parameter input fields for this report
- layout: ReportDefinitionLayoutOptions
-
Describes the report columns and other layout options
Example
{
"id": "string",
"name": "string",
"schedulable": "boolean",
"limits": {
"days": "number (double)"
},
"parameters": "string",
"layout": {
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
}
ReportDefinitionResponse: object
A ReportDefinition describes a runnable report, it's parameters and layout options
- id: string
-
The unique ID of this report definition
- owner: IdNameType
-
The entity that owns this report definition
- name: string
-
A unique name for this report
- description: string
-
A description of the report
- tags: string[]
-
A list of tags that describe this report
-
string - source: string dataset, analytics
-
The reporting subsystem that generates this report
- schedulable: boolean
-
Indicates whether this report can be scheduled
- styles: ReportDefinitionStyleOptions
-
One or more report styles that can be selected for this report
-
ReportDefinitionStyleOptions
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"source": "string",
"schedulable": "boolean",
"styles": [
{
"id": "string",
"name": "string",
"schedulable": "boolean",
"limits": {
"days": "number (double)"
},
"parameters": "string",
"layout": {
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
}
]
}
ReportDefinitionListResponse: object
A list of map set items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ReportDefinitionResponse
-
ReportDefinitionResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"source": "string",
"schedulable": "boolean",
"styles": [
{
"id": "string",
"name": "string",
"schedulable": "boolean",
"limits": {
"days": "number (double)"
},
"parameters": "string",
"layout": {
"grouping": [
{
"id": "string",
"name": "string",
"fields": [
"string"
]
}
],
"columns": [
{
"id": "string",
"title": "string",
"width": "number (double)",
"def": "boolean",
"required": "boolean",
"align": "string",
"expression": "string"
}
],
"autoColumns": [
"string"
]
}
}
]
}
]
}
ReportTemplateConfig: object
- outputFormat: string pdf, xlsx, xml, csv, raw, json, raw_compact, source
-
The output format for this report
- definitionId: string
-
The ID of the report defininition that was used to create this report
- styleId: string
-
The style of the report that was selected
- parameters: object
-
The parameters that were passed to the report
- editableFields: string[]
-
The report fields that should be visible and modifyable by the end user
-
string
Example
{
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
ReportTemplateResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this report template
- description: string | null
-
A description of the report
- tags: string[] | null
-
A list of tags that describe this report template
-
string - config: ReportTemplateConfig | null
-
The preset configuration for this template
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
ReportTemplateListResponse: object
A list of report template items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ReportTemplateResponse
-
ReportTemplateResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
]
}
ReportTemplateCreateRequest: object
- name: string | null
-
A unique name for this report template
- description: string | null
-
A description of the report
- tags: string[] | null
-
A list of tags that describe this report template
-
string - config: ReportTemplateConfig | null
-
The preset configuration for this template
- ownerId: string
Example
{
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
},
"ownerId": "string"
}
ReportTemplateUpdateRequest: object
- name: string | null
-
A unique name for this report template
- description: string | null
-
A description of the report
- tags: string[] | null
-
A list of tags that describe this report template
-
string - config: ReportTemplateConfig | null
-
The preset configuration for this template
Example
{
"name": "string",
"description": "string",
"tags": [
"string"
],
"config": {
"outputFormat": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object",
"editableFields": [
"string"
]
}
}
ReminderTriggerValue: object
- start: string | null
-
For odometer and hours values, specify the starting value from which to base subsequent increments
- value: string | null
-
For odometer and hours, the increment from start to trigger at.
Example
{
"start": "string",
"value": "string"
}
ReminderResetDaily: object
- recurrence: number (double)
Example
{
"recurrence": "number (double)"
}
ReminderResetWeekly: object
- days: number[]
-
number (double)
Example
{
"days": [
"number (double)"
]
}
ReminderResetMonthly: object
- months: number[]
-
number (double) - day: number (double)
Example
{
"months": [
"number (double)"
],
"day": "number (double)"
}
ReminderReset: object
- type: string | null none, daily, weekly, monthly
-
The type of reset for the reminder. Affects which of the reset fields need to be completed.
- counter: number | null (double)
- daily: ReminderResetDaily | null
-
Daily reset parameters
- weekly: ReminderResetWeekly | null
-
Weekly reset parameters
- monthly: ReminderResetMonthly | null
-
Monthly reset parameters
Example
{
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
}
ReminderListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this reminder
- target: IdNameType | null
-
The target entity to which this reminder applies. Usually an asset.
- type: string | null odo, hours, time
-
Specify the trigger type of the reminder, which can be either time, odometer or engine hours.
- mode: string | null once, repeating
-
The reminder mode. If set to once, the reminder will be disabled as soon as it has triggered at least once.
- timeZoneId: string | null
-
The timezone to use for time based triggers.
- trigger: ReminderTriggerValue | null
-
The value to trigger at. This could be a date/time or and odometer or engine hours value.
- reset: ReminderReset | null
- enabled: boolean | null
-
Whether the reminder is still enabled (will be false for reminders with mode set to
oncethat have already triggered. - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"modifiedDate": "string"
}
ReminderListResponse: object
A list of reminder items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ReminderListItem
-
ReminderListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"modifiedDate": "string"
}
]
}
ReminderResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this reminder
- target: IdNameType | null
-
The target entity to which this reminder applies. Usually an asset.
- type: string | null odo, hours, time
-
Specify the trigger type of the reminder, which can be either time, odometer or engine hours.
- mode: string | null once, repeating
-
The reminder mode. If set to once, the reminder will be disabled as soon as it has triggered at least once.
- timeZoneId: string | null
-
The timezone to use for time based triggers.
- trigger: ReminderTriggerValue | null
-
The value to trigger at. This could be a date/time or and odometer or engine hours value.
- reset: ReminderReset | null
- enabled: boolean | null
-
Whether the reminder is still enabled (will be false for reminders with mode set to
oncethat have already triggered. - lastTriggered: string | null
-
The date/time when the reminder last triggered.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"lastTriggered": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ReminderUpdateRequest: object
- name: string | null
-
A unique name for this reminder
- target: IdNameType | null
-
The target entity to which this reminder applies. Usually an asset.
- type: string | null odo, hours, time
-
Specify the trigger type of the reminder, which can be either time, odometer or engine hours.
- mode: string | null once, repeating
-
The reminder mode. If set to once, the reminder will be disabled as soon as it has triggered at least once.
- timeZoneId: string | null
-
The timezone to use for time based triggers.
- trigger: ReminderTriggerValue | null
-
The value to trigger at. This could be a date/time or and odometer or engine hours value.
- reset: ReminderReset | null
- enabled: boolean | null
-
Whether the reminder is still enabled (will be false for reminders with mode set to
oncethat have already triggered.
Example
{
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean"
}
ReminderCreateRequest: object
- name: string | null
-
A unique name for this reminder
- target: IdNameType | null
-
The target entity to which this reminder applies. Usually an asset.
- type: string | null odo, hours, time
-
Specify the trigger type of the reminder, which can be either time, odometer or engine hours.
- mode: string | null once, repeating
-
The reminder mode. If set to once, the reminder will be disabled as soon as it has triggered at least once.
- timeZoneId: string | null
-
The timezone to use for time based triggers.
- trigger: ReminderTriggerValue | null
-
The value to trigger at. This could be a date/time or and odometer or engine hours value.
- reset: ReminderReset | null
- enabled: boolean | null
-
Whether the reminder is still enabled (will be false for reminders with mode set to
oncethat have already triggered. - ownerId: string
-
The client that owns this reminder
Example
{
"name": "string",
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"type": "string",
"mode": "string",
"timeZoneId": "string",
"trigger": {
"start": "string",
"value": "string"
},
"reset": {
"type": "string",
"counter": "number (double)",
"daily": {
"recurrence": "number (double)"
},
"weekly": {
"days": [
"number (double)"
]
},
"monthly": {
"months": [
"number (double)"
],
"day": "number (double)"
}
},
"enabled": "boolean",
"ownerId": "string"
}
RoadSpeedModifierEntry: object
- id: string
-
The unique ID of this road speed modifier
- name: string
-
A descriptive name for this road speed modifier
- filter: EventFilter
-
The filter that this road speed modifier matches on
- speed: number (double)
-
The new road speed that will be applied if the filter matches.
- unit: string kmh, mph
-
The speed unit, either km/h or miles per hour
Example
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
RoadProfileListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- speedModifiers: RoadSpeedModifierEntry | null
-
The road speed modifiers for this profile
-
RoadSpeedModifierEntry - modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"modifiedDate": "string"
}
RoadProfileListResponse: object
A list of road profile items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: RoadProfileListItem
-
RoadProfileListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"modifiedDate": "string"
}
]
}
RoadProfileResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- speedModifiers: RoadSpeedModifierEntry | null
-
The road speed modifiers for this profile
-
RoadSpeedModifierEntry - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
RoadProfileUpdateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- speedModifiers: RoadSpeedModifierEntry | null
-
The road speed modifiers for this profile
-
RoadSpeedModifierEntry
Example
{
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
]
}
RoadProfileCreateRequest: object
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- speedModifiers: RoadSpeedModifierEntry | null
-
The road speed modifiers for this profile
-
RoadSpeedModifierEntry - ownerId: string
-
The client that owns this Road Profile
Example
{
"name": "string",
"state": "string",
"speedModifiers": [
{
"id": "string",
"name": "string",
"filter": {
"actor": {
"actorType": "string",
"actorTypeId": "string",
"actorTypeName": "string",
"actorSelectionType": "string",
"actorId": "string",
"actorName": "string",
"text": "string"
},
"action": {
"eventClass": "string",
"eventType": "string",
"targetType": "string",
"text": "string"
},
"target": {
"targetType": "string",
"targetTypeId": "string",
"targetTypeName": "string",
"targetSelectionType": "string",
"targetId": "string",
"targetName": "string",
"text": "string"
},
"conditions": [
{
"type": "string",
"values": {},
"text": {}
}
]
},
"speed": "number (double)",
"unit": "string"
}
],
"ownerId": "string"
}
Schedule: object
- scheduleType: string | null once, hourly, daily, weekly, monthly
-
The type of schedule
- startTime: string | null
-
The time of schedule initation. Also sets the time at which reports run.
- every: number | null (double)
-
For daily and hourly scheduled, every {{every}} x hours/days
- days: number[] | null
-
For weekly schedules, the days of the week in which to run (0-6 where 0 = sunday). For monthly schedule, a single value with the day of the month to run on.
-
number (double) - months: number[] | null
-
For monthly schedules, the month number (1-12) in which to run.
-
number (double)
Example
{
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
}
ScheduledReportListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- user: IdName | null
-
The user who's security credentials to use when running this schedule.
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity.
- scheduleType: string | null report, analytics
-
The type of scheduled report.
- schedule: Schedule | null
-
The time schedule on which to run.
- reports: number | null (double)
-
The number of reports attached to this schedule.
- recipients: number | null (double)
-
The number of recipients that will receive an email with the completed reports.
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": "number (double)",
"recipients": "number (double)",
"modifiedDate": "string"
}
ScheduledReportListResponse: object
A list of scheduled report items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ScheduledReportListItem
-
ScheduledReportListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": "number (double)",
"recipients": "number (double)",
"modifiedDate": "string"
}
]
}
ReportConfig: object
The configuration settings for the queued report
- language: string | null
-
The language that this report is being generated in
- definitionId: string | null
-
The ID of the report defininition that was used to create this report
- styleId: string | null
-
The style of the report that was selected
- parameters: object | null
-
The parameters that were passed to the report
Example
{
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
}
ScheduledReportReport: object
- title: string | null
-
The report title as set by the user
- outputFormat: string | null pdf, xlsx, xml, csv, raw, json, raw_compact, source
-
The output format for this report
- config: ReportConfig | null
-
The report configuration
Example
{
"title": "string",
"outputFormat": "string",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
}
}
ScheduledReportResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- user: IdName | null
-
The user who's security credentials to use when running this schedule.
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleType: string | null report, analytics
-
The type of scheduled report.
- schedule: Schedule | null
-
The time schedule on which to run
- reports: ScheduledReportReports | null
-
The reports that should be run when the schedule fires.
- recipients: IdNameType | null
-
The recipients that will receive an email with the completed reports
-
IdNameType - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ScheduledReportUpdateRequest: object
- user: IdName | null
-
The user who's security credentials to use when running this schedule.
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleType: string | null report, analytics
-
The type of scheduled report.
- schedule: Schedule | null
-
The time schedule on which to run
- reports: ScheduledReportReports | null
-
The reports that should be run when the schedule fires.
- recipients: IdNameType | null
-
The recipients that will receive an email with the completed reports
-
IdNameType
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
]
}
ScheduledReportCreateRequest: object
- user: IdName | null
-
The user who's security credentials to use when running this schedule.
- name: string | null
-
A unique name for this entity
- state: string | null active, deleted
-
The current state of this entity
- scheduleType: string | null report, analytics
-
The type of scheduled report.
- schedule: Schedule | null
-
The time schedule on which to run
- reports: ScheduledReportReports | null
-
The reports that should be run when the schedule fires.
- recipients: IdNameType | null
-
The recipients that will receive an email with the completed reports
-
IdNameType - ownerId: string
-
The client or vendor that owns this entity
Example
{
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"state": "string",
"scheduleType": "string",
"schedule": {
"scheduleType": "string",
"startTime": "string",
"every": "number (double)",
"days": [
"number (double)"
],
"months": [
"number (double)"
]
},
"reports": {},
"recipients": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"ownerId": "string"
}
SimCardListItem: object
- id: string
-
The unique UUID for this SIM card
- owner: IdName
-
The client that owns this SIM card
- name: string
-
The serial number of the SIM card that is used to uniquely identify it.
- networkName: string
-
The name of the telecommunications network.
- number: string
-
The direct mobile number for this SIM card. Must be in international format starting with +.
- description: string
-
A short description of the sim card.
- state: string inactive, active, suspended, deleted
-
The current state of the object
- device: IdName
-
The device to which this SIM card has been assigned.
- fields: CustomFieldValues
-
A number of custom field values for this simcard.
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
SimCardListResponse: object
A list of SIM card items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: SimCardListItem
-
The list of SIM card items in this response
-
SimCardListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"fields": {}
}
]
}
SimCardResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The serial number of the SIM card that is used to uniquely identify it.
- networkName: string | null
-
The name of the telecommunications network.
- number: string | null
-
The direct mobile number for this SIM card. Must be in international format starting with +.
- description: string | null
-
A short description of the sim card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this simcard.
- device: IdName | null
-
The device to which this SIM card has been assigned. Can only be modified using the
updateDeviceoperation. - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"device": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
SimCardUpdateRequest: object
- name: string | null
-
The serial number of the SIM card that is used to uniquely identify it.
- networkName: string | null
-
The name of the telecommunications network.
- number: string | null
-
The direct mobile number for this SIM card. Must be in international format starting with +.
- description: string | null
-
A short description of the sim card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this simcard.
Example
{
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {}
}
SimCardCreateRequest: object
- name: string | null
-
The serial number of the SIM card that is used to uniquely identify it.
- networkName: string
-
The name of the telecommunications network.
- number: string
-
The direct mobile number for this SIM card. Must be in international format starting with +.
- description: string
-
A short description of the sim card.
- state: string | null inactive, active, suspended, deleted
-
The current state of the object
- fields: CustomFieldValues | null
-
A number of custom field values for this simcard.
- ownerId: string
Example
{
"name": "string",
"networkName": "string",
"number": "string",
"description": "string",
"state": "string",
"fields": {},
"ownerId": "string"
}
SmsGatewayProviderListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the sms gateway provider
- type: IdName | null
-
The type of the sms gateway provider
- direction: string | null oneway, twoway
-
Whether or not the sms gateway is oneway or twoway
- state: string | null active, suspended, deleted
-
The state this entity
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
SmsGatewayProviderListResponse: object
A list of sms gateway provider items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: SmsGatewayProviderListItem
-
SmsGatewayProviderListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
SmsGatewayProviderResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
The name of the sms gateway provider
- type: IdName | null
-
The type of the sms gateway provider
- direction: string | null oneway, twoway
-
Whether or not the sms gateway is oneway or twoway
- state: string | null active, suspended, deleted
-
The state this entity
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
SmsGatewayProviderUpdateRequest: object
- name: string | null
-
The name of the sms gateway provider
- type: IdName | null
-
The type of the sms gateway provider
- direction: string | null oneway, twoway
-
Whether or not the sms gateway is oneway or twoway
- state: string | null active, suspended, deleted
-
The state this entity
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {}
}
SmsGatewayProviderCreateRequest: object
- name: string | null
-
The name of the sms gateway provider
- type: IdName | null
-
The type of the sms gateway provider
- direction: string | null oneway, twoway
-
Whether or not the sms gateway is oneway or twoway
- state: string | null active, suspended, deleted
-
The state this entity
- parameters: Dictionary | null
-
A dictionary of entity specific parameters
- ownerId: string
-
The client that owns this sms gateway provider
Example
{
"name": "string",
"type": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"direction": "string",
"state": "string",
"parameters": {},
"ownerId": "string"
}
SmsGatewayProviderTypeListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
The name of the sms gateway provider type
- tag: string
-
The tag to apply to the sms gateway provider type
- parameterDefinition: string | null
-
The parameters used by the sms gateway type
- direction: string | null oneway, twoway
-
Whether or not the sms gateway type is oneway or twoway
- state: string | null active, deleted
-
The state this entity
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
SmsGatewayProviderTypeListResponse: object
A list of sms gateway provider type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: SmsGatewayProviderTypeListItem
-
SmsGatewayProviderTypeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"direction": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
SmsGatewayProviderTypeResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
The name of the sms gateway provider type
- tag: string
-
The tag to apply to the sms gateway provider type
- parameterDefinition: string | null
-
The parameters used by the sms gateway type
- direction: string | null oneway, twoway
-
Whether or not the sms gateway type is oneway or twoway
- state: string | null active, deleted
-
The state this entity
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"direction": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
EmailProviderTypeListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
The name of the email provider type
- tag: string
-
The tag to apply to the email provider type
- parameterDefinition: string | null
-
The parameters used by the email provider type
- state: string | null active, deleted
-
The state of the email provider type
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"state": "string",
"modifiedDate": "string"
}
EmailProviderTypeListResponse: object
A list of email provider type items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: EmailProviderTypeListItem
-
EmailProviderTypeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
EmailProviderTypeResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string
-
The name of the email provider type
- tag: string
-
The tag to apply to the email provider type
- parameterDefinition: string | null
-
The parameters used by the email provider type
- state: string | null active, deleted
-
The state of the email provider type
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"tag": "string",
"parameterDefinition": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ThemeListItem: object
- id: string
-
The unique ID of the theme
- owner: IdNameType
-
The entity that owns this theme
- theme: string
-
The ID of the base theme CSS
- name: string
-
The name of the theme
- description: string
-
An optional description of the theme
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string"
}
ThemeListResponse: object
A list of vendor items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ThemeListItem
-
ThemeListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string"
}
]
}
ThemeCustomHTMLTag: object
- name: string
-
A descriptive name for the custom tag
- tag: string
-
The HTML tag type, i.e. 'script' or 'div'
- attributes: string
-
A list of attributes for the tag
- contents: string
-
The contents of the HTML Tag
- location: string head, body
-
The location where the tag should be inserted
Example
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
ThemeResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- theme: string | null
-
The ID of the base theme CSS
- name: string | null
-
The name of the theme
- description: string | null
-
An optional description of the theme
- state: string | null active, deleted
-
The current state of this entity
- variables: ThemeVariables | null
-
The list of css custom properties
- settings: ThemeSettings | null
-
The list of adjustable settings
- customStyles: string | null
-
The custom overwrites that will be injected after the theme css
- customTags: ThemeCustomHTMLTag | null
-
A list of custom HTML tags that are to be injected into the page for this theme
-
ThemeCustomHTMLTag - entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ThemeUpdateRequest: object
- theme: string | null
-
The ID of the base theme CSS
- name: string | null
-
The name of the theme
- description: string | null
-
An optional description of the theme
- state: string | null active, deleted
-
The current state of this entity
- variables: ThemeVariables | null
-
The list of css custom properties
- settings: ThemeSettings | null
-
The list of adjustable settings
- customStyles: string | null
-
The custom overwrites that will be injected after the theme css
- customTags: ThemeCustomHTMLTag | null
-
A list of custom HTML tags that are to be injected into the page for this theme
-
ThemeCustomHTMLTag
Example
{
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
]
}
ThemeCreateRequest: object
- theme: string | null
-
The ID of the base theme CSS
- name: string | null
-
The name of the theme
- description: string | null
-
An optional description of the theme
- state: string | null active, deleted
-
The current state of this entity
- variables: ThemeVariables | null
-
The list of css custom properties
- settings: ThemeSettings | null
-
The list of adjustable settings
- customStyles: string | null
-
The custom overwrites that will be injected after the theme css
- customTags: ThemeCustomHTMLTag | null
-
A list of custom HTML tags that are to be injected into the page for this theme
-
ThemeCustomHTMLTag - ownerId: string
-
The client or vendor that owns this entity
Example
{
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"ownerId": "string"
}
AuthEndpoint: object
- id: string
-
The ID for the endpoint.
- type: string local, oidc
-
Type type of endpoint
- name: string
-
A friendly name for the endpoint.
- endpoint: string
-
The endpoint url, i.e. https://accounts.google.com
- clientId: string
-
The endpoint client id
Example
{
"id": "string",
"type": "string",
"name": "string",
"endpoint": "string",
"clientId": "string"
}
AuthInfo: object
- availableAuth: string[]
-
The types of authentication that are available
-
string local, oidc - endpoints: AuthEndpoint
-
3rd party endpoints which can handle authentication
-
AuthEndpoint
Example
{
"availableAuth": [
"string"
],
"endpoints": [
{
"id": "string",
"type": "string",
"name": "string",
"endpoint": "string",
"clientId": "string"
}
]
}
DomainInfo: object
- domain: string
-
The domain name
- owner: IdNameType | null
-
The company that owns the domain name. Will be
undefinedif no domain was matched. - auth: AuthInfo
-
Authentication information for this domain
- message: string | null
-
An optional messge to display to the user at logon time
Example
{
"domain": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"auth": {
"availableAuth": [
"string"
],
"endpoints": [
{
"id": "string",
"type": "string",
"name": "string",
"endpoint": "string",
"clientId": "string"
}
]
},
"message": "string"
}
DomainThemeResponse: object
- domain: DomainInfo
-
The domain details
- theme: ThemeResponse
-
The theme for this domain
Example
{
"domain": {
"domain": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"auth": {
"availableAuth": [
"string"
],
"endpoints": [
{
"id": "string",
"type": "string",
"name": "string",
"endpoint": "string",
"clientId": "string"
}
]
},
"message": "string"
},
"theme": {
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"theme": "string",
"name": "string",
"description": "string",
"state": "string",
"variables": {},
"settings": {},
"customStyles": "string",
"customTags": [
{
"name": "string",
"tag": "string",
"attributes": "string",
"contents": "string",
"location": "string"
}
],
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
}
ZoneGroupListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- modifiedDate: string
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
ZoneGroupListResponse: object
A list of zone group items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ZoneGroupListItem
-
ZoneGroupListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"modifiedDate": "string"
}
]
}
ZoneGroupResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ZoneGroupUpdateRequest: object
- name: string | null
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
ZoneGroupCreateRequest: object
- name: string
-
A unique name for this entity
- parent: IdName | null
-
The parent of this entity
- ownerId: string
-
The client that owns this entity
Example
{
"name": "string",
"parent": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"ownerId": "string"
}
ZoneCenter: object
- x: number (double)
- y: number (double)
Example
{
"x": "number (double)",
"y": "number (double)"
}
ZoneBounds: object
- top: number (double)
- left: number (double)
- bottom: number (double)
- right: number (double)
Example
{
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
}
ZonePoint: object
- x: number (double)
- y: number (double)
Example
{
"x": "number (double)",
"y": "number (double)"
}
ZoneListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this zone
- group: IdName | null
-
The zone group to which this zone belongs
- costCentre: IdName | null
-
The cost centre to which this zone belongs
- state: string | null inactive, active, deleted
-
The state of this zone
- zoneType: string | null location, keepin, nogo, route
-
The type of zone
- speed: number | null (double)
-
A speed limit (in km/h) to apply to this zone. Any asset that enters this zone will have the road speed limit overriden by the zone speed limit.
- radius: number | null (double)
-
For zone proximity alerts, specifiy a distance in km from the center of the zone.
- points: ZonePoint | null
-
The points for the zone polygon/polyline. Only populated on
get*routes. -
ZonePoint - tag: string | null
-
The tag entity
- center: ZoneCenter | null
-
The center of the zone (this is automatically calculated from the zone polygon.
- bounds: ZoneBounds | null
-
The rectangular bounds that contains the zone polygon.
- modifiedDate: string
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"modifiedDate": "string"
}
ZoneListResponse: object
A list of zone items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ZoneListItem
-
ZoneListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"modifiedDate": "string"
}
]
}
ZoneResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- name: string | null
-
A unique name for this zone
- group: IdName | null
-
The zone group to which this zone belongs
- costCentre: IdName | null
-
The cost centre to which this zone belongs
- state: string | null inactive, active, deleted
-
The state of this zone
- zoneType: string | null location, keepin, nogo, route
-
The type of zone
- speed: number | null (double)
-
A speed limit (in km/h) to apply to this zone. Any asset that enters this zone will have the road speed limit overriden by the zone speed limit.
- radius: number | null (double)
-
For zone proximity alerts, specifiy a distance in km from the center of the zone.
- points: ZonePoint | null
-
The points for the zone polygon/polyline. Only populated on
get*routes. -
ZonePoint - tag: string | null
-
The tag entity
- center: ZoneCenter | null
-
The center of the zone (this is automatically calculated from the zone polygon.
- bounds: ZoneBounds | null
-
The rectangular bounds that contains the zone polygon.
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"center": {
"x": "number (double)",
"y": "number (double)"
},
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
ZoneUpdateRequest: object
- name: string | null
-
A unique name for this zone
- group: IdName | null
-
The zone group to which this zone belongs
- costCentre: IdName | null
-
The cost centre to which this zone belongs
- state: string | null inactive, active, deleted
-
The state of this zone
- zoneType: string | null location, keepin, nogo, route
-
The type of zone
- speed: number | null (double)
-
A speed limit (in km/h) to apply to this zone. Any asset that enters this zone will have the road speed limit overriden by the zone speed limit.
- radius: number | null (double)
-
For zone proximity alerts, specifiy a distance in km from the center of the zone.
- points: ZonePoint | null
-
The points for the zone polygon/polyline. Only populated on
get*routes. -
ZonePoint - tag: string | null
-
The tag entity
Example
{
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string"
}
ZoneCreateRequest: object
- name: string
-
A unique name for this entity
- group: IdName | null
-
The zone group to which this zone belongs
- costCentre: IdName | null
-
The cost centre to which this zone belongs
- state: string | null inactive, active, deleted
-
The state of this zone
- zoneType: string | null location, keepin, nogo, route
-
The type of zone
- speed: number | null (double)
-
A speed limit (in km/h) to apply to this zone. Any asset that enters this zone will have the road speed limit overriden by the zone speed limit.
- radius: number | null (double)
-
For zone proximity alerts, specifiy a distance in km from the center of the zone.
- points: ZonePoint | null
-
The points for the zone polygon/polyline. Only populated on
get*routes. -
ZonePoint - tag: string | null
-
The tag entity
- ownerId: string
-
The client that owns this entity
Example
{
"name": "string",
"group": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"costCentre": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"zoneType": "string",
"speed": "number (double)",
"radius": "number (double)",
"points": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"tag": "string",
"ownerId": "string"
}
MediaInfoResponse: object
Information about a media item
- id: string
-
The internal ID of the media item
- owner: IdName
-
The company that owns this media item
- asset: IdName
-
The asset that generated this media item
- requester: IdNameType
-
The entity that requested this media item
- mimeType: string
-
The MIME type of this media
- filename: string
-
The filename of the media item
- input: string
-
The camera input from which this media was recorded
- date: string
-
The ISO date at which this media was started
- duration: number (double)
-
The duration of the media item
- status: string queued, pending, uploading, available, downloading, processing, ready, failed, unavailable, canceled, deleted
-
The status of the media item
- eventId: string
-
The UUID of an event that is linked to this media item
- eventClass: string
-
The class of the event that is linked to this media item
- eventType: string
-
The type of the event that is linked to this media item
- lat: number (double)
-
The latitude where this event was triggered
- lon: number (double)
-
The longitude where this event was triggered
- address: string
-
The geocoded address of where this event was triggered
- fields: object
-
a list of custom field values attached to this event
- provider: string
-
The name of the device provider that handled this media item
- progress: number (double)
-
The progress of media retrieval (not all devices support this property)
- entity: EntityInfo
-
Information about when this media item was created and last updated
- data: object | null
-
Device specific information about this media item
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
MediaInfoListResponse: object
A list of media items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: MediaInfoResponse
-
A list of media items
-
MediaInfoResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"asset": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"requester": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"mimeType": "string",
"filename": "string",
"input": "string",
"date": "string",
"duration": "number (double)",
"status": "string",
"eventId": "string",
"eventClass": "string",
"eventType": "string",
"lat": "number (double)",
"lon": "number (double)",
"address": "string",
"fields": "object",
"provider": "string",
"progress": "number (double)",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
},
"data": "object"
}
]
}
VideoLiveStreamResponse: object
- id: string
-
A unique ID for this live stream
- status: string
-
The status of the request
- endpoints: string[]
-
The endpoints for the live stream if successful
-
string
Example
{
"id": "string",
"status": "string",
"endpoints": [
"string"
]
}
VideoLiveStreamRequest: object
- duration: number (double)
-
The duration in seconds of the video to retrieve
- input: string
-
The camera input for which to start a live stream
- record: boolean
-
Set to true to record the live stream so that it is available later
Example
{
"duration": "number (double)",
"input": "string",
"record": "boolean"
}
MediaVideoEventCreateRequest: object
Setting for creating a new video event
- duration: number (double)
-
The duration in seconds of the video to retrieve
- offset: number (double)
-
The number of seconds from the given date to begin recording (can be negative)
- inputs: string[]
-
The camera inputs from which to retrieve videos
-
string - assetId: string
-
the UUID of the asset for which to create this event
- date: string
-
The date on which to create this event. This should correspond to an actual telemetry point for the asset.
Example
{
"duration": "number (double)",
"offset": "number (double)",
"inputs": [
"string"
],
"assetId": "string",
"date": "string"
}
MediaVideoEventUpdateRequest: object
Setting for retreiving a video on an existing event
- duration: number (double)
-
The duration in seconds of the video to retrieve
- offset: number (double)
-
The number of seconds from the given date to begin recording (can be negative)
- inputs: string[]
-
The camera inputs from which to retrieve videos
-
string
Example
{
"duration": "number (double)",
"offset": "number (double)",
"inputs": [
"string"
]
}
TestNotificationsRequest: object
- ownerId: string | null
-
The id of the company from which to send the test notification
- notificationChannels: string[] | null
-
A list of notification channels to test
-
string email, sms - siteUrl: string
-
The url of the client application
Example
{
"ownerId": "string",
"notificationChannels": [
"string"
],
"siteUrl": "string"
}
AnalyticsBaseReportDashboard: object
- owner: IdNameType
- id: string
- name: string
Example
{
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"id": "string",
"name": "string"
}
AnalyticsBaseReportResponse: object
- id: string
- name: string
- title: string
- owner: IdNameType
- user: IdName
- origin: IdNameType
- client: IdName
- taskId: number (double)
- date: string
- completionDate: string
- status: string queued, running, completed, aborted, failed, retry
- progress: number (double)
- completedTasks: number (double)
- totalTasks: number (double)
- firstPassComplete: boolean
- priority: number (double)
- mode: string single, repeat
- maxRunning: number (double)
- runEndDate: string
- lastCompletedDate: string
- dashboards: AnalyticsBaseReportDashboard | null
-
AnalyticsBaseReportDashboard
Example
{
"id": "string",
"name": "string",
"title": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"taskId": "number (double)",
"date": "string",
"completionDate": "string",
"status": "string",
"progress": "number (double)",
"completedTasks": "number (double)",
"totalTasks": "number (double)",
"firstPassComplete": "boolean",
"priority": "number (double)",
"mode": "string",
"maxRunning": "number (double)",
"runEndDate": "string",
"lastCompletedDate": "string",
"dashboards": [
{
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"id": "string",
"name": "string"
}
]
}
AnalyticsBaseReportsListResponse: object
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: AnalyticsBaseReportResponse
-
AnalyticsBaseReportResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"title": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"origin": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"taskId": "number (double)",
"date": "string",
"completionDate": "string",
"status": "string",
"progress": "number (double)",
"completedTasks": "number (double)",
"totalTasks": "number (double)",
"firstPassComplete": "boolean",
"priority": "number (double)",
"mode": "string",
"maxRunning": "number (double)",
"runEndDate": "string",
"lastCompletedDate": "string",
"dashboards": [
{
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"id": "string",
"name": "string"
}
]
}
]
}
ReportOutputOptions: object
- charts: AnalyticsOutputSettings | null
-
AnalyticsOutputSettings - table: TableOptions | null
Example
{
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
},
"stat": {
"data": "string",
"key": "string"
}
}
]
}
CompletedReportResponse: object
- id: string
-
The unique ID of this report definition
- owner: IdNameType
-
The entity that owns this report
- user: IdName
-
The user that queued this report definition
- client: IdName
-
The client for which the report was run
- name: string
-
The base report name
- title: string
-
The report title as set by the user
- source: string dataset, analytics
-
The reporting subsystem that generates this report
- status: string queued, running, completed, aborted, failed, retry
-
The status of this report
- queueDate: string
-
The ISO date/time that this report was queued
- updateDate: string
-
The ISO date/time that this report's state last changed
- outputFormat: string pdf, xlsx, xml, csv, raw, json, raw_compact, source
-
The output format for this report
- progress: number (double)
-
The progress percentage of this report
- order: number (double)
-
report queue order, will change sometimes while queued
- priority: number (double)
-
The report priority: 0 = urgent, 1 = high, 2 = normal, 3 = low, 4+ = none (sorted as an integer)
- config: ReportConfig
-
The report configuration
- triggeredBy: string user, schedule, dashboard
-
What triggered the report
- baseReportId: string | null
-
The UUID of a base report in analytics (if any) this report is linked to
- outputOptions: ReportOutputOptions | null
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string"
}
}
]
}
}
CompletedReportListResponse: object
A list of map set items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: CompletedReportResponse
-
CompletedReportResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string",
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string"
}
]
}
}
]
}
}
]
}
CompletedReportUpdateRequest: object
- outputOptions: ReportOutputOptions
Example
{
"outputOptions": {
"charts": [
{
"name": "string",
"description": "string",
"dateRange": "string",
"row": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"group": {
"dim": "string",
"level": "number (double)",
"filter": [
"string"
],
"levels": {
"name": "string",
"headings": [
"string"
]
}
},
"flipped": "boolean",
"measures": [
{
"key": "string",
"value": "string",
"format": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"table": {
"measures": [
{
"key": "string",
"value": "string",
"generic": "boolean",
"validFrom": "string",
"validTo": "string"
}
],
"layout": "string"
},
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"graph": {
"yAxis": {
"left": {
"max": "string",
"min": "string"
},
"right": {
"max": "string",
"min": "string"
}
},
"xAxis": {
"labels": {
"layout": "string"
}
},
"stacked": "boolean",
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean"
},
"pie": {
"label": {
"visible": "boolean",
"placement": "string",
"position": "string",
"overlay": "boolean"
},
"series": {},
"dataLabels": "boolean",
"data": "string",
"fill": "boolean"
},
"stat": {}
}
]
}
}
AnalyticsOutputRequest: object
- rowLevel: number (double)
- groupLevel: number (double)
- time: string
- flipped: boolean
- measures: string[]
-
string - sort: AnalyticsSortOptions
- row: string | null time, asset, costCentre, zoneCostCentre, assetGroup, zoneGroup, device, ioType, alert, event, assetState, assetCategory0, assetCategory1, assetCategory2, assetCategory3, assetCategory4, overspeed, shift, company, geography, deviceType
- group: string | null time, asset, costCentre, zoneCostCentre, assetGroup, zoneGroup, device, ioType, alert, event, assetState, assetCategory0, assetCategory1, assetCategory2, assetCategory3, assetCategory4, overspeed, shift, company, geography, deviceType
- filters: AnalyticsOutputFilters | null
Example
{
"rowLevel": "number (double)",
"groupLevel": "number (double)",
"time": "string",
"flipped": "boolean",
"measures": [
"string"
],
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"row": "string",
"group": "string",
"filters": {
"group": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
},
"row": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
}
}
}
CompletedReportDataRequest: object
- outputOptions: AnalyticsOutputRequest | null
Example
{
"outputOptions": {
"rowLevel": "number (double)",
"groupLevel": "number (double)",
"time": "string",
"flipped": "boolean",
"measures": [
"string"
],
"sort": {
"type": "string",
"direction": "string",
"limit": "number (double)",
"measureKey": "string"
},
"row": "string",
"group": "string",
"filters": {
"group": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
},
"row": {
"mode": "string",
"items": [
"string"
],
"range": {
"level": "string",
"start": "string",
"end": "string"
}
}
}
}
}
AnalyticsSettingsRequest: object
- row: string time, asset, costCentre, zoneCostCentre, assetGroup, zoneGroup, device, ioType, alert, event, assetState, assetCategory0, assetCategory1, assetCategory2, assetCategory3, assetCategory4, overspeed, shift, company, geography, deviceType
- group: string time, asset, costCentre, zoneCostCentre, assetGroup, zoneGroup, device, ioType, alert, event, assetState, assetCategory0, assetCategory1, assetCategory2, assetCategory3, assetCategory4, overspeed, shift, company, geography, deviceType
Example
{
"row": "string",
"group": "string"
}
CompletedReportRequest: object
- outputOptions: AnalyticsSettingsRequest | null
Example
{
"outputOptions": {
"row": "string",
"group": "string"
}
}
QueuedReportResponse: object
- id: string
-
The unique ID of this report definition
- owner: IdNameType
-
The entity that owns this report
- user: IdName
-
The user that queued this report definition
- client: IdName
-
The client for which the report was run
- name: string
-
The base report name
- title: string
-
The report title as set by the user
- source: string dataset, analytics
-
The reporting subsystem that generates this report
- status: string queued, running, completed, aborted, failed, retry
-
The status of this report
- queueDate: string
-
The ISO date/time that this report was queued
- updateDate: string
-
The ISO date/time that this report's state last changed
- outputFormat: string pdf, xlsx, xml, csv, raw, json, raw_compact, source
-
The output format for this report
- progress: number (double)
-
The progress percentage of this report
- order: number (double)
-
report queue order, will change sometimes while queued
- priority: number (double)
-
The report priority: 0 = urgent, 1 = high, 2 = normal, 3 = low, 4+ = none (sorted as an integer)
- config: ReportConfig
-
The report configuration
- triggeredBy: string user, schedule, dashboard
-
What triggered the report
- baseReportId: string | null
-
The UUID of a base report in analytics (if any) this report is linked to
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
QueuedReportListResponse: object
A list of map set items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: QueuedReportResponse
-
QueuedReportResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"client": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"name": "string",
"title": "string",
"source": "string",
"status": "string",
"queueDate": "string",
"updateDate": "string",
"outputFormat": "string",
"progress": "number (double)",
"order": "number (double)",
"priority": "number (double)",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
},
"triggeredBy": "string",
"baseReportId": "string"
}
]
}
QueueReportRequest: object
- clientId: string
- source: string dataset, analytics
- serverId: string | null
- name: string
- title: string
- outputFormat: string pdf, xlsx, xml, csv, raw, json, raw_compact, source
- config: ReportConfig
Example
{
"clientId": "string",
"source": "string",
"serverId": "string",
"name": "string",
"title": "string",
"outputFormat": "string",
"config": {
"language": "string",
"definitionId": "string",
"styleId": "string",
"parameters": "object"
}
}
DimensionFilterItem: object
- name: string
- children: DimensionFilter
Example
{
"name": "string",
"children": {}
}
CellSetFilters: object
- row: DimensionFilter
- group: DimensionFilter
Example
{
"row": {},
"group": {}
}
CellSetAverage: object
- value: string[]
-
string - raw: number[]
-
number (double)
Example
{
"value": [
"string"
],
"raw": [
"number (double)"
]
}
ColumnFormatting: object
- align: string
- width: number (double)
Example
{
"align": "string",
"width": "number (double)"
}
CellProperties: object
- raw: object | null
- format: ColumnFormatting | null
- doNotShowOnChart: boolean | null
- type: string average, max, min, total, data
- seriesKey: string | null
- uniquename: string | null
- dimension: string | null
- level: string | null
Example
{
"raw": "object",
"format": {
"align": "string",
"width": "number (double)"
},
"doNotShowOnChart": "boolean",
"type": "string",
"seriesKey": "string",
"uniquename": "string",
"dimension": "string",
"level": "string"
}
CellValue: object
- value: object
- type: string DATA_CELL, ROW_HEADER, ROW_HEADER_HEADER, COLUMN_HEADER, COLUMN_HEADER_HEADER
- properties: CellProperties
Example
{
"value": "object",
"type": "string",
"properties": {
"raw": "object",
"format": {
"align": "string",
"width": "number (double)"
},
"doNotShowOnChart": "boolean",
"type": "string",
"seriesKey": "string",
"uniquename": "string",
"dimension": "string",
"level": "string"
}
}
CellSet: object
- rowLevels: number (double)
- filters: CellSetFilters
- average: CellSetAverage | null
- cellset: object[][]
-
CellValue - status: string error, running, generating, completed
Example
{
"rowLevels": "number (double)",
"filters": {
"row": {},
"group": {}
},
"average": {
"value": [
"string"
],
"raw": [
"number (double)"
]
},
"cellset": [
[
{
"value": "object",
"type": "string",
"properties": {
"raw": "object",
"format": {
"align": "string",
"width": "number (double)"
},
"doNotShowOnChart": "boolean",
"type": "string",
"seriesKey": "string",
"uniquename": "string",
"dimension": "string",
"level": "string"
}
}
]
],
"status": "string"
}
CellSetResponse: object
- cellset: CellSet
Example
{
"cellset": {
"rowLevels": "number (double)",
"filters": {
"row": {},
"group": {}
},
"average": {
"value": [
"string"
],
"raw": [
"number (double)"
]
},
"cellset": [
[
{
"value": "object",
"type": "string",
"properties": {
"raw": "object",
"format": {
"align": "string",
"width": "number (double)"
},
"doNotShowOnChart": "boolean",
"type": "string",
"seriesKey": "string",
"uniquename": "string",
"dimension": "string",
"level": "string"
}
}
]
],
"status": "string"
}
}
StatsEntityOutputOptions: object
- groupLevel: string all, type, name, company, user, distributor, vendor, client
- rowLevel: string all, year, month, day, hour
- time: string
- flip: boolean
Example
{
"groupLevel": "string",
"rowLevel": "string",
"time": "string",
"flip": "boolean"
}
EntitySearchResult: object
An entity search result item
- id: string
-
The UUID of the entity
- name: string
-
The name value of the entity
- type: string
-
The type of the entitity
- owner: IdNameType
-
The company that owns the entity
- state: string
-
The state of the entity
- fields: string
-
Any custom field values assigned to the entity
- tags: string
-
Any custom tags assigned to the entity
Example
{
"id": "string",
"name": "string",
"type": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"fields": "string",
"tags": "string"
}
EntitySearchResponse: object
A list of search results
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: EntitySearchResult
-
EntitySearchResult
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"name": "string",
"type": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"state": "string",
"fields": "string",
"tags": "string"
}
]
}
HealthIssueDates: object
Health issue date information
- created: string
-
The date that the issue was first experienced
- updated: string
-
The date that the issue was last experienced
Example
{
"created": "string",
"updated": "string"
}
HealthIssueResolutionDetail: object
Detail to describe the health issue's resolution
- message: string | null
-
A message to describe what was done to fix the issue
- timestamp: string
-
The timestamp when the issue was resolved
- user: IdNameType
-
The user who resolved the issue
Example
{
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
HealthIssueResponse: object
Health issue
- id: string
-
A unique GUID for the issue
- owner: IdNameType
-
The company that owns this issue
- target: IdNameType
-
The target entity to which the issue relates
- topic: string
-
A name given to the issue
- source: IdNameType
-
The source entity from which the issue originates
- date: HealthIssueDates
-
Date information
- count: number (double)
-
A number of times the issue has been experienced since it was first experienced
- resolved: HealthIssueResolutionDetail | null
-
The flag indicating the issue has been corrected or not
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"topic": "string",
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": {
"created": "string",
"updated": "string"
},
"count": "number (double)",
"resolved": {
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
}
HealthIssueListResponse: object
A list of health issue items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: HealthIssueResponse
-
The list of issue items in this response
-
HealthIssueResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"target": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"topic": "string",
"source": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"date": {
"created": "string",
"updated": "string"
},
"count": "number (double)",
"resolved": {
"message": "string",
"timestamp": "string",
"user": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
}
}
]
}
HealthIssueUpdateRequest: object
The model to send when resolving a health issue
- resolved: object | null
-
- message: string
Example
{
"resolved": {
"message": "string"
}
}
TaskOptions: object
A number of task execution options
- retries: number (double)
-
The number of retries that should be attempted if this task fails
- delay: number (double)
-
The number of minutes to wait after failure before trying again
- timeout: number (double)
-
Any task in the executing state for more than
timeoutminutes will be automatically failed.
Example
{
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
}
TaskDates: object
Task date information
- created: string
-
The date that the task was created
- updated: string
-
The date that the task was last updated
- completed: string | null
-
The date at which the task was completed
Example
{
"created": "string",
"updated": "string",
"completed": "string"
}
TaskResponse: object
- id: string
-
A unique GUID for the task
- owner: IdNameType
-
The company that owns this task
- user: IdName | null
-
The user that created this task (optional)
- linked: IdNameType
-
A number of entities that are linked to this task
-
IdNameType - options: TaskOptions
-
A number of task execution options
- state: string pending, executing, waiting, success, canceling, canceled, failed, timedout, deferred
-
The state of the task
- date: TaskDates
-
Date information
- type: string
-
The type of the task
- data: Dictionary
-
A number of task specific options
- results: Dictionary | null
-
A number of task specific results
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
TaskListResponse: object
A list of task items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: TaskResponse
-
The list of task items in this response
-
TaskResponse
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"user": {
"id": "string",
"name": "string",
"err": {
"name": "string",
"message": "string"
}
},
"linked": [
{
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
}
],
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"state": "string",
"date": {
"created": "string",
"updated": "string",
"completed": "string"
},
"type": "string",
"data": {},
"results": {}
}
]
}
TaskCreateRequest: object
- ownerId: string
- type: string
-
The type of the task
- options: TaskOptions
-
A number of task execution options
- data: Dictionary
-
A number of task specific options
Example
{
"ownerId": "string",
"type": "string",
"options": {
"retries": "number (double)",
"delay": "number (double)",
"timeout": "number (double)"
},
"data": {}
}
GeocoderBounds: object
- top: number (double)
- left: number (double)
- bottom: number (double)
- right: number (double)
Example
{
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
}
GeocoderAddress: object
- country: string | null
- province: string | null
- town: string | null
- suburb: string | null
- road: string | null
- postcode: string | null
Example
{
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
}
ForwardGeocodeResult: object
A forward geocode search result item
- type: string location, keepin, nogo, route, address
- id: string | null
- text: string
- lon: number (double)
- lat: number (double)
- bounds: GeocoderBounds | null
- address: GeocoderAddress | null
Example
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
}
}
ForwardGeocodeResponse: object
A list of search results
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ForwardGeocodeResult
-
ForwardGeocodeResult
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
}
}
]
}
ReverseGeocodeResult: object
A reverse geocode search result item
- type: string location, keepin, nogo, route, address
- id: string | null
- text: string
- lon: number (double)
- lat: number (double)
- bounds: GeocoderBounds | null
- address: GeocoderAddress | null
- geometry: ZonePoint | null
-
ZonePoint - speed: number | null (double)
-
speed limit in km/h
Example
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
},
"geometry": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"speed": "number (double)"
}
ReverseGeocodeResponse: object
A list of search results
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: ReverseGeocodeResult
-
ReverseGeocodeResult
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"type": "string",
"id": "string",
"text": "string",
"lon": "number (double)",
"lat": "number (double)",
"bounds": {
"top": "number (double)",
"left": "number (double)",
"bottom": "number (double)",
"right": "number (double)"
},
"address": {
"country": "string",
"province": "string",
"town": "string",
"suburb": "string",
"road": "string",
"postcode": "string"
},
"geometry": [
{
"x": "number (double)",
"y": "number (double)"
}
],
"speed": "number (double)"
}
]
}
GeoJson: object
A GeoJSON structure
- type: string
-
The type of GeoJSON geometry
- coordinates: number[][]
-
The coordinates of the geometry
-
number[] number (double)
Example
{
"type": "string",
"coordinates": [
[
"number (double)"
]
]
}
MapRouteSegment: object
A route segment
- distance: number (double)
-
The total distance of the segment, in kilometers
- time: number (double)
-
The total travel time of the segment, in seconds
- geom: GeoJson
-
The GeoJSON structure that describes the geometry of the section
Example
{
"distance": "number (double)",
"time": "number (double)",
"geom": {
"type": "string",
"coordinates": [
[
"number (double)"
]
]
}
}
MapRoute: object
A complete route result
- strategy: string fastest, shortest
-
The strategy that was used to calculate the route
- segments: MapRouteSegment
-
One or more segments in the route
-
MapRouteSegment
Example
{
"strategy": "string",
"segments": [
{
"distance": "number (double)",
"time": "number (double)",
"geom": {
"type": "string",
"coordinates": [
[
"number (double)"
]
]
}
}
]
}
MapRouteResponse: object
A list of routing results
Example
{
"routes": [
{
"strategy": "string",
"segments": [
{
"distance": "number (double)",
"time": "number (double)",
"geom": {
"type": "string",
"coordinates": [
[
"number (double)"
]
]
}
}
]
}
]
}
SslCertificateListItem: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- company: IdNameType | null
-
The company for which the ssl certificate was created
- domain: string | null
-
The domain of the ssl certificate
- state: string | null inactive, active, deleted
-
The state of the ssl certificate
- modifiedDate: string
-
The date the entity was last modified
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"state": "string",
"modifiedDate": "string"
}
SslCertificateListResponse: object
A list of ssl certificate items
- count: number (double)
-
total number of records in the result set
- offset: number (double)
-
the offset into the result set
- limit: number (double)
-
the max number of items returned in the result set
- items: SslCertificateListItem
-
SslCertificateListItem
Example
{
"count": "number (double)",
"offset": "number (double)",
"limit": "number (double)",
"items": [
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"state": "string",
"modifiedDate": "string"
}
]
}
SslCertificateResponse: object
- id: string
-
The unique UUID of this entity
- owner: IdNameType
-
The company entity that owns this entity
- company: IdNameType | null
-
The company for which the ssl certificate was created
- domain: string | null
-
The domain of the ssl certificate
- notes: string | null
-
A field for capturing notes about the ssl certificate
- state: string | null inactive, active, deleted
-
The state of the ssl certificate
- entity: EntityInfo
-
entity specific metadata
Example
{
"id": "string",
"owner": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"entity": {
"creationDate": "string",
"modifiedDate": "string"
}
}
SslCertificateCreateRequest: object
- company: IdNameType | null
-
The company for which the ssl certificate was created
- domain: string | null
-
The domain of the ssl certificate
- notes: string | null
-
A field for capturing notes about the ssl certificate
- state: string | null inactive, active, deleted
-
The state of the ssl certificate
- ownerId: string
-
The company that owns this ssl certificate
Example
{
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string",
"ownerId": "string"
}
SslCertificateUpdateRequest: object
- company: IdNameType | null
-
The company for which the ssl certificate was created
- domain: string | null
-
The domain of the ssl certificate
- notes: string | null
-
A field for capturing notes about the ssl certificate
- state: string | null inactive, active, deleted
-
The state of the ssl certificate
Example
{
"company": {
"id": "string",
"name": "string",
"type": "string",
"err": {
"name": "string",
"message": "string"
}
},
"domain": "string",
"notes": "string",
"state": "string"
}
SslCertificateValidationResponse: object
- provisioned: boolean
- verified: boolean
- domain: string
- valid: boolean
- errors: string[]
-
string
Example
{
"provisioned": "boolean",
"verified": "boolean",
"domain": "string",
"valid": "boolean",
"errors": [
"string"
]
}
SslCertificateProvisionResponse: object
- domain: string
- success: boolean
- errors: string[] | null
-
string
Example
{
"domain": "string",
"success": "boolean",
"errors": [
"string"
]
}