API docs by Redocly

Corvex RESTFul API (2.33)

Download OpenAPI specification:

License: Proprietary

Operations used by clients to interact with the Corvex Connected Worker platform.

Change History

Version

Date

Change Summary

2.33

08/07/2025

 Added support for properties and subject of checks and questions.

2.32

02/06/2025

 Added support for observationEvents on assets.

2.31

12/02/2024

 Added support for document review lifecycles.

2.30

08/29/2024

 Added manualInput to property definition and operations.

2.29

04/11/2024

 Added support for Relays.

2.28

12/26/2023

 Added support for properties to observations.

2.27

11/9/2023

 Added support for disclaimers.

2.26

9/5/2023

 Converted to OpenAPI format

2.25

7/14/2023

Added objectUUID to addMessage

2.24

6/21/2023

Added documentation about required access permissions.

2.23

6/6/2023

Added NoAccess error response code.

2.20

9/25/2022

Added presentationStyle property to deployments and responses.

2.19

8/2/2022

Added password policy operations.

2.18

5/17/2022

Added documentation about how updatePassword works with the reset parameter.  Added getSecurityQuestion command.

2.17

5/4/2022

Added data pools

2.16

1/26/2022

Added filterID and status information to collections to support automatically scanning for new items that match collection criteria.

2.15

1/19/2022

Added isAnonymous options to addObservation and uploadObject.

Added anonymous handling for deployments and responses.

2.14

1/10/2022

Added hireDate, terminationDate, and active support to users.  Added bulk update to updateUser

2.13

12/31/2021

Added nodeSelections parameter to many commands to support Location Hierarchy feature

2.12

12/22/2021

Added ability to bulk add users and assets.

2.11

12/21/2021

Added documentation about translations for objects of type content.

2.10

12/2/2021

Added information about Folder commands. Also added information about the use of folderIDs in locations lists for add and updateUser.

2.9

11/19/2021

Added Watcher commands.

2.8

10/26/2021

Added allowNA property for questions.

2.7

9/24/2021

Added incremental parameters to getAvailableResponses and getObservations

2.6

8/23/2021

Added readOnly attribute for reports.

2.5

8/6/2021

Added getWorkerEvents; added severity and likelihood Closed properties to observations

2.4

4/20/2021

Added updatePPEStatus command

2.3

1/29/2021

Added contentItems property to various methods

2.2

1/21/2021

Added bulk operations to skipResponse and updateResponseAssignment

2.1

12/23/2020

Added closingCategory and closingTags to Question object structure and corresponding commands.

2.0

10/27/2020

Added onDemand frequency support.
Added isPublic flag for objects.

1.49

10/7/2020

Added Wristband operations. Cleaned up some documentation.

1.48

7/17/2020

Added target management functions (for ‘CoreTargets’).

1.47

5/11/2020

Added check management commands in new section ‘Checks’

1.45

5/4/2020

Added documentation about getZoneData command

Added asset management commands

1.43

4/5/2020

Added a workers property to the update call.

1.42

3/23/2020

Added a permissions property to reports.

1.41

2/13/2020

Added options for calculateScores to allow filtering for leaderboards.

1.40

1/22/2020

Added getObjectList and deleteObject operations.

1.39

1/21/2020

Added commands to manage loyalty program tiers.

1.38

01/10/2020

Added support for objectUUIDs and observationUUIDs to assist in connecting objects and observations that are sent asynchronously.

1.37

12/12/2019

Added a calculatePoints option to getUserInfo

1.36

11/10/2019

Added messages parameter to setMessageStatus

1.35

10/10/2019

Added shift properties to various interfaces.

1.34

10/2/2019

Added active property to message templates.

1.33

9/14/2019

Added itemCount and lastItem parameters to getObservations and getMessages.

1.32

9/11/2019

Added locations property to various objects that need to be filtered by location.

1.31

9/10/2019

Added properties to the location object

1.30

9/7/2019

Added a replaces parameter to the uploadObject operation.

1.29

9/4/2019

Added information about language preferences.

1.28

8/26/2019

Added support for impact property on observations.  Added support for tag management and tags in observations. Added section 2.3 describing how the various property types should manifest when talking to the backend.

1.27

8/21/2019

Added ability to identify a users primary group.  Include group data in authenticate response.

1.26

7/23/2019

Added documentation about additional authenticate message parameters and responses.

1.25

7/18/2019

Added a source property to messages (notifications) so that it can be properly routed by the recipient

1.24

7/1/2019

Added preferences property to subscriberInfo

1.23

6/23019

Documented the safety message operations.

1.22

6/10/2019

Added documentation about the value property of observations on add, get, and updateObservations.

1.21

6/3/2019

Added subtype documentation for quality observations.  Added state of ‘dropped’ - used by quality observations when they are marked as ‘scrapped’ by the worker.  

1.20

5/23/2019

Added startTime and endTime to getPluginEvents

1.19

4/5/2019

Added plugin operations.

1.18

3/21/2019

Added the directURL return value to the initialize and subscriberInfo packets.

1.17

2/26/2019

Added updateSubscriberInfo interface

1.16

2/14/2019

Added passcode as an authentication mechanism

1.15

2/12/2019

Added a features object to the subscriber information object.

1.14

1/29/2019

Added documentation about the new observation property returned by the authenticate, getUsers, and getUserInfo methods.

1.13

12/2/2018

Added documentation for new report methods.

1.12

9/14/2018

Documented change in refreshCache response from update and heartbeat commands.

1.11

9/5/2018

Added getSubscriberInfo documentation.

1.10

7/31/2018

Added isGrouped to gear.

1.9

7/27/2018

Added getNearbyLocations command.

1.8

7/12/2018

Added imageID fields for gear

1.7

6/28/2018

Added type and subtype to uploadObject method

1.6

4/6/2018

Added threshold to beacons

1.5

3/31/2018

Added descriptions for Rules

1.4

3/20/2018

Added nextMessageID to returned information about messages.

1.3

3/9/2018

Added various Notification Rule operations.

1.2

3/7/2018

Added workorder field and workorder state to observation data.

1.1

2/19/2018

Added groupID to observation data.

1.0

2/8/2018

updateObservation can take a zoneID.   Changed version to 1.0 as we are now stable.

0.5

9/29/2017

Finished spec’ing out the Observation interfaces and uploadObject

0.4

9/15/2017

Added addGearType, deleteGearType, getGearTypes, updateGearType, and getActiveUsers

0.3

9/15/2017

Added batteryPct to some messages

0.2

7/25/2017

Added section on Observation Messages

0.1

7/24/2017

Initial version

Introduction

Corvex Core devices and the Webapp are constantly communicating with the Gateway and the backend. This specification documents the rich API that allows for this communication.

Requests

The message structure relies upon JSON for representing complex data structures. JSON messages are encapsulated in HTTP requests to a known endpoint on the target. Most requests include a session token to ensure authorization. The pattern for the endpoint is https://CUSTOMER_DOMAIN/api/v2/CMD/arguments. For example:

# curl https://acme.corvexconnected.com/api/v2/authenticate/username=XYZ&password=123

Note that in most cases requests can be sent using 'GET' or 'POST', so the above request could also have been sent as:

# curl -d username=XYZ -d password=123 https://acme.corvexconnected.com/api/v2/authenticate

Also note that while the subscriberID parameter is required for all operations, it is automatically injected when using the RESTful request formats above.

Responses

Responses always include the following properties:

  • status - The status after processing the request. Possible values are:
    • OK - the operation was performed successfully.
    • NoAuth - the requestor was not authenticated.
    • NoAccess - the requestor was not authorized to perform the operation.
    • CACHEVALID - a get request included a lastRequest or lastHash parameter and the related data has not changed.
  • statusText - An extended description of the status.
  • timestamp - The server time when the operation was started in seconds since the epoch.
  • datahash - For some commands, the API will also return a SHA256 hash of the data being returned. In those cases, the APIs will also accept a lastHash parameter.

Authorization

Most operations rely upon role-based access control. These operations require authorization via the use of session tokens. Session tokens are generated in response to successful authentication and are ephemeral.

The following security contexts are referenced by the APIs.

admin

Session is active and has site admininstrator or higher access.

Security Scheme Type: API Key
Query parameter name: token

authorized

Session is active

Security Scheme Type: API Key
Query parameter name: token

global-admin

Session is active and has global administrator or higher access.

Security Scheme Type: API Key
Query parameter name: token

staff

Session is active and has Corvex staff access.

⚠ THIS IS A RESTRICTED ACCESS LEVEL.
Security Scheme Type: API Key
Query parameter name: token

supervisor

Session is active and has supervisor or higher access.

Security Scheme Type: API Key
Query parameter name: token

Startup

Startup operations happen before anything else. Use these operations to discover the appropriate endpoint for a specific subscriber, and to retrieve information about that subscriber's settings to customize the experience in a client.

Get basic subscriber settings

Note that either the prefix or subscriber parameters must be supplied

query Parameters
subscriber
integer (subscriberID) >= 0

Subscriber ID to check

prefix
string

Subscriber Organization Name to check

brand
string
Enum: "corvex" "hop" "inteliforz"

Subscriber brand to check

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "recordcount": 1,
  • "subscribers": [
    ]
}

Discover subscriber configuration

Pull in the detailed configuration of a subscriber or a subscriber location.

Authorizations:
authorized
query Parameters
gwLocations
Array of integers (schemas-locationList) [ items >= 0 ]

A list of locationIDs supported by a gateway

subscriberID
integer (subscriberID) >= 0

Subscriber ID to use

deviceID
string (deviceID)

Unique Mobile Device ID

fromGateway
integer [ 0 .. 1 ]

Request came from a gateway - defaults to 0 (false)

location
required
integer (schemas-locationID) >= 0

Location ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

version
string

App Version ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "target": "string",
  • "config": {
    }
}

Session

Active session operations

Authenticate and start a session

query Parameters
username
string

The user's account ID - only required when nfcID or authToken are not supplied.

password
string

The user's password - only required when nfcID or authToken are not supplied.

authToken
string

An SSO token issued by Auth0

nfcID
string

A value from an Corvex ID tag used to authenticate (from native clients)

gwlocations
Array of integers

A list of locationIDs supported by a gateway - only used when the request is sent via a gateway

pushToken
string

A token supplied by OneSignal to deliver push notifications (native only)

deviceModel
string

The model of the client device (from native clients)

deviceType
string

The type of the client device (from native clients)

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

version
string

App Version ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "csrfToken": "string",
  • "token": "string",
  • "pushToken": "string",
  • "certifications": [
    ],
  • "fullname": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "locationID": 0,
  • "subscriberID": 0,
  • "subscriberName": "string",
  • "supervisorID": -2,
  • "avatarID": 0,
  • "securityQuestion": 0,
  • "lastLogin": 0,
  • "isFirstLogin": 1,
  • "lastWebVersion": "string",
  • "lastNativeVersion": "string",
  • "avatarPath": "string",
  • "permissions": { },
  • "preferences": { },
  • "gear": [
    ],
  • "roles": [
    ],
  • "primaryGroup": 0,
  • "groups": [
    ],
  • "locations": [
    ],
  • "teams": [
    ],
  • "consentDate": 9999999999,
  • "consentWithdrawnDate": 9999999999,
  • "type": "dedicated",
  • "userID": -2,
  • "key": "string",
  • "iv": "string",
  • "username": "string",
  • "observations": {
    }
}

Verify that a token is valid

query Parameters
readOnly
integer [ 0 .. 1 ]
Default: 0

Is the item readOnly (defaults to 0 - not readOnly).

token
required
string

The active session token

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "userID": -2,
  • "statusText": "string"
}

Gather all startup data.

Pulls all of the data related to a subscriber during application startup.

Authorizations:
authorized
query Parameters
core
integer

An optional boolean (0/1) that indicates if the request is from the mobile application. Defaults to 0 (not from the mobile application).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Identify nearby subscriber locations

If the native application connects directly to the backend, this command uses the GPS coordinates to attempt to find a nearby subscriber location.

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

deviceID
string (deviceID)

Unique Mobile Device ID

location
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "locations": [
    ]
}

Get security question

Find the security question the user chose for password resets.

query Parameters
username
required
string

The username associated with the account

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Check the status of a subscriber

query Parameters
prefix
string

The organization identifier

subscriber
integer

The organization subscriberID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "subscribers": [
    ]
}

Get the user's account data

Authorizations:
authorized
query Parameters
calculatePoints
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

includeShared
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

noCache
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "users": [
    ]
}

Get the current native app version

query Parameters
subscriberID
required
integer (subscriberID) >= 0

The ID of the subscriber being checked. If this parameter is not supplied, and if it is set locally, the dispatcher will automatically add it to any query.

deviceID
string (deviceID)

Unique Mobile Device ID

token
string

An optional session authentication token. If this is supplied and the deviceOS parameter is NOT supplied, the system will attempt to use data in the session table to determine the OS of the client

deviceModel
string

The model of the client device (from native clients)

deviceOS
string
Enum: "ios" "android" "core"

The operating system of the client device (from native clients)

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "VERSION": "string",
  • "URL": "string"
}

Keep the session active

Authorizations:
authorized
query Parameters
batteryPct
integer [ 0 .. 100 ]

Battery charge percentage

btIssues
integer

Number of bluetooth failures detected

lastRefresh
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

tables
Array of strings

@@@ Needs a parameter description

deviceID
string (deviceID)

Unique Mobile Device ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Terminate an active session

Authorizations:
authorized
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Tell the backend which location the session is associated with

Authorizations:
authorized
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

PPE Operations

User PPE Operations

Deregister PPE

Authorizations:
authorized
query Parameters
beaconID
string

The ID of the associated beacon

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Register PPE

Authorizations:
authorized
query Parameters
beaconID
string

The ID of the associated beacon

comment
string

A comment associated with a manual override registration

gearType
string

The type of gear to register

nfcID
string

The nfcID associated with the PPE

temporary
integer

Is this a temporary registration

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update user compliance

Authorizations:
authorized
query Parameters
batteryPct
integer [ 0 .. 100 ]

Battery charge percentage

btIssues
integer

Number of bluetooth failures detected

gear
Array of strings

A list of gear automatically discovered as being worn

override
Array of integers

A list of gear the user has manually indicated they are wearing

zones
Array of strings

A list of nearby zone beacon IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

lastRefresh
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "compliance": "in",
  • "zoneID": 0,
  • "zoneName": "string",
  • "gear": { },
  • "certifications": { },
  • "refreshCache": [
    ]
}

Don / Doff PPE

Authorizations:
authorized
query Parameters
action
string
Enum: "ppeOn" "ppeOff"

The operation being performed

beaconID
string

The ID of the associated beacon

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Reports

“Reports” are collections of selectors that are used by the backend and web client to create reports.

Add a report definition

Authorizations:
supervisor
query Parameters
name
required
string

The name for the report. Note that the name must be unique within the folder (groupID)

description
string

Description of the item

groupID
integer

The ID of the folder in which the report is defined. Defaults to 0 (no folder).

type
string (reportType)
Enum: "observation" "obsDetail" "PPESummary" "worker" "check" "checkDetail" "zone"

The type of the report

access
string
Enum: "shared" "private"

The type of access

favorite
integer [ 0 .. 1 ]
Default: 0

Include this report in 'My Reports'

readOnly
integer [ 0 .. 1 ]
Default: 0

Read-only for other users

selectors
object

A collection of properties that define the data the report selects

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "observation",
  • "reportID": 1,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "groupID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "selectors": {
    },
  • "recipientSelectors": {
    },
  • "message": "string",
  • "access": "string",
  • "readOnly": 1,
  • "active": 1,
  • "interval": 0,
  • "permissions": {
    },
  • "frequency": 0,
  • "favorite": 1
}

Delete a report definition

Authorizations:
supervisor
query Parameters
reportID
integer

The ID of the report

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "reportID": 1
}

Fetch report definitions

Authorizations:
authorized
query Parameters
access
string
Enum: "shared" "private"

The type of access

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

reports
Array of integers

A list of reportIDs

types
Array of strings (reportType)
Items Enum: "observation" "obsDetail" "PPESummary" "worker" "check" "checkDetail" "zone"

A list of types to fetch

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "reports": [
    ]
}

Update a report definition

Note that either the reportID or reports parameters are required.

Authorizations:
supervisor
query Parameters
reportID
integer

The ID of the report

reports
Array of integers

A list of reportIDs

name
required
string

The name for the report. Note that the name must be unique within the folder (groupID)

description
string

Description of the item

access
string
Enum: "shared" "private"

The type of access

favorite
integer [ 0 .. 1 ]
Default: 0

Include this report in 'My Reports'

groupID
integer

The ID of the folder in which the report is defined. Defaults to 0 (no folder).

readOnly
integer [ 0 .. 1 ]
Default: 0

Read-only for other users

selectors
object

A collection of properties that define the data the report selects

type
string (reportType)
Enum: "observation" "obsDetail" "PPESummary" "worker" "check" "checkDetail" "zone"

The type of the report

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "reports": [
    ],
  • "type": "observation",
  • "reportID": 1,
  • "name": "string",
  • "description": "string",
  • "groupID": 0,
  • "access": "string",
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "selectors": {
    },
  • "recipientSelectors": {
    },
  • "message": "string",
  • "interval": 0,
  • "frequency": 0,
  • "readOnly": 1,
  • "active": 1,
  • "favorite": 1,
  • "permissions": {
    }
}

Data Mining

Get data about user compliance

Authorizations:
authorized
query Parameters
certificationID
Array of integers

A certification ID to check

compliance
string
Enum: "in" "out"

A type of compliance to filter by

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

gearID
string

The unique ID associated with this item.

interval
string

Slice the response data into intervals of this size

locID
Array of integers

A list if location IDs to filter against

roleID
Array of integers

A list of role IDs to filter against

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

userevents
integer [ 0 .. 1 ]
Default: 0

A flag indicating if user events should be included in the returned data. Defaults to false (0).

zoneevents
integer [ 0 .. 1 ]
Default: 0

A flag indicating if zone events should be included in the returned data. Defaults to false (0).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get compliance info about Gear

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

gearIDs
Array of integers

A list of gear items to filter against.

gearTypes
Array of strings (gearTypes)
Items Enum: "vest" "respirator" "eyewear" "fall" "boots" "gloves" "ear" "helmet" "sensor"

A list of gear types to filter against.

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeGroups
integer [ 0 .. 1 ]
Default: 0

A flag indicating that grouped gear should be included in the data.

includeLocations
integer [ 0 .. 1 ]
Default: 0

A flag indicating that location information should be included in the data.

interval
string

Slice the response data into intervals of this size

itemCount
integer

The number of records to fetch

lastItem
integer

The index of the last item fetched in a previous query

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

timeSpan
string (schemas-timespan)
Enum: "day" "today" "yesterday" "7days" "14days" "28days" "30days" "60days" "90days" "180days" "365days" "week" "thisweek" "lastweek" "thismonth" "month" "lastmonth" "thisquarter" "quarter" "lastquarter" "thisyear" "year" "lastyear" "thisfiscalquarter" "lastfiscalquarter" "thisfiscalyear" "lastfiscalyear"

The timespan over which to gather data

userTypes
Array of strings (userType)
Items Enum: "dedicated" "shared" "observation" "observer" "reporter" "viewer"

The types of user to filter against

zones
Array of integers (zoneID) [ items >= 0 ]

A list of zoneIDs to filter against

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gear": { }
}

Access Tokens

Access Tokens are a class of object that subscribers can define to grant access to their own API with the privileges of a user. Each token has various characteristics. The commands in this section manipulate token definitions.

Add an access token definition

Authorizations:
global-admin
query Parameters
expires
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time after which the access token will expire in seconds since the epoch. Defaults to 0 (never expire).

scopes
Array of strings (accessTokenScopes)
Items Enum: "read_api" "api"

The scopes of access for this token

title
string

A title for a token

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

The ID to associate with this token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "newToken": {
    }
}

Delete a token definition

Authorizations:
global-admin
query Parameters
tokenID
integer (accessTokenID) >= 1

A unique access token ID

tokens
Array of integers (accessTokenID) [ items >= 1 ]

A list of token IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get the collection of access token definitions

Authorizations:
global-admin
query Parameters
historyRows
integer
Default: 1

The number of history rows to return. Defaults to 1

includeHistory
integer [ 0 .. 1 ]
Default: 0

A boolean indicating whether usage history should be included. Defaults to false (0).

includeToken
integer [ 0 .. 1 ]
Default: 0

A boolean indicating whether the actual token should be included. Defaults to false (0).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

tokens
Array of integers (accessTokenID) [ items >= 1 ]

A list of token IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "accessTokens": {
    }
}

Update an access token definition

Authorizations:
global-admin
query Parameters
expires
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time after which the access token will expire in seconds since the epoch. Defaults to 0 (never expire).

scopes
Array of strings (accessTokenScopes)
Items Enum: "read_api" "api"

The scopes of access for this token

title
string

A title for a token

tokenID
integer

The ID of the token being updated

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

The ID to associate with this token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Accounts

addUser @@@ Needs a summary

Authorizations:
admin
query Parameters
avatarID
integer

@@@ Needs a parameter description

cell
string

@@@ Needs a parameter description

email
string

@@@ Needs a parameter description

firstname
string

@@@ Needs a parameter description

hireDate
integer

@@@ Needs a parameter description

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

lastname
string

@@@ Needs a parameter description

ldapServer
integer

@@@ Needs a parameter description

nfcID
string

@@@ Needs a parameter description

password
string

@@@ Needs a parameter description

permissions
string

@@@ Needs a parameter description

preferences
string

@@@ Needs a parameter description

primaryGroup
integer

@@@ Needs a parameter description

supervisorID
integer

@@@ Needs a parameter description

terminationDate
integer

@@@ Needs a parameter description

type
string

@@@ Needs a parameter description

username
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

deviceID
string (deviceID)

Unique Mobile Device ID

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shift
integer (shiftID) >= 0

The associated shift identifier

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "userID": -2
}

Calculate scores and ranks. Used for individal users via REST API. Only calculates all users from command line and via cron services.

Authorizations:
authorized
query Parameters
baseTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

A time from which to calculate scores. Defaults to now.

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The start of the timespan in which to calculate scores. Defaults to 0 (the beginning of time).

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of an interval to evaluate for calculate scores.

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include scores for workers that have been deleted. Defaults to false.

incremental
integer [ 0 .. 1 ]
Default: 0

Optionally only calculate scores for workers who have events since their last calculation. Defaults to 0 (false).

noUpdate
integer

Boolean to not save the updates. Defaults to false (0).

omitCompliance
integer [ 0 .. 1 ]
Default: 0

Boolean to omit the data about worker compliance. Defaults to false (0) - which means compliance data is included in the output.

omitEncounters
integer [ 0 .. 1 ]
Default: 0

Boolean to omit the data about worker proximity encounters. Defaults to false (0) - which means compliance data is included in the output.

permissions
Array of strings

Filter the results by worker permissions.

quiet
integer [ 0 .. 1 ]
Default: 0

Be quiet when running - only relevant to the command line version.

saveScores
integer [ 0 .. 1 ]
Default: 0

Boolean indicating scores should be saved to the database. Defaults to false (0).

showMemoryUsage
integer [ 0 .. 1 ]
Default: 0

Boolean indicating memory usage should be displayed. Only relevant to the command line version.

skipEventFetch
integer [ 0 .. 1 ]
Default: 0

Boolean indicating worker events should not be pre-fetched. Only relevant to the command line version.

skipNotify
integer [ 0 .. 1 ]
Default: 0

Boolean indicating notifications should not be sent. Only relevant to the command line version.

test
integer [ 0 .. 1 ]
Default: 0

Boolean indicating we are in test mode. Only relevant to the command line version.

truncate
integer [ 0 .. 1 ]
Default: 0

Option to indicate the scores table should be truncated before updating. Only relevant to the command line version.

userTypes
Array of strings

An optional list of user types to filter the results.

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "userScores": {
    },
  • "userRanks": {
    },
  • "teamScores": {
    }
}

deleteUser @@@ Needs a summary

Authorizations:
admin
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "userID": -2
}

getActiveUsers @@@ Needs a summary

Authorizations:
authorized
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch a list of basic account information

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeShared
integer [ 0 .. 1 ]
Default: 0

Include Shared Accounts. Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "users": [
    ]
}

getUsers @@@ Needs a summary

Authorizations:
authorized
query Parameters
UserToken
string

@@@ Needs a parameter description

calculatePoints
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

includeShared
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

noCache
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "users": [
    ]
}

permissions @@@ Needs a summary

Authorizations:
staff
query Parameters
config
string

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

preferences @@@ Needs a summary

Authorizations:
authorized
query Parameters
config
string

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999,
  • "preferences": { }
}

updatePassword @@@ Needs a summary

Authorizations:
authorized
query Parameters
passcodeNew
string

@@@ Needs a parameter description

passcodeOld
string

@@@ Needs a parameter description

passwordNew
string

@@@ Needs a parameter description

passwordOld
string

@@@ Needs a parameter description

reset
string

@@@ Needs a parameter description

securityAnswer
string

@@@ Needs a parameter description

securityQuestion
integer

@@@ Needs a parameter description

username
string

@@@ Needs a parameter description

verify
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

updateUser @@@ Needs a summary

Authorizations:
authorized
query Parameters
avatarID
integer

@@@ Needs a parameter description

cell
string

@@@ Needs a parameter description

consent
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

email
string

@@@ Needs a parameter description

firstname
string

@@@ Needs a parameter description

hireDate
integer

@@@ Needs a parameter description

lastname
string

@@@ Needs a parameter description

ldapServer
integer

@@@ Needs a parameter description

nfcID
string

@@@ Needs a parameter description

password
string

@@@ Needs a parameter description

permissions
string

@@@ Needs a parameter description

preferences
string

@@@ Needs a parameter description

primaryGroup
integer

@@@ Needs a parameter description

supervisorID
integer

@@@ Needs a parameter description

terminationDate
integer

@@@ Needs a parameter description

type
string

@@@ Needs a parameter description

username
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

deviceID
string (deviceID)

Unique Mobile Device ID

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shift
integer (shiftID) >= 0

The associated shift identifier

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "userID": -2
}

Assets

Assets are a class of item that reflect real-world objects. These objects are managed by the system, and can also have various other objects attached to them. Objects have location within the spaces defined by a Corvex subscriber. The commands in this section manipulate asset objects.

Add one or more assets

Note that either the assets parameter OR the name and other properties are required. If assets is supplied, then that parameter will be used to add one or more assets. Otherwise the name and other parameters will be used to add a single asset.

Authorizations:
supervisor
query Parameters
Array of objects

A list of asset objects. If this parameter is supplied the objects within it are all added to the system and the other parameters are ignored.

name
required
string

The name for the asset (must be unique within the asset type)

selectedSources
Array of integers[ items >= 1 ]

A list of external sourceIDs that can push into asset properties

Array of objects (assetContent)

A list of content objects to associate with the asset

Array of objects (assetProperties)

A list of asset property objects to associate with the asset

identifier
string

A description for the asset

folderID
integer

The folder in which this item is stored

assetUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A unique identifier for an asset

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

location
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations for term name

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

zone
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "assetID": 1,
  • "assetUUID": "string",
  • "assetType": 0,
  • "folderID": 0,
  • "name": "string",
  • "identifier": "string",
  • "parentContent": [
    ],
  • "contentItems": [
    ],
  • "selectedContent": [
    ],
  • "parentSources": [
    ],
  • "sources": [
    ],
  • "selectedSources": [
    ],
  • "images": [
    ],
  • "location": 0,
  • "zone": 0,
  • "currentZone": 0,
  • "users": [
    ],
  • "active": 1,
  • "beacons": [
    ],
  • "nfcTags": [
    ],
  • "shouldTrack": 0,
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "translations": [ ],
  • "history": [
    ],
  • "monitorHealth": 2,
  • "health": 2,
  • "stateEntered": 9999999999,
  • "parentProperties": [
    ],
  • "selectedProperties": [
    ],
  • "properties": [
    ],
  • "lastEvent": 9999999999,
  • "healthEvents": {
    },
  • "propertyEvents": {
    },
  • "observationEvents": [
    ],
  • "propertyValues": {
    }
}

Delete one or more assets

Authorizations:
admin
query Parameters
Array of objects

A list of asset objects

folderID
integer

The folder in which this item is stored

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Fetch information about assets

Authorizations:
authorized
query Parameters
assetTypes
Array of integers

A list of asset types (folderIDs)

assetID
integer

A single assetID

assets
Array of integers

A list of assetIDs

includeEvents
integer [ 0 .. 1 ]
Default: 0

Optionally include the list of associated healthEvents and propertyEvents for the matching assets.

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

zones
Array of integers (zoneID) [ items >= 0 ]

A list of Zone IDs

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "assets": [
    ]
}

Update one or more assets

Authorizations:
supervisor
query Parameters
object

An object of asset objects keyed by Asset ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Beacons

Beacons are a class of item that can be associated with users, zones, and assets. Beacons are either true IoT Bluetooth devices or NFC tags that are used to trigger actions. Actions include things like changing zones, identifying a nearby asset, detecting a nearby user, etc.

Add a beacon definition

Authorizations:
supervisor
query Parameters
beaconID
string (beaconID)

The unique ID for a beacon

zoneID
integer (zoneID) >= 0

Zone ID

UUID (string) or integer (IDorUUID)

The ID of an asset to associate with the new beacon

imageID
integer (a unique ID of an object in the objectMap table)

An objectID for an associated image

name
string

The name associated with the beacon

nfcID
string

A unique NFC ID that acts as a beacon

threshold
integer

The threshold for limiting proximity detection

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete a beacon definition

Authorizations:
supervisor
query Parameters
beaconID
string (beaconID)

The unique ID for a beacon

nfcID
string

A unique NFC ID that acts as a beacon

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get information about a beacon

Authorizations:
authorized
query Parameters
beaconID
string (beaconID)

The unique ID for a beacon

nfcID
string

A unique NFC ID that acts as a beacon

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get information about a collection of beacons

Authorizations:
authorized
query Parameters
locID
integer

Fetch beacons associated with this location

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Update a beacon definition

Authorizations:
admin
query Parameters
beaconID
required
string (beaconID)

The unique ID for a beacon

battery
integer

The battery level

comment
string

A description for the beacon

imageID
integer (a unique ID of an object in the objectMap table)

An objectID for an associated image

name
string

The name associated with the beacon

nfcID
string

A unique NFC ID that acts as a beacon

threshold
integer

The threshold for limiting proximity detection

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Certifications

A Certification is an attribute of zones, users, and potentially assets. Zones can require one or more certifications. Users can have these associated with them. A user with appropriate privilege can manage the collection of Certifications that is available within a Subscriber's Locations for their Participants.

NOTE: Since a certification is a part of a user record, and since it could be added or removed at any time, compliance records include information about the certifications that were attached to the user at the time of the record's creation.

Add a certification definition

Authorizations:
admin
query Parameters
name
required
string

The name of the certification

description
string

Description of the item

ntranslations
Array of objects

The translations for the name

dtranslations
Array of objects

The translations for the description

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "certificationID": 0
}

Delete a certification definition

Authorizations:
admin
query Parameters
certificationID
integer

The ID of the certification

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "certificationID": 0
}

Fetch certification definitions

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

name
string

The name of the certification

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "certifications": [
    ]
}

Update a certification definition

Authorizations:
admin
query Parameters
certificationID
integer

The ID of the certification

dtranslations
Array of objects

The translations for the description

name
string

The name of the certification

ntranslations
Array of objects

The translations for the name

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "certificationID": 0
}

Collections

Collections are a class of item that are used to group other objects in the system. The commands in this section manipulate collection objects.

Add a collection

Authorizations:
authorized
query Parameters
folderID
integer (folderID) >= 0

The folder in which a collection is stored

itemOrder
Array of integers

The order in which items in the collection should appear

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required to access the collection

state
string
Default: "new"

The state of the collection

title
string

A description for the collection

type
string
Enum: "topic" "learningTeam" "watchList"

A type for the collection

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "collectionID": 0,
  • "folderID": 0,
  • "type": "string",
  • "title": "string",
  • "description": "string",
  • "state": "string",
  • "active": 1,
  • "votes": {
    },
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "permissions": [ ],
  • "teams": [ ],
  • "locations": [ ],
  • "filterID": 0,
  • "nodeSelections": [ ],
  • "translations": { },
  • "itemOrder": [ ],
  • "history": [
    ]
}

Add items to a collection

Authorizations:
authorized
query Parameters
collectionID
required
integer

The unique ID of a collection

Array of objects (collectionItemObject)

The items that are in the collection

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete one or more collections

Authorizations:
authorized
query Parameters
collectionID
integer

The unique ID of a collection

collections
Array of integers

A list of collection IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete items from a collection

Authorizations:
authorized
query Parameters
Array of objects (collectionItemObject)

The items that are in the collection

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get items from one or more collections

Authorizations:
authorized
query Parameters
collectionID
integer

The unique ID of a collection

collections
Array of integers

A list of collection IDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

Array of objects (collectionItemObject)

The items that are in the collection

types
Array of strings (type-schema)
Items Enum: "topic" "learningTeam" "watchList"

The types of collections to use

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "items": [
    ]
}

Fetch the collection definitions

Authorizations:
authorized
query Parameters
collections
Array of integers

A list of collection IDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeItems
integer [ 0 .. 1 ]
Default: 0

Boolean indicating if the items should be included with the definitions. Defaults to 0 (false).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

types
Array of strings (type-schema)
Items Enum: "topic" "learningTeam" "watchList"

The types of collections to use

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

deviceID
string (deviceID)

Unique Mobile Device ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "collections": {
    }
}

Record a voew about a collection

Authorizations:
authorized
query Parameters
collectionID
required
integer

The unique ID of a collection

vote
string
Enum: "yes" "no" "remove"

The vote to record

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update the definition of a collection

Authorizations:
authorized
query Parameters
collectionID
required
integer

The unique ID of a collection

folderID
integer (folderID) >= 0

The folder in which a collection is stored

itemOrder
Array of integers

The order in which items in the collection should appear

nodeSelections
Array of strings

An array of node or location IDs

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required to access the collection

state
string
Default: "new"

The state of the collection

title
string

A description for the collection

type
string
Enum: "topic" "learningTeam" "watchList"

A type for the collection

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update the items in a collection

Authorizations:
authorized
query Parameters
Array of objects (collectionItemObject)

The items that are in the collection

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Core Targets

Target are a class of item that reflect real-world NFC tags. These targets are managed by the system, and can also have various other objects (e.g., assets, zones) attached to them. The commands in this section manipulate targets.

Add a core target defininition

Authorizations:
admin
query Parameters
assetID
integer (assetID) >= 1

An asset ID to associate with the core target

imageID
integer (a unique ID of an object in the objectMap table)

An object ID for an image

locID
required
integer (schemas-locationID) >= 0

Location ID

name
string

The name for the core target

nfcID
string

The unique NFC ID of the core target

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "target": {
    }
}

Delete a core target definition

Authorizations:
admin
query Parameters
nfcID
string

The unique NFC ID of the core target

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of core target definitions

Authorizations:
authorized
query Parameters
assets
Array of integers (assetList) [ items >= 1 ]

A list of assets to filter against

locs
Array of integers (schemas-locationList) [ items >= 0 ]

A list of location IDs to filter against

nfcID
string

The unique NFC ID of the core target

targets
Array of strings

A list of target signatures to filter againt

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "targets": {
    }
}

Update a core target definition

Authorizations:
admin
query Parameters
assetID
integer (assetID) >= 1

An asset ID to associate with the core target

imageID
integer (a unique ID of an object in the objectMap table)

An object ID for an image

locID
required
integer (schemas-locationID) >= 0

Location ID

name
string

The name for the core target

nfcID
string

The unique NFC ID of the core target

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "target": {
    },
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Data Pools

Data Pools are a class of object that are used to contain arbitrary data provided by subscribers. The commands in this section manipulate data pool objects and the items within each data pool.

Add a data pool definition

Authorizations:
global-admin
query Parameters
folderID
integer

The folder in which this item is stored

permissions
Array of strings

@@@ Needs a parameter description

title
string

A title for the data pool

type
string

Tye type of the data pool

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "poolID": 0,
  • "folderID": 0,
  • "title": "string",
  • "description": "string",
  • "active": 1,
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "permissions": [ ],
  • "teams": [ ],
  • "locations": [ ],
  • "nodeSelections": [ ],
  • "translations": { }
}

Add items to a data pool

Authorizations:
global-admin
query Parameters
items
Array of integers

A list of data pool item IDs

poolID
integer

A unique ID for a data pool

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete a data pool or pools

Authorizations:
global-admin
query Parameters
poolID
integer

A unique ID for a data pool

pools
Array of integers

A list of pool IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete one or more items from a pool

Authorizations:
global-admin
query Parameters
items
Array of integers

A list of data pool item IDs

poolID
integer

A unique ID for a data pool

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get items from one or more pools

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

items
Array of integers

A list of data pool item IDs

poolID
integer

A unique ID for a data pool

pools
Array of integers

A list of pool IDs

types
Array of strings

A list of pool object types

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "items": [
    ]
}

Fetch a list of data pools

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeItems
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the pool items should be returned as well. Defaults to false (0).

types
Array of strings

A list of pool object types

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "pools": {
    }
}

Associate tags with pool items

Authorizations:
authorized
query Parameters
items
Array of integers

A list of data pool item IDs

replace
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the tags should replace the existing tags on the items. Defaults to false (0).

tags
Array of integers

A list of tagIDs to associate with the items

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update a data pool definition

Authorizations:
global-admin
query Parameters
folderID
integer

The folder in which this item is stored

nodeSelections
Array of strings

An array of node or location IDs

permissions
Array of strings

@@@ Needs a parameter description

poolID
integer

A unique ID for a data pool

pools
Array of integers

A list of pool IDs

title
string

A title for the data pool

type
string

Tye type of the data pool

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Disclaimers

Disclaimers are a class of object that can be attached to things in the system. When a thing (e.g., PPE) is accessed or registered, the associated disclaimer is displayed and the user must acknowledge it before proceeding.

Record a user accepted a disclaimer

Authorizations:
authorized
query Parameters
disclaimerID
required
integer

The disclaimerID to accept

subjectType
required
string

The subject type that was acknowledged

subjectID
required
string

The subjectID that was acknowledged

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Add a disclaimer definition

Authorizations:
global-admin
query Parameters
disclaimer
string

The text of the disclaimer

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

title
string

The title for the item

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "newDisclaimer": {
    }
}

Delete a disclaimer from the system

Authorizations:
global-admin
query Parameters
disclaimerID
integer

The ID of the disclaimer to delete.

disclaimers
Array of integers

A list of disclaimers to delete. Either this or the disclaimerID parameter are required.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of disclaimers

Authorizations:
authorized
query Parameters
disclaimers
Array of integers

An optional list of disclaimerIDs to fetch.

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "disclaimers": {
    }
}

Update one or more disclaimer definitions.

Authorizations:
global-admin
query Parameters
disclaimer
string

The text of the disclaimer

disclaimerID
integer

The ID of the disclaimer to update. This or a disclaimers object is required.

disclaimers
object

A hash of disclaimer objects to update, keyed by disclaimerID

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

title
string

The title for the item

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Feedback Requests

Add a reply to a Feedback Request

Authorizations:
authorized
query Parameters
attachments
Array of strings

A list of attached objectIDs

fromOriginator
integer [ 0 .. 1 ]
Default: 0

Is the reply from the originator? (Default 0, not from the originator.)

groupID
integer

The team ID to associate with the reply. Defaults to the user's primary team or 0 if there is none

prevReply
integer
Default: 0

The feedback replyID of the previous reply in the thread.

reply
string

The text of the reply

requestID
integer

The unique ID of the request

isAnonymous
integer [ 0 .. 1 ]
Default: 0

The operation should be anonymous.

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shift
integer (shiftID) >= 0

The associated shift identifier

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "replyID": 0
}

Add a Feedback Request

Authorizations:
supervisor
query Parameters
folderID
integer

The folder in which the request is located

parentType
string
Enum: "observation" "collection" "checkResponse" "workNote"

The type of an object that is the parent of this request

parentID
string

The ID of a parent object of type parentType that is the parent of this request

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions to which the request is restricted

question
string

The question being asked

state
string
Enum: "draft" "published" "addressed" "archived"

The state of the request

tagIDs
Array of strings

A list of tagIDs associated with the request

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "requestID": 0,
  • "folderID": 0,
  • "question": "string",
  • "state": "draft",
  • "creator": -2,
  • "creatorGroupID": 0,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "permissions": [ ],
  • "teams": [ ],
  • "tagIDs": [ ],
  • "locations": [ ],
  • "users": [ ],
  • "nodeSelections": [ ],
  • "translations": [ ],
  • "recipients": [ ],
  • "parentType": "string",
  • "history": [
    ],
  • "parentID": "string"
}

Delete a Feedback Request

Authorizations:
authorized
query Parameters
requestID
integer

The unique ID of the request

requests
Array of integers

A list of request IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch a collection of Feedback Requests

Authorizations:
authorized
query Parameters
includeHidden
integer [ 0 .. 1 ]
Default: 0

Include requests that are hidden. Defaults to 0 - do not include.

includeHistory
integer [ 0 .. 1 ]
Default: 0

Include the history of the Feedback Requests. Defaults to 0 - do not include.

includeRecipients
integer [ 0 .. 1 ]
Default: 0

Include the recipients of the Feedback Request. Defaults to 0 - do not include

includeReplies
integer [ 0 .. 1 ]
Default: 0

Include the replies to the Feedback Request. Defaults to 0 - do not include

requests
Array of integers

A list of request IDs

states
Array of strings (state)
Items Enum: "draft" "published" "learning" "addressed" "archived"

Only include Feedback Requests that match one of the referenced states.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "requests": {
    }
}

Update one ore more Feedback Replies

Authorizations:
authorized
query Parameters
attachments
Array of strings

A list of attached objectIDs

replies
Array of objects

An optional list of Feedback Replies to update

replyID
integer

The ID of the feedback reply to update

state
string
Enum: "draft" "published" "addressed" "archived"

The state of the request

tagIDs
Array of strings

A list of tagIDs associated with the request

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update one or more Feedback Requests

Authorizations:
authorized
query Parameters
folderID
integer

The folder in which the request is located

nodeSelections
Array of strings

An array of node or location IDs

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions to which the request is restricted

question
string

The question being asked

requestID
integer

The unique ID of the request

requests
Array of integers

A list of request IDs

state
string
Enum: "draft" "published" "addressed" "archived"

The state of the request

tagIDs
Array of strings

A list of tagIDs associated with the request

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Filters

“Filters” are collections of selectors that are used by the backend and client to restrict the display of information.

Add a filter definition

Authorizations:
authorized
query Parameters
access
string
Enum: "private" "shared"

The type of access to this filter

name
string

A unique name for this filter

selectors
string

A object of the selectors

columns
Array of integers (columnList) [ items >= 0 ]

A list of columns to display related to the filtered data

Array of objects (sortOrderList)

A list of sort criteria

type
string
Enum: "general" "leaderboard" "simple" "advanced" "observation"

The type of the filter

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "leaderboard",
  • "filterID": 0,
  • "name": "string",
  • "description": "string",
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "uuid": "string",
  • "sortBy": [
    ],
  • "columns": [
    ],
  • "selectors": {
    },
  • "access": "string",
  • "active": 1
}

Delete a filter definition

Authorizations:
authorized
query Parameters
filterID
integer

The unique ID of the filter

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "reportID": 1
}

Fetch a collection of filter definitions

Authorizations:
authorized
query Parameters
access
string
Enum: "private" "shared"

The type of access to this filter

filters
Array of integers

An array of filter IDs to match

types
Array of strings

The types of filters to match

uuids
Array of strings

The unique IDs of the filters to match

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "filters": [
    ]
}

Update a filter definition

Authorizations:
authorized
query Parameters
access
string
Enum: "private" "shared"

The type of access to this filter

filterID
integer

The unique ID of the filter

name
string

A unique name for this filter

selectors
string

A object of the selectors

columns
Array of integers (columnList) [ items >= 0 ]

A list of columns to display related to the filtered data

Array of objects (sortOrderList)

A list of sort criteria

type
string
Enum: "general" "leaderboard" "simple" "advanced" "observation"

The type of the filter

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "leaderboard",
  • "filterID": 0,
  • "name": "string",
  • "description": "string",
  • "access": "string",
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "selectors": {
    },
  • "active": 1
}

Folders

Folders are a class of item that are used to group other object in the system. The commands in this section manipulate folder objects.

Add a folder

Authorizations:
authorized
query Parameters
parentID
integer

The unique ID of a parent folder. 0 means there is no parent.

title
string

A title to use for the folder

type
string (folderType)
Enum: "location" "report" "asset" "notification" "property" "content" "gateway" "relay" "externalSource" "externalItem"

The type of thing that is organized within this folder. Examples include 'asset', 'report', 'location'.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

object (accessObject)

A collection of access restrictions

object

A collection of type-dependent attributes

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "folderID": 0,
  • "parentID": 0,
  • "uuid": "string",
  • "type": "location",
  • "access": {
    },
  • "parentAttributes": { },
  • "attributes": { },
  • "title": "string",
  • "active": 1,
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "locations": [ ],
  • "translations": [ ]
}

Delete a folder or folders

The folderID or folders parameters are required.

Authorizations:
authorized
query Parameters
folderID
integer

The unique ID of the folder

folders
Array of integers

A list of folderIDs to delete

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Fetch a folder hierarchy

Authorizations:
authorized
query Parameters
includeLocations
integer [ 0 .. 1 ]
Default: 0

Include the list of associated location IDs for folders (a special operation for folders of type 'location')

rollupChildren
integer [ 0 .. 1 ]
Default: 0

An optional boolean that indicates child locations should be included in all parent folders. See includeLocations. Defaults to false (0).

type
string (folderType)
Enum: "location" "report" "asset" "notification" "property" "content" "gateway" "relay" "externalSource" "externalItem"

The type of thing that is organized within this folder. Examples include 'asset', 'report', 'location'.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tree": { }
}

Fetch a collection of folders

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeLocations
integer [ 0 .. 1 ]
Default: 0

Include the list of associated location IDs for folders (a special operation for folders of type 'location')

includeNodes
integer [ 0 .. 1 ]
Default: 0

Attach node identifiers to locations (see includeLocations)

types
Array of strings

A list of folder types to fetch

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "folders": {
    }
}

Update the definition of a folder

Authorizations:
authorized
query Parameters
folderID
integer

The unique ID of the folder

parentID
integer

The unique ID of a parent folder. 0 means there is no parent.

title
string

A title to use for the folder

type
string (folderType)
Enum: "location" "report" "asset" "notification" "property" "content" "gateway" "relay" "externalSource" "externalItem"

The type of thing that is organized within this folder. Examples include 'asset', 'report', 'location'.

object (accessObject)

A collection of access restrictions

object

A collection of type-dependent attributes

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Gateway Support

Add a gateway

Adds a gateway configuration to the system.

Authorizations:
staff
query Parameters
name
required
string

The name for the gateway (must be unique)

mac
string

The MAC address of the ethernet port of the gateway

bootstrap
string

The data for bootstrapping the gateway

config
string

The shell configuration settings for gateway scripts

localconfig
string

The localconfig settings for the gateway REST API

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

lid
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "assetID": 1,
  • "assetUUID": "string",
  • "assetType": 0,
  • "folderID": 0,
  • "name": "string",
  • "identifier": "string",
  • "parentContent": [
    ],
  • "contentItems": [
    ],
  • "selectedContent": [
    ],
  • "parentSources": [
    ],
  • "sources": [
    ],
  • "selectedSources": [
    ],
  • "images": [
    ],
  • "location": 0,
  • "zone": 0,
  • "currentZone": 0,
  • "users": [
    ],
  • "active": 1,
  • "beacons": [
    ],
  • "nfcTags": [
    ],
  • "shouldTrack": 0,
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "translations": [ ],
  • "history": [
    ],
  • "monitorHealth": 2,
  • "health": 2,
  • "stateEntered": 9999999999,
  • "parentProperties": [
    ],
  • "selectedProperties": [
    ],
  • "properties": [
    ],
  • "lastEvent": 9999999999,
  • "healthEvents": {
    },
  • "propertyEvents": {
    },
  • "observationEvents": [
    ],
  • "propertyValues": {
    }
}

Delete a gateway

Authorizations:
admin
query Parameters
gatewayID
integer

The ID of a gateway

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gatewayID": 0
}

getCommands @@@ Needs a summary

Authorizations:
authorized
query Parameters
subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

getConfig @@@ Needs a summary

Authorizations:
authorized
query Parameters
debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch information about gateways

Authorizations:
authorized
query Parameters
gateways
Array of integers

A list of gatewayIDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gateways": {
    }
}

gwbootstrap @@@ Needs a summary

Authorizations:
authorized
query Parameters
gwpass
string

@@@ Needs a parameter description

gwuser
string

@@@ Needs a parameter description

mac
string

@@@ Needs a parameter description

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

gwregister @@@ Needs a summary

Authorizations:
authorized
query Parameters
format
string

@@@ Needs a parameter description

gwpass
string

@@@ Needs a parameter description

gwuser
string

@@@ Needs a parameter description

ipaddr
Array of strings

@@@ Needs a parameter description

mac
string

@@@ Needs a parameter description

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Update a gateway

Authorizations:
supervisor
query Parameters
gatewayID
integer

The ID of a gateway

name
required
string

The name for the gateway (must be unique)

mac
string

The MAC address of the ethernet port of the gateway

bootstrap
string

The data for bootstrapping the gateway

config
string

The shell configuration settings for gateway scripts

localconfig
string

The localconfig settings for the gateway REST API

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

lid
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gatewayID": 0,
  • "folderID": 0,
  • "lid": 0,
  • "active": 1,
  • "name": "string",
  • "mac": "string",
  • "bootstrap": "string",
  • "localconfig": "string",
  • "config": "string",
  • "tls_crt": "string",
  • "tls_key": "string",
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "createdAt": 9999999999,
  • "creator": -2
}

Gear

“Gear” encompasses both instrumented PPE (Corvex-enabled via NFC and/or beacons) and other, non-Corvex equipment that a user might need to equip. The Safety Manager or another user with appropriate privilege can manage the collection of Gear that is available within a Subscriber's Locations for their Participants. Gear items are grouped into Gear Types. The list of Gear Types is currently pre-defined, but will eventually be replaced with a subscriber-defined folder structure.

Add a gear item

Authorizations:
admin
query Parameters
autoVerify
integer [ 0 .. 1 ]
Default: 0

A flag indicating the item should automatically verify as being work if it is registered. Defaults to false (0).

canOverride
integer [ 0 .. 1 ]
Default: 0

A flag indicating an item can be manually verified. Defaults to false (0).

Array of objects (assetContent)

A list of content objects to associate with the gear

corvexID
string

A unique prefix used this item if it is smartGear.

cost
number
Default: 0

A per-unit cost associated with this item.

imageID
integer

An objectID depicting this item.

manufacturer
string

Th manufacturer name

name
string

A name for this item

rating
integer

An optional numeric rating for this item within this class

resource
string

The ID of a user who is an expert about this item

sku
string

The manufacturer SKU of this item

subtype
string

A per-type subtype to distinguish this item.

type
string

The type of this item (note that this may be superceded by a folderID in the future)

usesBeacon
integer

An optional boolean flag that indicates whether this type of PPE requires a Corvex Sense beacon. If true (non-zero) then the system will look for a Corvex Sense beacon during registration and map that beacon to the individual piece of gear to allow for automatic individualized monitoring.

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gearID": 0
}

Delete a gear definition

Authorizations:
admin
query Parameters
gearID
string

The unique ID associated with this item.

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

deviceID
string (deviceID)

Unique Mobile Device ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get information about a registered piece of gear

Authorizations:
authorized
query Parameters
beaconID
string

The gear's unique beacon ID

gearID
string

The unique ID associated with this item.

nfcID
string

The gear's unique NFC ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get data about user compliance

Authorizations:
authorized
query Parameters
certificationID
Array of integers

A certification ID to check

compliance
string
Enum: "in" "out"

A type of compliance to filter by

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

gearID
string

The unique ID associated with this item.

interval
string

Slice the response data into intervals of this size

locID
Array of integers

A list if location IDs to filter against

roleID
Array of integers

A list of role IDs to filter against

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

userevents
integer [ 0 .. 1 ]
Default: 0

A flag indicating if user events should be included in the returned data. Defaults to false (0).

zoneevents
integer [ 0 .. 1 ]
Default: 0

A flag indicating if zone events should be included in the returned data. Defaults to false (0).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get the collection of gear item definitions

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gear": [
    ]
}

Get compliance info about Gear

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

gearIDs
Array of integers

A list of gear items to filter against.

gearTypes
Array of strings (gearTypes)
Items Enum: "vest" "respirator" "eyewear" "fall" "boots" "gloves" "ear" "helmet" "sensor"

A list of gear types to filter against.

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeGroups
integer [ 0 .. 1 ]
Default: 0

A flag indicating that grouped gear should be included in the data.

includeLocations
integer [ 0 .. 1 ]
Default: 0

A flag indicating that location information should be included in the data.

interval
string

Slice the response data into intervals of this size

itemCount
integer

The number of records to fetch

lastItem
integer

The index of the last item fetched in a previous query

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

timeSpan
string (schemas-timespan)
Enum: "day" "today" "yesterday" "7days" "14days" "28days" "30days" "60days" "90days" "180days" "365days" "week" "thisweek" "lastweek" "thismonth" "month" "lastmonth" "thisquarter" "quarter" "lastquarter" "thisyear" "year" "lastyear" "thisfiscalquarter" "lastfiscalquarter" "thisfiscalyear" "lastfiscalyear"

The timespan over which to gather data

userTypes
Array of strings (userType)
Items Enum: "dedicated" "shared" "observation" "observer" "reporter" "viewer"

The types of user to filter against

zones
Array of integers (zoneID) [ items >= 0 ]

A list of zoneIDs to filter against

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gear": { }
}

Update a Gear Definition

Authorizations:
admin
query Parameters
autoVerify
integer [ 0 .. 1 ]
Default: 0

A flag indicating the item should automatically verify as being work if it is registered. Defaults to false (0).

canOverride
integer [ 0 .. 1 ]
Default: 0

A flag indicating an item can be manually verified. Defaults to false (0).

Array of objects (assetContent)

A list of content objects to associate with the gear

corvexID
string

A unique prefix used this item if it is smartGear.

cost
number
Default: 0

A per-unit cost associated with this item.

gearID
string

The unique ID associated with this item.

imageID
integer

An objectID depicting this item.

manufacturer
string

Th manufacturer name

name
string

A name for this item

rating
integer

An optional numeric rating for this item within this class

resource
string

The ID of a user who is an expert about this item

sku
string

The manufacturer SKU of this item

subtype
string

A per-type subtype to distinguish this item.

type
string

The type of this item (note that this may be superceded by a folderID in the future)

usesBeacon
integer

An optional boolean flag that indicates whether this type of PPE requires a Corvex Sense beacon. If true (non-zero) then the system will look for a Corvex Sense beacon during registration and map that beacon to the individual piece of gear to allow for automatic individualized monitoring.

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gearID": 0
}

LDAP

getLDAPServers @@@ Needs a summary

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

searchLDAP @@@ Needs a summary

Authorizations:
admin
query Parameters
ldapServer
integer

@@@ Needs a parameter description

username
string

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "matches": [
    ]
}

Locations

Add a Location

Authorizations:
global-admin
query Parameters
address
string

A physical address for the location

city
string

The location's city

contact
string

The name of a contact person

Array of objects (assetContent)

A list of content objects to associate with the location

country
string

The country for the location

features
object

The set of features that are enabled at this location

folderID
integer

The folder in which this location is stored (for Location Hierarchy)

gear
Array of integers (schemas-gearID) [ items >= 0 ]

A list of gear IDs required at the location

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

name
string

A unique name of the location

phone
string

A phone number

plugins
string

The plugins supported at the location

preferences
string

The subscriber preferences for the location

state
string

The State/Region of the location

timezone
string

The timezone of the location

units
string

The preferred measurement units for the location

zip
string

The postal code for the location

certifications
Array of integers (certificationID) [ items >= 0 ]

A list of certificationIDs representing Certifications that are required within this entire Location. When considering compliance, a User MUST have these Certifications.

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete a Location

Authorizations:
global-admin
query Parameters
locID
integer

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get the collection of Locations

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

deviceID
string (deviceID)

Unique Mobile Device ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "locations": [
    ]
}

Update a Location Definition

Authorizations:
admin
query Parameters
address
string

A physical address for the location

city
string

The location's city

contact
string

The name of a contact person

Array of objects (assetContent)

A list of content objects to associate with the location

country
string

The country for the location

features
object

The set of features that are enabled at this location

folderID
integer

The folder in which this location is stored (for Location Hierarchy)

gear
Array of integers (schemas-gearID) [ items >= 0 ]

A list of gear IDs required at the location

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

locID
integer

@@@ Needs a parameter description

name
string

A unique name of the location

phone
string

A phone number

plugins
string

The plugins supported at the location

preferences
string

The subscriber preferences for the location

state
string

The State/Region of the location

timezone
string

The timezone of the location

units
string

The preferred measurement units for the location

zip
string

The postal code for the location

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Media Objects

An object is any sort of binary file that needs to be uploaded to the gateway / backend for later use. When an object is uploaded, it is stored such that it is retrievable by users with appropriate privilege using standard HTTP GET requests from a client.

Add an object to the database.

This is usually called to reserve a space for the object. The object will later be uploaded.

Authorizations:
authorized
query Parameters
contentCategory
integer

A folderID in which the content item is stored.

folderID
integer

The folder in which this item is stored

file
string

An uploaded 'file' item

revision
string

An optional unique revision identifier for the object.

object

A collection of type-dependent attributes

uploaded
integer [ 0 .. 1 ]
Default: 0

A flag that the associated object has already been uploaded (probably to S3 storage). Defaults to false (0).

isPublic
integer [ 0 .. 1 ]
Default: 0

A flag indicating the item does not require authorization to access. Defaults to false (0).

language
string

The natural language associated with this item. Defaults to 'en' for English.

mediaType
string

The IETF Media Type of the item

mergeWith
string

UNIMPLEMENTED

An objectID with which the uploaded item should be merged.

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

replaces
string

The objectID that this object should replace.

state
string (The state of this object)
Enum: "active" "inactive" "deleted" "retired" "draft" "inReview" "approved" "rejected" "pending" "published" "withdrawn" "deprecated"

The state for this item. Defaults to 'active'

subtype
string

The subtype of this object

translationOf
integer

The object ID for which this object is a translation

type
string

The subtype of this object

updates
string

The object ID that this object should update.

creator_shift
integer (shiftID) >= 0

The shift identifier of the creator

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

creator
integer (userID) >= -2

The userID of the creator

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

isAnonymous
integer [ 0 .. 1 ]
Default: 0

The operation should be anonymous.

users
Array of integers (userList) [ items >= -2 ]

A list of userIDs that are responsible for the item.

location
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

observationUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

An Observation UUID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Add a note to an object

Authorizations:
supervisor
query Parameters
objectID
integer

A unique ID for the object

revision
string

An optional unique revision identifier for the object.

type
string
Value: "comment"

The type of the note.

subtype
string
Value: "review"

The optional subtype of the note. Defaults to ''.

value
required
string

The text for a note

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "noteID": 1
}

Create a new revision for an object

Authorizations:
authorized
query Parameters
objectID
required
integer

The unique ID for the object

revision
required
string

A unique revision identifier for the object.

note
string

An optional note about the revision

object

A collection of type-dependent attributes

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete an object

Authorizations:
global-admin
query Parameters
objectID
integer

A unique ID for the object

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

revision
string

An optional unique revision identifier for the object.

allRevisions
integer [ 0 .. 1 ]
Default: 0

A flag indicating the update should be applied to all revisions of an object.Defaults to false (0).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete a note from an object

Authorizations:
supervisor
query Parameters
noteID
integer

The ID of an Object Note

notes
Array of integers

A list of Object Note IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get an object

Authorizations:
authorized
query Parameters
language
string

The natural language associated with this item. Defaults to 'en' for English.

objectID
integer

A unique ID for the object

revision
string

An optional unique revision identifier for the object.

thumb
integer [ 0 .. 1 ]
Default: 0

Request a thumbnail for the object. Defaults to false (0).

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "object": {
    },
  • "file": "string",
  • "contentsize": 0,
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get metadata about an object or set of objects

Authorizations:
authorized
query Parameters
language
string

The natural language associated with this item. Defaults to 'en' for English.

objectID
integer

A unique ID for the object

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

revision
string

An optional unique revision identifier for the object.

states
string (The state of this object)
Enum: "active" "inactive" "deleted" "retired" "draft" "inReview" "approved" "rejected" "pending" "published" "withdrawn" "deprecated"

A list of states to which to limit the search.

isVisibleTo
integer (userID) >= -2

A userID to whom the object must be visible

includeHistory
integer [ 0 .. 1 ]
Default: 0

A flag indicating object history should be included with objects. Defaults to false (0).

includeNotes
integer [ 0 .. 1 ]
Default: 0

A flag indicating that note records should be included with objects. Defaults to false (0).

includeProperties
integer [ 0 .. 1 ]
Default: 0

A flag indicating property values should be included with objects. Defaults to false (0).

includeEvents
integer [ 0 .. 1 ]
Default: 0

A flag indicating property events should be included with objects. Defaults to false (0).

includeRevisions
integer [ 0 .. 1 ]
Default: 0

A flag indicating all revisions of matching objects should be included. Defaults to false (0).

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "object": {
    },
  • "objects": [
    ],
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a list of objects and their meta data

Authorizations:
authorized
query Parameters
isVisibleTo
integer (userID) >= -2

A userID to whom the object must be visible

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

states
Array of strings

A list of states to which to limit the search.

types
Array of strings

A list of object types to limit the search.

includeEvents
integer [ 0 .. 1 ]
Default: 0

A flag indicating property events should be included with objects. Defaults to false (0).

includeHistory
integer [ 0 .. 1 ]
Default: 0

A flag indicating object history should be included with objects. Defaults to false (0).

includeProperties
integer [ 0 .. 1 ]
Default: 0

A flag indicating property values should be included with objects. Defaults to false (0).

includeRevisions
integer [ 0 .. 1 ]
Default: 0

A flag indicating all revisions of matching objects should be included. Defaults to false (0).

incremental
integer [ 0 .. 1 ]
Default: 0

A flag indicating the request is for changes since lastRequest. Defaults to false (0).

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "objects": [
    ],
  • "removed": [
    ]
}

Get a simple map of object IDs to limited metadata

Authorizations:
authorized
query Parameters
lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

fromGateway
integer [ 0 .. 1 ]

Request came from a gateway - defaults to 0 (false)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "map": {
    }
}

Add a renewal approval to the revision of an Object

Authorizations:
authorized
query Parameters
objectID
integer

A unique ID for the object

revision
string

An optional unique revision identifier for the object.

note
string

A note about the approval

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Add a review to an Object

Authorizations:
authorized
query Parameters
objectID
integer

A unique ID for the object

revision
string

An optional unique revision identifier for the object.

note
string

A note about the review

result
any
Enum: "approved" "rejected"

The result of the review

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Start the review period for an Object

Authorizations:
authorized
query Parameters
objectID
integer

A unique ID for the object

revision
string

An optional unique revision identifier for the object.

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update an Object definition

Authorizations:
authorized
query Parameters
objectID
integer

A unique ID for the object

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

revision
string

An optional unique revision identifier for the object.

contentCategory
integer

A folderID in which the content item is stored.

folderID
integer

The folder in which this item is stored

object

A collection of type-dependent attributes

isPublic
integer [ 0 .. 1 ]
Default: 0

A flag indicating the item does not require authorization to access. Defaults to false (0).

language
string

The natural language associated with this item. Defaults to 'en' for English.

mediaType
string

The IETF Media Type of the item

newrevision
string

A new revision ID to use for the object. This is only permitted when the object being updated is NOT under revision control OR, if it is under revision control, when it is in a draft state.

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

state
string (The state of this object)
Enum: "active" "inactive" "deleted" "retired" "draft" "inReview" "approved" "rejected" "pending" "published" "withdrawn" "deprecated"

The state for this item. Defaults to 'active'

subtype
string

The subtype of this object

tags
string

A list of tag IDs to associate with the Object

translation_of
integer

The object ID that this object is a translation of.

type
string

The subtype of this object

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

description
string

Description of the item

users
Array of integers (userList) [ items >= -2 ]

A list of userIDs that are responsible for the item.

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

observationUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

An Observation UUID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Upload an object to the system

NOTE: This command must be executed directly, not via the dispatcher. Since this command takes a file for upload, it must use the POST format and POST cannot be redirected. While it is possible to do that redirect on the server via a complex fork/exec hand-off of the file descriptors, calling the operation directly is more robust.

Authorizations:
authorized
query Parameters
contentCategory
integer

A folderID in which the content item is stored.

folderID
integer

The folder in which this item is stored

object

A collection of type-dependent attributes

file
string

An uploaded 'file' item

uploaded
integer [ 0 .. 1 ]
Default: 0

A flag that the associated object has already been uploaded (probably to S3 storage). Defaults to false (0).

isPublic
integer [ 0 .. 1 ]
Default: 0

A flag indicating the item does not require authorization to access. Defaults to false (0).

language
string

The natural language associated with this item. Defaults to 'en' for English.

mediaType
string

The IETF Media Type of the item

mergeWith
string

UNIMPLEMENTED

An objectID with which the uploaded item should be merged.

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

replaces
string

The objectID that this object should replace.

state
string (The state of this object)
Enum: "active" "inactive" "deleted" "retired" "draft" "inReview" "approved" "rejected" "pending" "published" "withdrawn" "deprecated"

The state for this item. Defaults to 'active'

subtype
string

The subtype of this object

translationOf
integer

The object ID for which this object is a translation

type
string

The subtype of this object

updates
string

The object ID that this object should update.

creator_shift
integer (shiftID) >= 0

The shift identifier of the creator

certifications
Array of integers (certificationID) [ items >= 0 ]

An array of certificationIDs

creator
integer (userID) >= -2

The userID of the creator

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

isAnonymous
integer [ 0 .. 1 ]
Default: 0

The operation should be anonymous.

users
Array of integers (userList) [ items >= -2 ]

A list of userIDs that are responsible for the item.

location
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

observationUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

An Observation UUID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Messaging

Add a message

Authorizations:
authorized
query Parameters
message
string

The text of the message

messageUUID
string

A UUID for the message.

objectID
integer

An ID of an associated object to attach to the message.

onlyActive
integer [ 0 .. 1 ]
Default: 0

A flag indicating the message should only be sent to currently active users. Defaults to false (0).

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of user permissions to which to limit message distribution.

previousMessageID
string

The ID of the previous message in a thread. Defaults to 0 (no previous message).

priority
string

The priority of the message

source
string
Default: ""

The source type of the message (the thing to which the message is related). Defaults to the empty string, meaning no source.

sourceID
string
Default: ""

The ID within the source type to which this message is related. Defaults to the empty string, meaning no ID.

subtype
string

The subtype of the message (if any). Defaults to the empty string, meaning no subtype

type
string

The type of the message

when
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

When the message should be sent in seconds since the epoch. Defaults to 0, meaning send immediately.

zones
Array of integers (zoneID) [ items >= 0 ]

A list of zones to which to direct the message (relevant only when onlyActive is true).

deviceID
string (deviceID)

Unique Mobile Device ID

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

objectUUID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A Media Object UUID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageID": 0,
  • "messageUUID": "string",
  • "previousMessageID": 0,
  • "nextMessageID": 0,
  • "observationID": 0,
  • "observationType": "",
  • "observationSubtype": "string",
  • "type": "emergency",
  • "subtype": "",
  • "state": "pending",
  • "priority": "normal",
  • "source": "string",
  • "sourceID": "string",
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "userID": -2,
  • "when": 9999999999,
  • "message": "string",
  • "objectUUID": "string",
  • "object": {
    },
  • "onlyActive": 1,
  • "nodeSelections": [
    ],
  • "locations": [
    ],
  • "zones": [
    ],
  • "roles": [
    ],
  • "permissions": [
    ],
  • "users": [
    ],
  • "recipients": [
    ]
}

Delete a Message

Authorizations:
authorized
query Parameters
messageID
integer (messageID) >= 0

The unique ID of a message

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch a collection of messages

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

limit
integer

The maximum number of messages to fetch in this request. Defaults to 0 - meaning no limit.

messages
Array of integers (messageID) [ items >= 0 ]

A list of message IDs

priorities
Array of integers

Limit the fetch to messages with certain priorities.

recipients
Array of integers (userID) [ items >= -2 ]

A list of recipient userIDs

senders
Array of integers (userID) [ items >= -2 ]

Limit the fetch to messages sent by specific users

startAfter
integer

Start returning items after the Nth item in the list. Deaults to 0, meaning the first item.

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

states
Array of strings

Limit the messages to ones with the specified states.

types
Array of integers

Limit the messages to ones of the specified types.

useCreated
integer

Use the created time of the message. Defaults to false (0), meaning use the 'last updated' time of the message

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "moreAvailable": 1,
  • "removals": [
    ],
  • "messages": [
    ]
}

Set the status of a message or messages

Authorizations:
authorized
query Parameters
action
string

The action being performed

messageID
integer (messageID) >= 0

The unique ID of a message

messages
Array of integers (messageID) [ items >= 0 ]

A list of message IDs

recipients
Array of integers (userID) [ items >= -2 ]

A list of recipient userIDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "recipients": [
    ]
}

Migration

export @@@ Needs a summary

Authorizations:
authorized
query Parameters
asFile
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

selectors
string

@@@ Needs a parameter description

type
string

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "exported": {
    }
}

import @@@ Needs a summary

Authorizations:
authorized
query Parameters
data
string

@@@ Needs a parameter description

rules
string

@@@ Needs a parameter description

validate
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Notifications

“Notification Rules” are collections of selectors that are used by the backend to decide when to automatically send notifications to various users. The rules are managed by the subscriber using the interfaces in this section.

Add a notification rule definition

Authorizations:
admin
query Parameters
folderID
integer

The folder in which this item is stored

frequency
integer

The frequency in seconds to resend the notification if the selectors continue to be matched. Defaults to 0 - no resend.

interval
integer >= 0

The amount of time in seconds after the selectors are matched before the notification should be sent. A interval of 0 means that the notification is sent as soon as possible after the conditions defined by the selectors are matched.

message
string

The text of the message to send when the notification is triggered. Note that messages can contain references to special variables that are expanded when the message is generated.

name
string

A name for the notification rule.

priority
string
Enum: "action" "informative"

The priority of this notification.

object

The collection of users who should be notified

selectors
object

The selection rules. Note that the collection of selector options varies depending upon the type of notification rule.

type
string
Enum: "observation" "compliance" "beacon"

The type of the notification rule

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

isExample
integer [ 0 .. 1 ]
Default: 0

Is the item an example (defaults to 0 - not an example). Items that are marked as an example can only be edited or updated by a user with staff permission.

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "observation",
  • "ruleID": 1,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "folderID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "activatedAt": 9999999999,
  • "selectors": {
    },
  • "recipientSelectors": {
    },
  • "interval": 0,
  • "frequency": 0,
  • "subject": "string",
  • "message": "string",
  • "priority": "string",
  • "active": 1,
  • "isExample": 0,
  • "translations": { }
}

Delete a rule definition

Authorizations:
global-admin
query Parameters
ruleID
integer

A unique ID for the rule.

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "ruleID": 1
}

Fetch the collection of rules

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

rules
Array of integers

A list of ruleIDs to fetch.

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

types
Array of strings

A list of rule types to fetch

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "rules": [
    ]
}

Update a rule definition

Authorizations:
admin
query Parameters
Array of objects (schemas-ruleObject)

A list of rule objects to update

folderID
integer

The folder in which this item is stored

frequency
integer

The frequency in seconds to resend the notification if the selectors continue to be matched. Defaults to 0 - no resend.

interval
integer >= 0

The amount of time in seconds after the selectors are matched before the notification should be sent. A interval of 0 means that the notification is sent as soon as possible after the conditions defined by the selectors are matched.

message
string

The text of the message to send when the notification is triggered. Note that messages can contain references to special variables that are expanded when the message is generated.

name
string

A name for the notification rule.

priority
string
Enum: "action" "informative"

The priority of this notification.

object

The collection of users who should be notified

ruleID
integer

A unique ID for the rule.

selectors
object

The selection rules. Note that the collection of selector options varies depending upon the type of notification rule.

type
string
Enum: "observation" "compliance" "beacon"

The type of the notification rule

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

isExample
integer [ 0 .. 1 ]
Default: 0

Is the item an example (defaults to 0 - not an example). Items that are marked as an example can only be edited or updated by a user with staff permission.

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "updates": [
    ],
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "observation",
  • "ruleID": 1,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "folderID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "activatedAt": 9999999999,
  • "selectors": {
    },
  • "recipientSelectors": {
    },
  • "priority": "string",
  • "subject": "string",
  • "message": "string",
  • "interval": 0,
  • "frequency": 0,
  • "translations": { },
  • "isExample": 0,
  • "active": 1
}

Observations

An “Observation” is type of event. A user provides information about an environmental or situational issue about which they feel some action should be taken. Each observation has various characteristics that are captured by the user, recorded by the backend, and later reviewed and annotated by other users. The APIs in this section are designed to support this functionality.

Add an Observation

Authorizations:
authorized
query Parameters
attachments
Array of strings

A list of object IDs attached to the observation

categories
Array of integers

The closing categories associated with the observation

groupID
integer

The Team ID associated with the observation. Defaults to 0 - no team.

impact
integer

An impact score to associate with the observation

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

likelihood
integer [ 1 .. 100 ]

A percentage likelihood that something similar could happen again.

note
string

A note to associate with the observation

Array of objects

A list of note objects to attach

recipients
Array of integers

A list of user IDs to which the observation was linked. Currently this is only for observations of type 'compliment'.

responseID
string (responseID)

A related Check Response ID

severity
integer [ 1 .. 100 ]

A percentage judgement as to how severe the related event was.

subtype
string

A subtype for this observation. Based upon the type property.

tagIDs
Array of integers

A list of tag IDs to associate with the observation

type
string (schemas-observationType)
Enum: "" "ai" "condition" "behavior" "compliment" "lean" "quality" "pi"

The type of the Observation

uuid
string

A UUID for the observation. Only created by the client when operating via a gateway or when the client is offline.

value
string

A monetary value to associate with the observation

workorder
string

A related workorder ID - typically from a separate work order management system.

subjectType
string (subjectType)
Enum: "asset" "location" "worker" "zone"

The type of the subject of the observation.

subjectID
string (subjectID)

The ID of the subject within the subjectType space.

Array of objects

A list of property events

deviceID
string (deviceID)

Unique Mobile Device ID

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

isAnonymous
integer [ 0 .. 1 ]
Default: 0

The operation should be anonymous.

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "",
  • "typeOverride": "",
  • "subtype": "string",
  • "subtypeOverride": "string",
  • "state": "new",
  • "uuid": "string",
  • "responseID": "string",
  • "impact": 0,
  • "value": "string",
  • "severity": 100,
  • "severityOverride": 100,
  • "severityClosed": 100,
  • "likelihood": 100,
  • "likelihoodOverride": 100,
  • "likelihoodClosed": 100,
  • "observationID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "userID": -2,
  • "creatorShift": "string",
  • "ownerID": -2,
  • "ownerShift": "string",
  • "locationID": 0,
  • "zoneID": 0,
  • "groupID": 0,
  • "workorder": "string",
  • "workorderSstatus": "string",
  • "sustainable": 1,
  • "lat": "string",
  • "lon": "string",
  • "tagIDs": [
    ],
  • "categories": [
    ],
  • "recipients": [
    ],
  • "groups": [
    ],
  • "subjectType": "asset",
  • "subjectID": "string",
  • "history": [
    ],
  • "notes": [
    ],
  • "attachments": [
    ],
  • "watching": 1,
  • "images": [
    ],
  • "workorderStatus": "string"
}

Create a work request in a related maintenance system

Authorizations:
authorized
query Parameters
assetID
integer

An asset to associate with the work request

priority
string

A priority to assign to the work request

title
string

A title to give the work request

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete an Observation

Authorizations:
supervisor
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch a collection of Observations

Authorizations:
authorized
query Parameters
core
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the request is from a 'core' device. Defaults to false (0).

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

incremental
integer [ 0 .. 1 ]
Default: 0

A boolean indicating this is an incremental request to update a local list of observations. Defaults to false (0).

interval
string

Slice the response data into intervals of this size

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

limit
integer

The maximum number of items to fetch

observations
Array of integers

A list of observation IDs

owners
Array of integers (userID) [ items >= -2 ]

Limit the collection to a list of owner IDs

startAfter
integer

An index after which to start returning items. Used in conjunction with limit. Defaults to 0 (the first item).

subjectTypes
Array of strings (subjectTypes)
Items Enum: "asset" "location" "worker" "zone"

An optional list of subjectTypes to filter against

subjectIDs
Array of strings (subjectIDs)

An optional list of subectIDs within the subjectTypes spaces to filter against. Note that since type space IDs may not be unique, this parameter should only be used in conjunction with a single subject type.

states
Array of strings

A list of observation states to limit the returned collection

subtypes
Array of strings

A list of subtypes to which to limit the returned collection

types
Array of strings

A list of observation types to which to limit the collection

uuids
Array of strings

A list of observation UUIDs to which to limit the collection

zones
Array of integers

A list of zone IDs to which to limit the collection

deviceID
string (deviceID)

Unique Mobile Device ID

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "moreAvailable": 1,
  • "observationCount": 0,
  • "observations": [
    ]
}

Associate on or more tags with one or more Observations

Authorizations:
authorized
query Parameters
observations
Array of integers

A list of observation IDs

replace
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the tags should replace the current list. Defaults to false (0).

tagIDs
Array of integers

A list of tag IDs to associate with the observation

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update an Observation

Authorizations:
authorized
query Parameters
attachments
Array of strings

A list of object IDs attached to the observation

categories
Array of integers

The closing categories associated with the observation

groupID
integer

The Team ID associated with the observation. Defaults to 0 - no team.

impact
integer

An impact score to associate with the observation

likelihood
integer [ 1 .. 100 ]

A percentage likelihood that something similar could happen again.

likelihoodClosed
integer

The likelihood of the event recurring after the Observation is closed

likelihoodOverride
integer

A likelihood specified by someone other than the creator

note
string

A note to associate with the observation

ownerID
integer (userID) >= -2

An update for the owner ID

reassign
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the observation is being reassigned. Defaults to false (0)

recipients
Array of integers

A list of user IDs to which the observation was linked. Currently this is only for observations of type 'compliment'.

severity
integer [ 1 .. 100 ]

A percentage judgement as to how severe the related event was.

subjectID
string (subjectID)

The ID of the subject within the subjectType space.

Array of objects

A list of property events

severityClosed
integer

The severity of the event after the Observation has been reviewed

severityOverride
integer

The severity of the event as re-evaluated after the Observation is closed

state
string

A new state for the Observation

subtype
string

A subtype for this observation. Based upon the type property.

subtypeOverride
string

A new subtype for the Observation

sustainable
integer

A boolean indicating if the resolution of the Observation is sustainable. Defaults to false (0).

tagIDs
Array of integers

A list of tag IDs to associate with the observation

typeOverride
string

@@@ Needs a parameter description

uuid
string

A UUID for the observation. Only created by the client when operating via a gateway or when the client is offline.

value
string

A monetary value to associate with the observation

workorder
string

A related workorder ID - typically from a separate work order management system.

deviceID
string (deviceID)

Unique Mobile Device ID

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

locationID
required
integer (schemas-locationID) >= 0

Location ID

UUID (string) or integer (IDorUUID)

An Observation ID or UUID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "type": "",
  • "typeOverride": "",
  • "subtype": "string",
  • "subtypeOverride": "string",
  • "impact": 0,
  • "value": "string",
  • "state": "new",
  • "uuid": "string",
  • "severity": 100,
  • "severityOverride": 100,
  • "severityClosed": 100,
  • "likelihood": 100,
  • "likelihoodOverride": 100,
  • "likelihoodClosed": 100,
  • "observationID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "subjectType": "asset",
  • "subjectID": "string",
  • "userID": -2,
  • "creatorShift": "string",
  • "ownerID": -2,
  • "ownerShift": "string",
  • "locationID": 0,
  • "zoneID": 0,
  • "groupID": 0,
  • "workorder": "string",
  • "workorderStatus": "string",
  • "sustainable": 1,
  • "categories": [
    ],
  • "tagIDs": [
    ],
  • "recipients": [
    ],
  • "notes": [
    ],
  • "images": [
    ],
  • "history": [
    ],
  • "watching": 1,
  • "attachments": [
    ]
}

Plugins

“Plugins” are external collections of services that are then accessible through the Core or the Web App.
Plugins have plugin-defined options and option-settings. The interfaces in this section allow the retrieval and updating of plugin settings and the capture of retrieval of plugin-specific events.

Add an event from a plugin

Authorizations:
authorized
query Parameters
pluginID
integer

A unique ID of the plugin

pluginName
string

The name for the plugin

value
string

A value for the setting

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Add a setting for a Plugin

Authorizations:
global-admin
query Parameters
optionID
integer

The unique ID for the plugin option

pluginID
integer

A unique ID of the plugin

pluginName
string

The name for the plugin

value
string

A value for the setting

zones
Array of integers

A list of zoneIDs

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "setting": {
    }
}

Delete a plugin setting

Authorizations:
global-admin
query Parameters
settingID
integer

The unique ID of a plugin setting

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Fetch events captured by a plugin

Authorizations:
authorized
query Parameters
lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

pluginID
integer

A unique ID of the plugin

pluginName
string

The name for the plugin

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

zones
Array of integers

A list of zoneIDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "events": [
    ]
}

Get the settings for a plugin

Authorizations:
authorized
query Parameters
optionIDs
Array of integers

A list of plugin optionIDs to limit the search

pluginID
integer

A unique ID of the plugin

pluginName
string

The name for the plugin

zones
Array of integers

A list of zoneIDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "observations": [
    ]
}

Get the list of plugins

This interface pulls the list of defined plugins from the a master list, not a per-subscriber database.

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "recordcount": 0,
  • "plugins": [
    ]
}

Update plugin settings

Authorizations:
global-admin
query Parameters
settingID
integer

The unique ID of a plugin setting

value
string

A value for the setting

zones
Array of integers

A list of zoneIDs

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "setting": {
    }
}

Power Point Tiers

Add a tier definition

Authorizations:
global-admin
query Parameters
header
string

The headline to use for this tier

message
string

A message to deliver when attaining a tier

name
string

The name for a tier

objectID
integer (a unique ID of an object in the objectMap table)

The related image objectID

threshold
integer

The number of points required to attain a tier

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translation for terms header, message, and name.

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tierID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "name": "string",
  • "description": "string",
  • "message": "string",
  • "header": "string",
  • "objectID": "string",
  • "threshold": 0,
  • "translations": { },
  • "disabledAt": 9999999999,
  • "disabledBy": -2
}

Delete a tier definition

Authorizations:
global-admin
query Parameters
tierID
integer (tierID) >= 0

The unique ID for a tier

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tierID": 0
}

Get worker or team power point scores

Authorizations:
authorized
query Parameters
permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required for access

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

userTypes
Array of strings
Items Enum: "dedicated" "shared" "observation" "observer" "reporting"

Only include information about certain types of users

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

groups
Array of integers (groupID) [ items >= 0 ]

An array of teams (aka groupIDs)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

roles
Array of integers (roleID) [ items >= 0 ]

An array of role IDs

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get a collection of tier definitions

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

tiers
Array of integers (tierID) [ items >= 0 ]

A list of tierIDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tiers": [
    ]
}

Update a tier definition

Authorizations:
global-admin
query Parameters
header
string

The headline to use for this tier

message
string

A message to deliver when attaining a tier

name
string

The name for a tier

objectID
integer (a unique ID of an object in the objectMap table)

The related image objectID

threshold
integer

The number of points required to attain a tier

tierID
integer (tierID) >= 0

The unique ID for a tier

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translation for terms header, message, and name.

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tierID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "name": "string",
  • "description": "string",
  • "message": "string",
  • "header": "string",
  • "objectID": "string",
  • "threshold": 0,
  • "translations": { },
  • "disabledAt": 9999999999,
  • "disabledBy": -2
}

Properties

Properties are arbitrary data that is gathered manually, provided automatically, or derived from other properties. Each property can be associated with items in the system, gathered with respect to those items, and then reported upon or reacted to as appropriate.

Some property information is gathered from external event data. Other information is derived from actions or data in the system that can be used as a metric (e.g., the number of missed checks for an asset within a period). Aspects of the system that can provide metric data as a property will automatically inject that data as a propery event for any item in the system that subscribes to it. Over time as we gain more experience with events and the backend load induced through their evaluation, we may reorganize the order of operations. This will be effect the numbers generated, just the way in which they are generated.

Add a Property

Authorizations:
global-admin
query Parameters
category
string (propertyCategory)
Enum: "text" "number" "zone" "asset:inService" "check:missed" "check:skipped" "check:completed" "check:failed" "check:passed" "observation:open" "observation:unassigned"

A base category for a property

folderID
integer (folderID) >= 0

The folder in which a property definition is stored

uniqueName
required
string

A unique name for the property

title
required
string

A human-readable title for the property

description
string

A human-readable detailed description for the property

style
string (propertyStyle)
Enum: "number" "text" "textarea" "note" "flipswitch" "duration" "timestamp" "measurement" "counter"

The style used presentation and data gathering when the type is manual or hybrid.

object (propertyManualInput)

When and how the property data can be captured manually

subjects
Array of strings (propertySubjects)
Items Enum: "asset" "worker" "zone" "location" "content"

The subjects to which this property can be attached.

source
string (propertySource)
Enum: "manual" "pull" "push" "pushOverTime" "hybrid" "derived" "overTime" "calculated"

A type for the property

timespan
integer (timespan) >= 0
Default: 0

The time in seconds over which the values calculated when the property is of category overTime.

timespan_unit
string (timespan_unit)
Enum: "minutes" "hours" "days" "weeks"

The units in which the timespan was selected.

method
string (method)
Enum: "highest" "lowest" "cumulative" "average"

The manner in which the value is determined when there is a timespan.

healthRelated
integer [ 0 .. 1 ]
Default: 0

Can the property be used to evaluate health? (defaults to 0 - no).

object (propertyThresholds)

The thresholds associated with property health

unit
string

An optional unit to associate with numeric property

displayPrecision
number [ -1 .. 8 ]

The precision to use when displaying numeric property values. -1 means no rounding, 0 means round to integer, 1 means round to 1 decimal place etc. The default is -1.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "propertyID": 1
}

Capture events for a property

Authorizations:
authorized
query Parameters
propertyID
integer

The unique ID of a property

uniqueName
string

A unique name for the property

subject
string (propertySubject)
Enum: "asset" "worker" "zone" "location" "content"

The subject type of the event(s)

subjectID
string

The subject ID of the event(s)

activity
string

The activity when adding a single event

source
string

The source when adding a single event

value
string

The value when adding a single event

Array of objects

A list of events when capturing multiple events

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "count": 0
}

Delete a Property

Authorizations:
global-admin
query Parameters
properties
Array of integers

A list of property IDs

propertyID
integer

The unique ID of a property

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of Properties

Authorizations:
authorized
query Parameters
categories
Array of strings (propertyCategory)
Items Enum: "text" "number" "zone" "asset:inService" "check:missed" "check:skipped" "check:completed" "check:failed" "check:passed" "observation:open" "observation:unassigned"

Filter the set by a list of categories

includeEvents
integer [ 0 .. 1 ]
Default: 0

Include events for the matching properties

eventLimit
integer

Limit the number of events returned per property. Defaults to all events.

includeHistory
integer [ 0 .. 1 ]
Default: 0

Include audit history for the matching properties

uniqueNames
Array of strings

Filter the set by a list of unique property names

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

category
string (propertyCategory)
Enum: "text" "number" "zone" "asset:inService" "check:missed" "check:skipped" "check:completed" "check:failed" "check:passed" "observation:open" "observation:unassigned"

A base category for a property

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

properties
Array of integers

A list of property IDs

propertyID
integer

The unique ID of a property

subjects
Array of strings (propertySubjects)
Items Enum: "asset" "worker" "zone" "location" "content"

The subjects to which this property can be attached.

sources
Array of strings (propertySource)
Items Enum: "manual" "pull" "push" "pushOverTime" "hybrid" "derived" "overTime" "calculated"

The types of properties to use

uniqueName
string

A unique name for the property

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "properties": {
    }
}

Retrieve events

Authorizations:
authorized
query Parameters
bySubject
integer [ 0 .. 1 ]
Default: 0

Organize the results by subject and return in a subjects attribute. (defaults to 0 - no).

byProperty
integer [ 0 .. 1 ]
Default: 0

Organize the results by propertyID and return in a properties attribute. (defaults to 0 - no). If this and bySubject are both true, this takes precedence.

propertyID
integer

The unique ID of a property

uniqueName
string

A unique name for the property

subject
string (propertySubject)
Enum: "asset" "worker" "zone" "location" "content"

The subject type of the event(s)

subjectID
string

The subject ID of the event(s)

activities
Array of strings

Filter for events that have these activities

activity
string

Filter for events that have this activity

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "events": [
    ],
  • "properties": { },
  • "subjects": { }
}

Update a property

Authorizations:
global-admin
query Parameters
category
string (propertyCategory)
Enum: "text" "number" "zone" "asset:inService" "check:missed" "check:skipped" "check:completed" "check:failed" "check:passed" "observation:open" "observation:unassigned"

A base category for a property

description
string

A human-readable detailed description for the property

folderID
integer (folderID) >= 0

The folder in which a property definition is stored

permissions
Array of strings (permissionList)
Items Enum: "worker" "supervisor" "admin" "sadmin" "corvex"

A list of permissions required to access the property

properties
Array of integers

A list of property IDs

propertyID
integer

The unique ID of a property

style
string (propertyStyle)
Enum: "number" "text" "textarea" "note" "flipswitch" "duration" "timestamp" "measurement" "counter"

The style used presentation and data gathering when the type is manual or hybrid.

object (propertyManualInput)

When and how the property data can be captured manually

subjects
Array of strings (propertySubjects)
Items Enum: "asset" "worker" "zone" "location" "content"

The subjects to which this property can be attached.

title
string

A human-readable title for the property

source
string (propertySource)
Enum: "manual" "pull" "push" "pushOverTime" "hybrid" "derived" "overTime" "calculated"

A type for the property

uniqueName
string

A unique name for the property

method
string (method)
Enum: "highest" "lowest" "cumulative" "average"

The manner in which the value is determined when there is a timespan.

timespan
integer (timespan) >= 0
Default: 0

The time in seconds over which the values calculated when the property is of category overTime.

timespan_unit
string (timespan_unit)
Enum: "minutes" "hours" "days" "weeks"

The units in which the timespan was selected.

healthRelated
integer [ 0 .. 1 ]
Default: 0

Can the property be used to evaluate health? (defaults to 0 - no).

object (propertyThresholds)

The thresholds associated with property health

unit
string

An optional unit to associate with numeric property

displayPrecision
number [ -1 .. 8 ]

The precision to use when displaying numeric property values. -1 means no rounding, 0 means round to integer, 1 means round to 1 decimal place etc. The default is -1.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Relays

Relays are on-prem devices at subscriber locations. Relays are monitored and data from them is forwarded to the cloud environment via MQTT. The commands in this section manipulate Relay definitions.

addRelay @@@ Needs a summary

Authorizations:
admin
query Parameters
signature
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

locID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

title
string

The title for the item

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

folderID
integer

The folder in which this item is stored

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "newRelay": {
    }
}

deleteRelay @@@ Needs a summary

Authorizations:
admin
query Parameters
relayID
integer

@@@ Needs a parameter description

relays
Array of integers

@@@ Needs a parameter description

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

getRelays @@@ Needs a summary

Authorizations:
admin
query Parameters
relays
Array of integers

@@@ Needs a parameter description

signatures
Array of strings

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "relays": {
    }
}

updateRelay @@@ Needs a summary

Authorizations:
admin
query Parameters
relayID
integer

@@@ Needs a parameter description

relays
string

@@@ Needs a parameter description

signature
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

locID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

title
string

The title for the item

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

folderID
integer

The folder in which this item is stored

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Roles

role is an abstract subscriber-defined item that includes a name and associated compliance requirements.

Add a role definition

Authorizations:
admin
query Parameters
containedBy
integer (roleID) >= 0

An optional parent roleID. If specified, this role inherits properties from its parent. Defaults to 0 - no parent role.

exclusive
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that this role is 'exclusive' - only one exclusive role can be in effect for a user at any time.

gearAdds
Array of integers (gearList) [ items >= 0 ]

A list of gearIDs a user with this role is required to wear in addition to other, zone-specific requirements.

gearExceptions
Array of integers (gearList) [ items >= 0 ]

A list of gearIDs a user with this role is permitted to not be wearing and still remain complaint.

name
string

A name for the role

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "roleID": 0
}

Delete a role definition

Authorizations:
global-admin
query Parameters
roleID
integer (roleID) >= 0

A unique ID for a role

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "roleID": 0
}

Get a collection of roles

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "roles": [
    ]
}

Update a role definition

Authorizations:
admin
query Parameters
containedBy
integer (roleID) >= 0

An optional parent roleID. If specified, this role inherits properties from its parent. Defaults to 0 - no parent role.

exclusive
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that this role is 'exclusive' - only one exclusive role can be in effect for a user at any time.

gearAdds
Array of integers (gearList) [ items >= 0 ]

A list of gearIDs a user with this role is required to wear in addition to other, zone-specific requirements.

gearExceptions
Array of integers (gearList) [ items >= 0 ]

A list of gearIDs a user with this role is permitted to not be wearing and still remain complaint.

name
string

A name for the role

roleID
integer (roleID) >= 0

A unique ID for a role

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "roleID": 0
}

Searching

simpleSearch @@@ Needs a summary

Authorizations:
authorized
query Parameters
columns
Array of strings

@@@ Needs a parameter description

creators
Array of integers

@@@ Needs a parameter description

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

@@@ Needs a parameter description

limit
integer

@@@ Needs a parameter description

sources
Array of strings

@@@ Needs a parameter description

start
integer

@@@ Needs a parameter description

startTime
number
Default: 0

@@@ Needs a parameter description

states
Array of strings

@@@ Needs a parameter description

tags
Array of integers

@@@ Needs a parameter description

terms
Array of strings

@@@ Needs a parameter description

zones
Array of strings

@@@ Needs a parameter description

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

teams
Array of integers (groupID) [ items >= 0 ]

An array of team IDs (aka groupIDs)

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Safety Messages

“Safety Messages” are collections of messages that will be shown to workers on their mobile devices. See the getMOTD command for the interface that worker clients use to retrieve a message.

NOTE: Safety Messages are also known as "Message of the day" for historical reasons.

Add a Safety Message to the system

Authorizations:
admin
query Parameters
message
string

The text of the message.

NOTE: This can include Markdown.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "locations": [
    ],
  • "nodeSelections": [
    ],
  • "message": "string",
  • "translations": [
    ],
  • "active": 1,
  • "disabledAt": 9999999999,
  • "disabledBy": -2
}

Delete a Safety Message from the system

Authorizations:
admin
query Parameters
messageID
integer

The unique id of the Safety Message

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageID": 0
}

Fetch a Safety Message

Authorizations:
authorized
query Parameters
lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

override
integer

@@@ Needs a parameter description

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "message": "string",
  • "translations": [
    ]
}

Get a collection of Safety Messages

Authorizations:
authorized
query Parameters
startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

messages
Array of integers

A list of safety message IDs to fetch

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "datahash": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messages": [
    ]
}

Update a Safety Message definition

Authorizations:
admin
query Parameters
message
string

The text of the message.

NOTE: This can include Markdown.

messageID
integer

The unique id of the Safety Message

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "locations": [
    ],
  • "nodeSelections": [
    ],
  • "translations": [
    ],
  • "message": "string",
  • "active": 1
}

Subscriber Settings

Add a subscriber setting (DEPRECATED)

Authorizations:
global-admin
query Parameters
locID
integer

A location ID

name
string

The name of the subscriber

value
string

A value for a setting

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "settingID": 1
}

Define a setting

Authorizations:
admin
query Parameters
contentItems
Array of integers

A list of objectIDs to make available in each location.

messageTitle
string

A title for the item

type
string

The type of the setting

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageTemplateID": 0
}

Delete a subscriber setting

Authorizations:
authorized
query Parameters
messageID
integer

A unique ID for the item in the collection

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "rowsaffected": 1,
  • "messageTemplateID": 0
}

Delete a subscriber setting (DEPRECATED)

Authorizations:
global-admin
query Parameters
locID
integer

A location ID

name
string

The name of the subscriber

settingID
integer

The unique ID of a stored setting

value
string

A value for a setting

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Fetch the subscriber settings

Authorizations:
authorized
query Parameters
activeOnly
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that only active settings should be returned. Defaults to false (0).

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

messageID
integer

A unique ID for the item in the collection

messageTitle
string

A title for the item

types
Array of strings

The types of settings to fetch

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messages": [
    ]
}

Get the set of defined shifts

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

shifts
Array of integers (shiftID) [ items >= 0 ]

An array of shift IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "shifts": [
    ]
}

Get the basic subscriber info

Authorizations:
authorized
query Parameters
prefix
string

The unique company code for the subscriber

subscriber
integer

The ID of the sibscriber

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Get subscriber settings (DEPRECATED)

Authorizations:
authorized
query Parameters
name
string

The name of the subscriber

settingID
integer

The unique ID of a stored setting

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "settings": [
    ]
}

Set the password policy

Authorizations:
global-admin
query Parameters
object

The policy definition

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "policy": "string",
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Set the subscriber status

Authorizations:
staff
query Parameters
address
string

The physical address of the subscribers primary location

city
string

The subscriber city

contact
string

The name of a contact person

country
string

The country for the subscriber

email
string

The primary contact email

features
object

The set of features the subscriber has enabled.

frontendurl
string

The URL of the subcriber's instance

languages
string

The list of natural langauges enabled for the subscriber.

modules
string

A list of modules enabled for the subscriber.

phone
string

The phone number of the primary contact person

plugins
Array of strings

The list of plugins enabled for the subscriber

preferences
object

The collection of preferences for the subscriber

prefix
string

The unique company code for the subscriber

serverStatus
string
Enum: "up" "down"

The status of the subscriber instance

state
string

The State/Region of the location

subscriberName
string

The name of the subscriber

units
string

The preferred measurement units for the subscriber

url
string

The URL of the subscriber REST API

zip
string

The postal code for the primary location

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "subscriberID": 0,
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "description": "string",
  • "email": "string",
  • "endDate": "string",
  • "phone": "string",
  • "startDate": "string",
  • "state": "string",
  • "subscriberName": "string",
  • "zip": "string",
  • "serverStatus": "string",
  • "modules": { },
  • "features": { },
  • "plugins": { },
  • "units": {
    },
  • "languages": {
    },
  • "preferences": { }
}

Update a subscriber setting

Authorizations:
admin
query Parameters
contentItems
Array of integers

A list of objectIDs to make available in each location.

messageID
integer

A unique ID for the item in the collection

messageTitle
string

A title for the item

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "messageTemplateID": 0
}

Update the subscriber information

Authorizations:
global-admin
query Parameters
address
string

The physical address of the subscribers primary location

city
string

The subscriber city

contact
string

The name of a contact person

country
string

The country for the subscriber

email
string

The primary contact email

features
object

The set of features the subscriber has enabled.

frontendurl
string

The URL of the subcriber's instance

languages
string

The list of natural langauges enabled for the subscriber.

modules
string

A list of modules enabled for the subscriber.

phone
string

The phone number of the primary contact person

plugins
Array of strings

The list of plugins enabled for the subscriber

preferences
object

The collection of preferences for the subscriber

prefix
string

The unique company code for the subscriber

serverStatus
string
Enum: "up" "down"

The status of the subscriber instance

state
string

The State/Region of the location

subscriberName
string

The name of the subscriber

units
string

The preferred measurement units for the subscriber

url
string

The URL of the subscriber REST API

zip
string

The postal code for the primary location

description
string

Description of the item

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "subscriberID": 0,
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "description": "string",
  • "email": "string",
  • "endDate": "string",
  • "phone": "string",
  • "startDate": "string",
  • "state": "string",
  • "subscriberName": "string",
  • "zip": "string",
  • "modules": { },
  • "features": { },
  • "plugins": { },
  • "units": {
    },
  • "languages": {
    },
  • "preferences": { }
}

Update a subscriber setting (DEPRECATED)

Authorizations:
global-admin
query Parameters
locID
integer

A location ID

name
string

The name of the subscriber

settingID
integer

The unique ID of a stored setting

value
string

A value for a setting

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Tags

"Tags” are terms that are created by users in various places througout the system. Items can be 'tagged' and later searched and reported upon based on those tags.

Add a tag

Authorizations:
authorized
query Parameters
tag
string

A string used as a tag

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tagID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "tag": "string",
  • "active": 1,
  • "disabledAt": 9999999999,
  • "disabledBy": -2
}

Delete a tag

Authorizations:
admin
query Parameters
tagID
integer

The unique ID of a tag

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tagID": 0
}

Get the collection of tags

Authorizations:
authorized
query Parameters
countAppearances
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the number of uses of each tag should be counted. Defaults to false (0).

includeInactive
integer [ 0 .. 1 ]
Default: 0

A boolean indicating inactive tags should be included. Defaults to false (0).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

tags
Array of integers

A list of tagIDs to filter against

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tags": [
    ]
}

Update a tag definition

Authorizations:
authorized
query Parameters
tag
string

A string used as a tag

tagID
integer

The unique ID of a tag

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tagID": 0,
  • "lastUpdate": 9999999999,
  • "created": 9999999999,
  • "creatorID": -2,
  • "disabledBy": -2,
  • "disabledAt": 9999999999,
  • "tag": "string",
  • "active": 1
}

Teams

“Teams” are collections of Users. Users can be associated with zero or more Teams. The Safety Manager or another user with appropriate privilege can manage the collection of Teams that is available within a Subscriber's Locations for their Users.

NOTE: In the product user interfaces, these are usually referred to as 'Teams' but internally they are called 'Groups' for historical reasons.

Add a Team definition

Authorizations:
admin
query Parameters
members
Array of integers (userID) [ items >= -2 ]

The list of members of this group

name
string

The unique name for the group

description
string

Description of the item

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "groupID": 0,
  • "userID": -2,
  • "members": [
    ]
}

Delete a group definition

Authorizations:
admin
query Parameters
groupID
integer

The unique ID for the group

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "groupID": 0
}

Fetch the collection of groups

Authorizations:
authorized
query Parameters
groupID
integer

The unique ID for the group

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

name
string

The unique name for the group

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "groups": [
    ]
}

Update a group definition

Authorizations:
admin
query Parameters
groupID
integer

The unique ID for the group

members
Array of integers (userID) [ items >= -2 ]

The list of members of this group

name
string

The unique name for the group

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "userID": -2,
  • "groupID": 0,
  • "members": [
    ],
  • "locations": [
    ]
}

Watchers

addWatcher @@@ Needs a summary

Authorizations:
authorized
query Parameters
item
string

@@@ Needs a parameter description

type
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "watcherID": 1,
  • "type": "observation",
  • "item": "string",
  • "active": 1,
  • "userID": -2,
  • "creator": -2,
  • "created": 9999999999,
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2
}

deleteWatchers @@@ Needs a summary

Authorizations:
authorized
query Parameters
watchers
Array of integers

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

getWatchers @@@ Needs a summary

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

@@@ Needs a parameter description

items
Array of strings

@@@ Needs a parameter description

types
Array of strings

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "watchers": {
    }
}

updateWatchers @@@ Needs a summary

Authorizations:
authorized
query Parameters
watchers
string

@@@ Needs a parameter description

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Weather

getForecast @@@ Needs a summary

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

@@@ Needs a parameter description

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

locID
integer

@@@ Needs a parameter description

noAuth
integer

@@@ Needs a parameter description

startTime
number
Default: 0

@@@ Needs a parameter description

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

getWeather @@@ Needs a summary

Authorizations:
authorized
query Parameters
endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

@@@ Needs a parameter description

locID
integer

@@@ Needs a parameter description

noAuth
integer

@@@ Needs a parameter description

startTime
number
Default: 0

@@@ Needs a parameter description

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Zones

addZone @@@ Needs a summary

Authorizations:
supervisor
query Parameters
certificationAdds
Array of integers

@@@ Needs a parameter description

certificationExceptions
Array of integers

@@@ Needs a parameter description

containedBy
integer

@@@ Needs a parameter description

Array of objects (assetContent)

A list of content objects to associate with the zone

gearAdds
Array of integers

@@@ Needs a parameter description

gearExceptions
Array of integers

@@@ Needs a parameter description

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

locID
integer

@@@ Needs a parameter description

name
string

@@@ Needs a parameter description

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "zoneID": 0
}

createZone @@@ Needs a summary

Authorizations:
supervisor
query Parameters
certificationAdds
Array of integers

@@@ Needs a parameter description

certificationExceptions
Array of integers

@@@ Needs a parameter description

containedBy
integer

@@@ Needs a parameter description

contentItems
Array of integers

@@@ Needs a parameter description

gearAdds
Array of integers

@@@ Needs a parameter description

gearExceptions
Array of integers

@@@ Needs a parameter description

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

locID
integer

@@@ Needs a parameter description

name
string

@@@ Needs a parameter description

description
string

Description of the item

deviceID
string (deviceID)

Unique Mobile Device ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

deleteZone @@@ Needs a summary

Authorizations:
admin
query Parameters
deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "zoneID": 0
}

getZones @@@ Needs a summary

Authorizations:
authorized
query Parameters
includeDisabled
integer

@@@ Needs a parameter description

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

locID
integer

@@@ Needs a parameter description

deviceID
string (deviceID)

Unique Mobile Device ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "zones": [
    ]
}

updateZone @@@ Needs a summary

Authorizations:
admin
query Parameters
certificationAdds
Array of integers

@@@ Needs a parameter description

certificationExceptions
Array of integers

@@@ Needs a parameter description

containedBy
integer

@@@ Needs a parameter description

Array of objects (assetContent)

A list of content objects to associate with the zone

gearAdds
Array of integers

@@@ Needs a parameter description

gearExceptions
Array of integers

@@@ Needs a parameter description

lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

locID
integer

@@@ Needs a parameter description

name
string

@@@ Needs a parameter description

deviceID
string (deviceID)

Unique Mobile Device ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "zoneID": 0
}

Introduction

The Checks module and subsystem is a complex collection of operations that together allow for the definition of Questions, Question answers, Collections of Questions, and Deployment of Collections so that Responses to the Questions can be gathered.

Checks

Add a check definition

Authorizations:
admin
query Parameters
checkType
integer

The folder ID for the check

identifier
string

@@@ Needs a parameter description

subject
string

An optional subject for the check. Defaults to '' (no specific subject)

isCompliance
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the check is related to compliance. Defaults to 0 - not related

isOperational
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the check is related to operational excellence. Defaults to 0 - not related

operationalDataType
string

The type of operational data the check relates to, if any

readOnly
integer [ 0 .. 1 ]
Default: 0

Read-only for other users

title
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "check": {
    }
}

Delete a check or checks

Authorizations:
admin
query Parameters
checkID
string (checkID)

The ID of the Check

checkType
integer

The folder ID for the check

checks
Array of objects

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Create a duplicate of one or more checks

Authorizations:
admin
query Parameters
checkID
string (checkID)

The ID of the Check

checks
Array of objects

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "checks": {
    }
}

Create a duplicate of one or more checks

Authorizations:
admin
query Parameters
checkID
string (checkID)

The ID of the Check

checks
Array of objects

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Fetch information about checks

Authorizations:
authorized
query Parameters
checkTypes
Array of integers

Check Types to fetch

checks
Array of objects

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeQuestions
integer [ 0 .. 1 ]
Default: 0

Include question definitions in the response

includeRevisions
integer [ 0 .. 1 ]
Default: 0

Include previous revisions of the check in the response

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "checks": {
    },
  • "questions": {
    },
  • "questionOptions": {
    }
}

Update a check or checks

Authorizations:
admin
query Parameters
checkGroups
Array of objects

The set of group definitions for the check

checkID
string (checkID)

The ID of the Check

checkType
integer

The folder ID for the check

subject
string

An optional subject for the check. Defaults to '' (no specific subject)

checks
Array of objects

@@@ Needs a parameter description

forceRevision
integer [ 0 .. 1 ]
Default: 0

Force the revision number to increment

identifier
string

@@@ Needs a parameter description

isCompliance
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the check is related to compliance. Defaults to 0 - not related

isOperational
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the check is related to operational excellence. Defaults to 0 - not related

operationalDataType
string

The type of operational data the check relates to, if any

presentation
string
Enum: "guided" "unordered"

A default style for how the questions are presented

Array of objects (schemas-questionObject)

The collection of questions for the check

readOnly
integer [ 0 .. 1 ]
Default: 0

Read-only for other users

title
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "checks": {
    },
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Deployments

Delete one or more deployments

Authorizations:
supervisor
query Parameters
deploymentID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

The unique ID of a deployment

deployments
Array of strings (UUID) [ items = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

A list of deployment IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Deploy a check

Authorizations:
supervisor
query Parameters
checkID
required
string (checkID)

The ID of the Check

title
required
string

A title for the deployment

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

isLayerOf
string (deploymentID)

The deploymentID of another deployment this inherits from

powerpoints
integer
Default: 0

The number of points a worker will receive for responding

presentationStyle
string
Default: "guided"
Enum: "guided" "unordered"

How the questions are presented

Array of objects (deploymentGroups)

An optional ordered list of groupQuestion objects that reference the checkGroupID to use and optionally an ordered list of questions

requireAllGroups
integer [ 0 .. 1 ]
Default: 1

Boolean indicating if all groups required to have a response before it can be marked as complete. Defaults to 1 (true).

showHistory
integer
Default: 0

How many previous answers to a question should be shown? Defaults to 0 (none).

required
object

The users who can respond to this deployment

required
object

How often the questions should be automatically re-deployed

required
object

The thing or things about which the questions are being asked.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "deploymentID": "string",
  • "deployment": {
    }
}

Fetch deployment definitions

Authorizations:
authorized
query Parameters
checks
Array of strings (checkID)

A list of checkIDs to limit the fetch

deployments
Array of strings (UUID) [ items = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

A list of deployment IDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeRevisions
integer [ 0 .. 1 ]
Default: 0

Include previous revisions of the deployment in the response

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

targetSignatures
Array of strings

A list of targets to search for

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "deployments": {
    }
}

Schedule the responses for a deployment

Authorizations:
supervisor
query Parameters
time
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

A base time in seconds since the epoch to use when deciding what to schedule. Defaults to the current server time.

checks
Array of strings

A list of checkIDs

deploymentID
string

A deploymentID

deployments
Array of strings

A list of deployment IDs

targetSignature
string

A unique isomorphic signature that identifies the target of the response. This is a combination of the target properties of the deployment (e.g., the zone, asset, or userID against which the questions in the response were answered). These are strings, and take the form type:identifier. So, for example, an asset as a target might look like asset:someAssetID, a worker like worker:userID. Also, note that for a place the target is loc:locationID:zoneID.

test
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that we are running in test mode. Defaults to false (0).

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Update the definition of a deployment

Note that either the deploymentID or deployments parameters are required.

Authorizations:
admin
query Parameters
object

The users who can respond to this deployment

deploymentID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

The unique ID of a deployment

deployments
Array of strings (UUID) [ items = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... ]

A list of deployment IDs

forceRevision
integer [ 0 .. 1 ]
Default: 0

Force the revision number to increment

object

How often the questions should be automatically re-deployed

isLayerOf
string (deploymentID)

The deploymentID of another deployment this inherits from

powerpoints
integer
Default: 0

The number points a worker will receive for responding

presentationStyle
string
Enum: "guided" "unordered"

How the questions are presented

Array of objects (deploymentGroups)

An optional ordered list of groupQuestion objects that reference the checkGroupID to use and optionally an ordered list of questions

requireAllGroups
integer [ 0 .. 1 ]
Default: 1

Boolean indicating if all groups required to have a response before it can be marked as complete. Defaults to 1 (true).

showHistory
integer
Default: 0

How many previous answers to a question should be shown? Defaults to 0 (none).

object

The thing or things about which the questions are being asked.

title
string

A title for the deployment

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "deployments": {
    }
}

Questions

Questions are a class of item that are associated with Checks. Once a Question has been answered, it has history. Questions with history can never be edited. Instead, when they are edited a new question is created and is used to replace the uses of the previous question in the various checks. The commands in this section manipulate Questions.

Add a question definition

Authorizations:
admin
query Parameters
allowNA
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the question can be answered with 'NA' - meaning Not Applicable. Defaults to false (0)

checkGroup
string

The group in the check in which this question is contained.

checkID
string

The ID of the check this question relates to.

closingCategory
string

An optional 'closing catetory' that this question maps to if the question fails and raises a Corrective Action. Defaults to '' - no closing category.

This has the format TYPE ':' CATEGORYID, where TYPE is one of the standard observation type names, and CATEGORYID is an ID of a closing category related to that type. See Observations for more information.

closingTags
Array of integers

An option list of tagIDs to associate with the Corrective Action if one is created as a result of a failure.

Array of objects (assetContent)

A list of content objects to associate with the question

Array of objects (assetProperties)

A list of property objects to associate with the question

explanation
string

A description of the question.

helpAvailable
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that there is help associated with this question. Defaults to false (0)

helpContent
string

A message designed to help someone understand the question

importance
integer [ 1 .. 5 ]

The relative importance of this question.

options
Array of strings

A list of question option IDs

showImage
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the associated objects (images) should be shown with the question. Defaults to false (0).

title
string

The long title of the question

type
string (questionType)
Enum: "singleSelect" "multiSelect" "tolerance" "actualMeasurement" "passFail" "textInput" "rangeSlider"

The type of the question.

NOTE: Some question 'types' in the editing user interface are overloaded - the multiple choice type can be single or multi-select, the measurement type can have different types of measurements. While these are bundled together for convenience in the editing interface, they are treated as discrete question types for purposes of processing, presentation, and evaluation by the rest of the product.

value
integer
active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "question": {
    }
}

Add a question option (answer) definition.

Authorizations:
admin
query Parameters
label
string

A short label for the question option

questionID
string

A unique ID for a question

settings
object

The settings object for the question. The schema for this varies depending upon the question type.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "question": {
    }
}

Delete a question definition

Authorizations:
admin
query Parameters
questionID
string

A unique ID for a question

questions
Array of objects

A list of question IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete a question option definition

Authorizations:
admin
query Parameters
optionID
string

A long description for the question (most likely the actual question being asked).

options
Array of strings

A list of question option IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Duplicate one or more question definitions

Authorizations:
admin
query Parameters
questionID
string

A unique ID for a question

questions
Array of objects

A list of question IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "questions": {
    }
}

Get a set of question options

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeRevisions
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the the revisions of a question should be included. Defaults to false (0)

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

optionID
string

A long description for the question (most likely the actual question being asked).

questionID
string

A unique ID for a question

questions
Array of objects

A list of question IDs

revision
string

A question revision ID to use when fetching options

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "questions": { },
  • "option": { }
}

Get a collection of questions

Authorizations:
authorized
query Parameters
checks
Array of strings

A list of one or more checkIDs to filter by

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeRevisions
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the the revisions of a question should be included. Defaults to false (0)

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

questions
Array of objects

A list of question IDs

types
Array of strings (questionType)
Items Enum: "singleSelect" "multiSelect" "tolerance" "actualMeasurement" "passFail" "textInput" "rangeSlider"

A list of question types to filter against

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "questions": {
    }
}

Update a question definition

Authorizations:
admin
query Parameters
allowNA
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the question can be answered with 'NA' - meaning Not Applicable. Defaults to false (0)

checkGroup
string

The group in the check in which this question is contained.

checkID
string

The ID of the check this question relates to.

closingCategory
string

An optional 'closing catetory' that this question maps to if the question fails and raises a Corrective Action. Defaults to '' - no closing category.

This has the format TYPE ':' CATEGORYID, where TYPE is one of the standard observation type names, and CATEGORYID is an ID of a closing category related to that type. See Observations for more information.

closingTags
Array of integers

An option list of tagIDs to associate with the Corrective Action if one is created as a result of a failure.

Array of objects (assetContent)

A list of content objects to associate with the question

Array of objects (assetProperties)

A list of property objects to associate with the question

explanation
string

A description of the question.

forceRevision
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that a new revision must be created. Defaults to false (0).

helpAvailable
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that there is help associated with this question. Defaults to false (0)

helpContent
string

A message designed to help someone understand the question

importance
integer [ 1 .. 5 ]

The relative importance of this question.

options
Array of strings

A list of question option IDs

questionID
string

A unique ID for a question

questions
Array of objects

A list of question IDs

showImage
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if the associated objects (images) should be shown with the question. Defaults to false (0).

title
string

The long title of the question

type
string (questionType)
Enum: "singleSelect" "multiSelect" "tolerance" "actualMeasurement" "passFail" "textInput" "rangeSlider"

The type of the question.

NOTE: Some question 'types' in the editing user interface are overloaded - the multiple choice type can be single or multi-select, the measurement type can have different types of measurements. While these are bundled together for convenience in the editing interface, they are treated as discrete question types for purposes of processing, presentation, and evaluation by the rest of the product.

value
integer
active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "questions": {
    },
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update a question option

Authorizations:
admin
query Parameters
forceRevision
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that a new revision must be created. Defaults to false (0).

label
string

A short label for the question option

optionID
string

A long description for the question (most likely the actual question being asked).

questionID
string

A unique ID for a question

settings
object

The settings object for the question. The schema for this varies depending upon the question type.

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Responses

Once checks are deployed, they have a schedule and set of targets. Scheduled checks for a target are defined as a deployment for which the defined start time has passed, and for which the defined availability window has not expired. For example, a deployment of a check against a fire extinguisher that is to be run daily at 06:00 becomes available at 06:00 (local time). If that check does not have a specified window, then it is available until 5 minutes before the NEXT scheduled run. Otherwise, it is available only until that window expires (e.g., 2 hours) after which the deployment is said to have been 'missed'. A deployment that is started but not completed during the window is said to be 'notCompleted'.

Responses to checks are made against specific deployments. Each response is a unique tuple of deploymentID, status, and targetSignature. Specifically, only a single response (or group of responses for a "grouped check") can be available or inProgress for a deployment against a target.

Add an issue to a response

A response issue is a comment that is attached to a response by the responder, typically related to validation of a positive or negative result. It is NOT an observation and does not result in a corrective action being created.

Authorizations:
authorized
query Parameters
lat
number [ -90 .. 90 ]

The GPS latitude when the operation occurred.

lon
number [ -180 .. 180 ]

The GPS longitude where the operation occurred.

Array of objects

A list of note objects to attach

questionID
string

The questionID to which to associate the issue.

responseID
string

A unique ID associated with a response

uuid
string

A unique ID for the issue - supplied by the client when operating offline.

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "question": {
    }
}

Add a note to a response issue

Authorizations:
authorized
query Parameters
UUID (string) or integer (IDorUUID)

The issue ID to which to attach the note.

object

The note to attach

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Mark all responses of a grouped check as being complete.

Authorizations:
authorized
query Parameters
deploymentID
string

A deploymentID

instanceID
string

A response instance ID

noReschedule
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the response should not be automatically rescheduled against its deployment definition rules. Defaults to false (0).

responseID
string

A unique ID associated with a response

targetSignature
string

A unique isomorphic signature that identifies the target of the response. This is a combination of the target properties of the deployment (e.g., the zone, asset, or userID against which the questions in the response were answered). These are strings, and take the form type:identifier. So, for example, an asset as a target might look like asset:someAssetID, a worker like worker:userID. Also, note that for a place the target is loc:locationID:zoneID.

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Mark a response as being complete

Authorizations:
authorized
query Parameters
deploymentID
string

A deploymentID

instanceID
string

A response instance ID

noReschedule
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the response should not be automatically rescheduled against its deployment definition rules. Defaults to false (0).

responseID
string

A unique ID associated with a response

targetSignature
string

A unique isomorphic signature that identifies the target of the response. This is a combination of the target properties of the deployment (e.g., the zone, asset, or userID against which the questions in the response were answered). These are strings, and take the form type:identifier. So, for example, an asset as a target might look like asset:someAssetID, a worker like worker:userID. Also, note that for a place the target is loc:locationID:zoneID.

object

A collection of lists of property events keyed by question ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Create a new response

Authorizations:
authorized
query Parameters
newInstanceID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A unique instance UUID to use when creating the response(s). This is generated by a client to ensure smooth offline operation.

newResponseID
string (UUID) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A unique response UUID to use when creating the response(s). This is generated by a client to ensure smooth offline operation.

responseID
string

A unique ID associated with a response

isAnonymous
integer [ 0 .. 1 ]
Default: 0

The operation should be anonymous.

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "response": {
    }
}

Get a collection of responses

Note that this method is mis-named, since through parameters you can get any responses, not only those that are available

Authorizations:
authorized
query Parameters
object

A set of assignment criteria to filter against

changesOnly
integer [ 0 .. 1 ]
Default: 0

A boolean indicating only items that have changed since lastRequest should be returned. Defaults to false (0).

checks
Array of strings

A list of checkIDs

deployments
Array of strings

A list of deployment IDs

signatures
Array of strings

An optional array of targetSignatures to filter by

endTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The end of a timespan in seconds since the epoch

excludeExpired
integer [ 0 .. 1 ]
Default: 0

A boolean indicating expired items should be excluded from the response. Defaults to false (0).

explicitAssignment
integer [ 0 .. 1 ]
Default: 0

A boolean indicating only responses that are explicitly assigned to a user should be returned. Defaults to false (0).

includeLastCompletions
integer [ 0 .. 1 ]
Default: 0

A boolean indicating at least one completed or skipped response for each deployment/target combination should be included. Defaults to false(0)

includeAnswers
integer [ 0 .. 1 ]
Default: 0

A boolean indicating answers to completed questions should be inclued. Defaults to false (0).

includeHistory
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the history or previous answers to completed questions should be included. Defaults to false (0).

includeIssues
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that Response Issues should be included. Defaults to false (0).

includeQuestions
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that Questions and Question Options should be included. Defaults to false (0).

incremental
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that this is an incremental request. Defaults to false (0).

isVisibleTo
integer

A userID to which the responses must be visible in order to be returned.

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

limit
integer

The maximum number of responses to fetch. Defaults to unlimited (0).

omit
Array of strings

A list of responseIDs to omit.

owners
Array of integers

A list of userIDs to filter the owners against.

responses
Array of strings

A list of response IDs

startAfter
integer

Start returning items after the Nth item in the list. Deaults to 0, meaning the first item.

startTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The beginning of a timespan in seconds since the epoch

status
Array of strings (responseStatus)
Items Enum: "onDemand" "available" "pending" "inProgress" "complete" "groupsCompleted" "skipped" "notCompleted" "missed"

A list of responses status values to match against

object

A set of target filters

trim
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that default values can be trimmed out of the response to reduce the size of the payload. Defaults to false (0).

useUpdateTime
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that the updateTime of the response should be used for filtering, rather than the creation time. Defaults to false (0).

locationID
required
integer (schemas-locationID) >= 0

Location ID

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "numResponses": 0,
  • "lastResponse": 0,
  • "removed": { },
  • "responses": {
    },
  • "questions": {
    },
  • "questionOptions": {
    }
}

Get a collection of response issues

Authorizations:
authorized
query Parameters
assets
Array of integers (assetList) [ items >= 1 ]

Assets against which to filter.

checks
Array of strings

A list of checkIDs

creators
Array of integers (schemas-userList) [ items >= -2 ]

A list of creator userIDs against which to filter.

deployments
Array of strings

A list of deployment IDs

issues
Array of integers

A list of issue IDs

questions
Array of strings

A list of question IDs to filter against

responses
Array of strings

A list of response IDs

signatures
Array of strings

A list of target signatures against which to filter.

states
Array of strings (responseStatus)
Items Enum: "onDemand" "available" "pending" "inProgress" "complete" "groupsCompleted" "skipped" "notCompleted" "missed"

A list of response states against which to filter.

workers
Array of integers (schemas-userList) [ items[ items >= -2 ] ]

A list of worker IDs against which to filter.

zones
Array of integers (schemas-userList) [ items >= -2 ]

A list of zone IDs against which to filter.

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Set a response to be anonymous

Authorizations:
authorized
query Parameters
responseID
string

A unique ID associated with a response

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "response": {
    }
}

Record one or more responses

Authorizations:
authorized
query Parameters
responseID
string

A unique ID associated with a response

responses
Array of strings

A list of response IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

zoneID
integer (zoneID) >= 0

Zone ID

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Skip a response

Authorizations:
authorized
query Parameters
noReschedule
integer [ 0 .. 1 ]
Default: 0

A boolean indicating the response should not be automatically rescheduled against its deployment definition rules. Defaults to false (0).

responseID
string

A unique ID associated with a response

responses
Array of strings

A list of response IDs

skipAll
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that all the related check groups should be skipped. Defaults to false (0).

skipNotes
object

A list of note objects for objects related to the reason for skipping the response.

skipReason
integer

An ID of a reason for skipping the response (from the collection of skip reasons).

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Start a response

Mark a response as inProgress if it has not already been started by another user.

Authorizations:
authorized
query Parameters
responseID
string

A unique ID associated with a response

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

userID
integer (userID) >= -2

A user identifier

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Change the assignees for a response.

Authorizations:
supervisor
query Parameters
redeploy
integer [ 1 .. 3 ]
Default: 0

A flag indicating how any inProgress responses should be dealt with. 1 means transfer to the new assignee, 2 means mark as Not Completed and redeploy. 3 means marn as Abandoned and redeploy. Defaults to 1.

object

The user/team to whom the responses are being assigned. If this parameter is NOT supplied and the redeploy parameter is supplied, the check is redeployed to the original assignees.

responseID
string

A unique ID associated with a response

responses
Array of strings

A list of response IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Wristbands

addWristband @@@ Needs a summary

Authorizations:
supervisor
query Parameters
alertID
string

@@@ Needs a parameter description

major
integer

@@@ Needs a parameter description

minor
integer

@@@ Needs a parameter description

pid
integer

@@@ Needs a parameter description

status
string

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "row": 0,
  • "wristband": {
    }
}

deleteWristband @@@ Needs a summary

Authorizations:
authorized
query Parameters
alertID
string

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

deregisterWristband @@@ Needs a summary

Authorizations:
authorized
query Parameters
alertID
string

@@@ Needs a parameter description

pid
integer

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

getWristbands @@@ Needs a summary

Authorizations:
authorized
query Parameters
alertID
string

@@@ Needs a parameter description

devices
Array of strings

@@@ Needs a parameter description

status
Array of strings

@@@ Needs a parameter description

locationID
required
integer (schemas-locationID) >= 0

Location ID

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

users
Array of integers (userID) [ items >= -2 ]

An array of userIDs

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "wristbands": {
    }
}

registerWristband @@@ Needs a summary

Authorizations:
authorized
query Parameters
alertID
string

@@@ Needs a parameter description

pid
integer

@@@ Needs a parameter description

replaces
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

updateEncounters @@@ Needs a summary

Authorizations:
authorized
query Parameters
encounters
Array of objects

@@@ Needs a parameter description

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Task Types

Add a task relation type (unimplemented)

Authorizations:
global-admin
query Parameters
title
string

A title for the item

description
string

Description of the item

object (translatedTerms)

Translations for title and description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Add a task type definition

Authorizations:
global-admin
query Parameters
name
string

The name for a task type

reserved
integer [ 0 .. 1 ]
Default: 0

A boolean indicating if this task type is reserved. Defaults to false (0).

states
Array of integers (taskStateID) [ items >= 1 ]

An ordered list of states a task type supports

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations for terms name and description

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "typeID": 1
}

Delete a task relation definition (unimplemented)

Authorizations:
global-admin
query Parameters
relationID
integer (taskRelationID) >= 1
sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete one or more task type definitions

Authorizations:
global-admin
query Parameters
typeID
integer (taskTypeID) >= 1

The ID of a task type

types
Array of integers (taskTypeID) [ items >= 1 ]

A list of task type IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get the collection of task types

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

types
Array of integers (taskTypeID) [ items >= 1 ]

A list of task type IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "taskTypes": {
    }
}

Update a task type or types

Authorizations:
global-admin
query Parameters
name
string

The name for a task type

states
Array of integers (taskStateID) [ items >= 1 ]

An ordered list of states a task type supports

typeID
integer (taskTypeID) >= 1

The ID of a task type

object

A collection of task type objects keyed by taskTypeID

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations for terms name and description

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Task States

Add task state definition

Authorizations:
global-admin
query Parameters
category
string (category)
Enum: "todo" "inProgress" "done"

The category of a task state

color
string

The color associated with this task state

name
string

The name for a task type

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations for terms name and description

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "stateID": 1
}

Delete a one or more state definitions

Authorizations:
global-admin
query Parameters
stateID
integer (taskStateID) >= 1

The ID of a task state

states
Array of integers (taskStateID) [ items >= 1 ]

A list of task states

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get the collection of task states

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

states
Array of integers (taskStateID) [ items >= 1 ]

A list of task states

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "taskStates": {
    }
}

Update a task state or states

Authorizations:
global-admin
query Parameters
category
string (category)
Enum: "todo" "inProgress" "done"

The category of a task state

color
string

The color associated with this task state

name
string

The name for a task type

stateID
integer (taskStateID) >= 1

The ID of a task state

object

A collection of task state objects keyed by taskStateID

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations for terms name and description

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Task Notes

Add a note to a task

Authorizations:
authorized
query Parameters
subtype
string

A subtype of the task

taskID
integer (taskID) >= 1

A unique task ID

type
string (The type of the note)
Enum: "text" "audio" "video" "image"

A type for the note

value
string

A value for the note

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "noteID": 1
}

Delete a task note

Authorizations:
authorized
query Parameters
noteID
integer (taskNoteID) >= 1

A unique ID of a task note

notes
Array of integers (taskNoteID) [ items >= 1 ]

A list of task notes objects

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get task notes

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

noteID
integer (taskNoteID) >= 1

A unique ID of a task note

notes
Array of integers (taskNoteID) [ items >= 1 ]

A list of task notes objects

taskID
integer (taskID) >= 1

A unique task ID

tasks
Array of integers (taskID) [ items >= 1 ]

A list of task IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "notes": {
    }
}

Update a task note or notes

Authorizations:
authorized
query Parameters
noteID
integer (taskNoteID) >= 1

A unique ID of a task note

notes
Array of integers (taskNoteID) [ items >= 1 ]

A list of task notes objects

sentiment
number
Default: 0

The calculated sentiment of the note content

subtype
string

A subtype of the task

type
string (The type of the note)
Enum: "text" "audio" "video" "image"

A type for the note

value
string

A value for the note

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Task Operations

Add a task

Authorizations:
authorized
query Parameters
assignedTo
Array of strings

@@@ Needs a parameter description

images
Array of integers (a unique ID of an object in the objectMap table)

An array of objectIDs

dueBy
integer

A time in seconds since the epoch when the task is due to be completed.

estimatedTime
string

An estimate of how long this task should take

folderID
integer

The folder in which this item is stored

message
string

A custom message to send when notifying someone of the assignment

parentID
string

The ID of an associated parent within parentType, if any. Defaults to an empty string (no parent).

parentType
string

The type of an associated parent object within the system. Defaults tp an empty tring (no parent).

Array of objects (taskRelationship)

A list of task relationships

state
integer (taskStateID) >= 1

The state of the task

title
string

A title for the item

type
string (The type of the note)
Enum: "text" "audio" "video" "image"

A type for the note

description
string

Description of the item

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "taskID": 1
}

Assign a task or tasks

Authorizations:
authorized
query Parameters
assignedTo
Array of strings

@@@ Needs a parameter description

taskID
integer (taskID) >= 1

A unique task ID

tasks
Array of integers (taskID) [ items >= 1 ]

A list of task IDs

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete a task

Authorizations:
authorized
query Parameters
taskID
integer (taskID) >= 1

A unique task ID

tasks
Array of integers (taskID) [ items >= 1 ]

A list of task IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of tasks

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

includeHistory
integer [ 0 .. 1 ]
Default: 0

A boolean indicating that the history of the tasks should be included. Defaults to false (0).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

parents
Array of strings

A list of parent signatures (unimplemented)

parentTypes
Array of strings

A list of parent types

states
Array of integers (taskStateID) [ items >= 1 ]

A list of task states

taskID
integer (taskID) >= 1

A unique task ID

tasks
Array of integers (taskID) [ items >= 1 ]

A list of task IDs

types
Array of integers (taskTypeID) [ items >= 1 ]

A list of task type IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "tasks": {
    }
}

Update a task or tasks

Authorizations:
authorized
query Parameters
assignedTo
Array of strings

@@@ Needs a parameter description

dueBy
integer

A time in seconds since the epoch when the task is due to be completed.

estimatedTime
string

An estimate of how long this task should take

folderID
integer

The folder in which this item is stored

Array of objects (taskRelationship)

A list of task relationships

state
integer (taskStateID) >= 1

The state of the task

taskID
integer (taskID) >= 1

A unique task ID

tasks
Array of integers (taskID) [ items >= 1 ]

A list of task IDs

title
string

A title for the item

description
string

Description of the item

queuedTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time at which the request was originally queued in seconds since the epoch (implies offline).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

PDCA Operations

PDCAs (Plan, Do, Check, Act) are items that have a lifecycle and are potentially linked to other objects in the system. The commands in this section manipulate PDCA objects.

Add a PDCA

Authorizations:
supervisor
query Parameters
access
string
Enum: "private" "shared"

The access type of the PDCA. Defaults to 'shared'.

folderID
integer

The folder in which this item is stored

Array of objects (schema)

A list of items to include in a PDCA

owner
integer

The userID of the PDCA Owner

previousPDCA
integer

The ID of a previous iteration of this PDCA

readOnly
integer [ 0 .. 1 ]
Default: 0

Is the item readOnly (defaults to 0 - not readOnly).

title
string

A title for the PDCA

debug
integer [ 0 .. 1 ]

Debug mode - defaults to 0 (disabled)

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

nodeSelections
Array of strings

An array of node or location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "pdcaID": 1
}

Approve a PDCA

Authorizations:
supervisor
query Parameters
note
string

A note to associate with a PDCA

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Complete a PDCA

Authorizations:
authorized
query Parameters
pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Delete a PDCA

Authorizations:
supervisor
query Parameters
pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

pdcas
Array of integers (pdcaID) [ items >= 1 ]

A list of PDCA IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of PDCAs

Authorizations:
authorized
query Parameters
includeCauses
integer [ 0 .. 1 ]
Default: 0

Boolean to include the associated potential causes. Defaults to false (0).

includeHistory
integer [ 0 .. 1 ]
Default: 0

Boolean to include the associated history of the PDCA. Defaults to false (0).

includeItems
integer [ 0 .. 1 ]
Default: 0

Boolean to include the associated Items. Defaults to false (0).

includeReplies
integer [ 0 .. 1 ]
Default: 0

Boolean to include the associated replies. Defaults to false (0).

includeTasks
integer [ 0 .. 1 ]
Default: 0

Boolean to include the assocated tasks. Defaults to false (0).

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

pdcas
Array of integers (pdcaID) [ items >= 1 ]

A list of PDCA IDs

states
Array of strings

Limit the collection to PDCAs in one of these states

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "pdcas": {
    }
}

Reject a PDCA

Authorizations:
authorized
query Parameters
copyType
string
Enum: "blank" "plan"

The type of copy to make of the PDCA

note
string

A note to associate with a PDCA

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Update a PDCA

Authorizations:
supervisor
query Parameters
access
string
Enum: "private" "shared"

The access type of the PDCA. Defaults to 'shared'.

checkNote
string

The text of a note about checking the PDCA

checkResult
string

The result of checking the PDCA

folderID
integer

The folder in which this item is stored

mostImportantCause
integer

The causeID of the most important potential cause

nodeSelections
Array of strings

An array of node or location IDs

owner
integer

The userID of the PDCA Owner

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

planActivity
string

An explanation if the Containment Activity

planAssets
Array of integers (assetID) [ items >= 1 ]

A list of assetIDs associated with this Plan

planUsers
Array of integers (userID) [ items >= -2 ]

A list of userIDs associatd with this Plan

planZones
Array of integers (zoneID) [ items >= 0 ]

A list of zoneIDs associated with this Plan

readOnly
integer [ 0 .. 1 ]
Default: 0

Is the item readOnly (defaults to 0 - not readOnly).

tagIDs
Array of integers (tagID) [ items >= 0 ]

A list of tagIDs for this Plan

title
string

A title for the PDCA

description
string

Description of the item

locations
Array of integers (schemas-locationID) [ items >= 0 ]

An array of location IDs

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Update information about the Phase

Authorizations:
authorized
query Parameters
pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

state
string
Enum: "plan" "do" "check" "act"

The current state of the PDCA

status
string
Enum: "start" "complete" "continue"

The status the phase should move into. Values include 'start', 'complete', and 'continue'. Default is 'continue'. Using a state of 'continue' will clear the '*CompleteAt' and '*CompleteBy' if they were set.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

PDCA Items

Add an item to a PDCA

Authorizations:
authorized
query Parameters
object

An item to include in a PDCA

Array of objects (schema)

A list of items to include in a PDCA

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

type
string

The type of the note

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Delete an Item from a PDCA

Authorizations:
authorized
query Parameters
itemID
integer (pdcaItemID) >= 1

The ID of an item within a PDCA

Array of objects (schema)

A list of items to include in a PDCA

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of PDCA Items

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

itemID
integer (pdcaItemID) >= 1

The ID of an item within a PDCA

Array of objects (schema)

A list of items to include in a PDCA

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

pdcas
Array of integers (pdcaID) [ items >= 1 ]

A list of PDCA IDs

types
string

A list of types

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "items": {
    }
}

Update a PDCA item or items

Authorizations:
authorized
query Parameters
object

An item to include in a PDCA

itemID
integer (pdcaItemID) >= 1

The ID of an item within a PDCA

Array of objects (schema)

A list of items to include in a PDCA

type
string

The type of the note

value
string

The text for a note when it is not a separate object

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

PDCA Notes

Add a note to a PDCA

Authorizations:
supervisor
query Parameters
pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

subtype
string

The subtype of the note

type
string

The type of the note

value
string

The text for a note when it is not a separate object

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "noteID": 1
}

Delete a note from a PDCA

Authorizations:
supervisor
query Parameters
noteID
integer

The ID of a PDCA Note

notes
Array of integers (noteID-schema)

A list of PDCA Note IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of PDCA Notes

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

noteID
integer

The ID of a PDCA Note

notes
Array of integers (noteID-schema)

A list of PDCA Note IDs

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

pdcas
Array of integers (pdcaID) [ items >= 1 ]

A list of PDCA IDs

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "notes": {
    }
}

Update a PDCA Note

Authorizations:
supervisor
query Parameters
noteID
integer

The ID of a PDCA Note

notes
Array of integers (noteID-schema)

A list of PDCA Note IDs

number or null (sentiment)

The calculated sentiment of the note

subtype
string

The subtype of the note

type
string

The type of the note

value
string

The text for a note when it is not a separate object

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Causes

Add a potential cause to a PDCA

Authorizations:
supervisor
query Parameters
pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

type
string

The type of the note

why
Array of strings

A list of 'whys' associated with the PDCA

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "causeID": 1
}

Delete a Cause from a PDCA

Authorizations:
supervisor
query Parameters
causeID
integer (causeID) >= 1

The unique ID of a potential cause definition

causes
Array of integers (causeID) [ items >= 1 ]

A list of potential cause IDs

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of causes

Authorizations:
authorized
query Parameters
causeID
integer (causeID) >= 1

The unique ID of a potential cause definition

causes
Array of integers (causeID) [ items >= 1 ]

A list of potential cause IDs

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

pdcaID
integer (pdcaID) >= 1

The unique ID of the PDCA

pdcas
Array of integers (pdcaID) [ items >= 1 ]

A list of PDCA IDs

types
string

A list of types

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "causes": {
    }
}

Update a PDCA Cause

Authorizations:
authorized
query Parameters
causeID
integer (causeID) >= 1

The unique ID of a potential cause definition

causes
Array of integers (causeID) [ items >= 1 ]

A list of potential cause IDs

type
string

The type of the note

why
Array of strings

A list of 'whys' associated with the PDCA

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Cause Types

Add a potential cause definition

Authorizations:
global-admin
query Parameters
name
string

The name of the PDCA

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "typeID": 1
}

Delete a Cause Type definition

Authorizations:
admin
query Parameters
typeID
integer

A Potential Cause Type ID

types
string

A list of types

deviceID
string (deviceID)

Unique Mobile Device ID

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Get a collection of Cause Types

Authorizations:
authorized
query Parameters
includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

types
string

A list of types

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "causeTypes": {
    }
}

Update a Cause Type definition

Authorizations:
global-admin
query Parameters
name
string

The name of the PDCA

typeID
integer

A Potential Cause Type ID

types
string

A list of types

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

description
string

Description of the item

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

object (translatedTerms)

Translations of terms into supported languages

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string"
}

Workflows

Workflow Terms

getTerms @@@ Needs a summary

Authorizations:
authorized
query Parameters
lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

module
string

@@@ Needs a parameter description

modules
Array of strings

@@@ Needs a parameter description

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

updateTerms @@@ Needs a summary

Authorizations:
global-admin
query Parameters
module
string

@@@ Needs a parameter description

terms
string

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "statusText": "string",
  • "timestamp": 9999999999
}

Workflow Types

External Sources

addExternalSource @@@ Needs a summary

Authorizations:
staff
query Parameters
attributes
string

@@@ Needs a parameter description

name
string

@@@ Needs a parameter description

sourceType
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

folderID
integer

The folder in which this item is stored

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "sourceID": 1,
  • "uuid": "string",
  • "sourceType": "erdmanPLC",
  • "folderID": 0,
  • "locationID": 0,
  • "active": 1,
  • "gatewayID": "string",
  • "name": "string",
  • "attributes": {
    },
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "addedAt": 9999999999,
  • "addedBy": -2
}

deleteExternalSource @@@ Needs a summary

Authorizations:
staff
query Parameters
sourceID
integer

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "gatewayID": 0
}

getExternalSources @@@ Needs a summary

Authorizations:
staff
query Parameters
sourceID
integer

@@@ Needs a parameter description

sources
Array of integers

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "sources": {
    },
  • "items": {
    }
}

updateExternalSource @@@ Needs a summary

Authorizations:
staff
query Parameters
attributes
string

@@@ Needs a parameter description

name
string

@@@ Needs a parameter description

sourceID
integer

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

folderID
integer

The folder in which this item is stored

locationID
required
integer (schemas-locationID) >= 0

Location ID

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "sourceID": 1,
  • "uuid": "string",
  • "sourceType": "erdmanPLC",
  • "folderID": 0,
  • "locationID": 0,
  • "active": 1,
  • "gatewayID": "string",
  • "name": "string",
  • "attributes": {
    },
  • "lastUpdate": 9999999999,
  • "disabledAt": 9999999999,
  • "disabledBy": -2,
  • "addedAt": 9999999999,
  • "addedBy": -2
}

External Items

addExternalItem @@@ Needs a summary

Authorizations:
staff
query Parameters
attributes
string

@@@ Needs a parameter description

label
string

@@@ Needs a parameter description

published
integer

@@@ Needs a parameter description

sourceType
string

@@@ Needs a parameter description

uniqueName
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

folderID
integer

The folder in which this item is stored

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "itemID": 1,
  • "uuid": "string",
  • "folderID": 0,
  • "uniqueName": "string",
  • "label": "string",
  • "sourceType": "erdmanPLC",
  • "active": 1,
  • "published": 1,
  • "attributes": {
    }
}

deleteExternalItem @@@ Needs a summary

Authorizations:
staff
query Parameters
itemID
integer

@@@ Needs a parameter description

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "itemID": 1
}

getExternalItems @@@ Needs a summary

Authorizations:
staff
query Parameters
itemID
integer

@@@ Needs a parameter description

items
Array of integers

@@@ Needs a parameter description

types
Array of strings

@@@ Needs a parameter description

includeDisabled
integer [ 0 .. 1 ]
Default: 0

Include matching items even if they were previously disabled (deleted). Defaults to 0 (do not include).

lastRequest
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client last sent this request in seconds since the epoch. When not supplied, defaults 0 (never).

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "items": {
    }
}

updateExternalItem @@@ Needs a summary

Authorizations:
staff
query Parameters
attributes
string

@@@ Needs a parameter description

itemID
integer

@@@ Needs a parameter description

label
string

@@@ Needs a parameter description

published
integer

@@@ Needs a parameter description

sourceType
string

@@@ Needs a parameter description

uniqueName
string

@@@ Needs a parameter description

active
integer [ 0 .. 1 ]
Default: 0

Is item active (available for use)

folderID
integer

The folder in which this item is stored

sendTime
integer (schemas-timestamp) [ 0 .. 9999999999 ]
Default: 0

The time the client sent the request in seconds since the epoch. When not supplied, defaults to the current time on the API server.

subscriberID
required
integer (subscriberID) >= 0

Subscriber ID to use

token
required
string

The active session token

Responses

Response samples

Content type
application/json
{
  • "timestamp": 9999999999,
  • "status": "OK",
  • "statusText": "string",
  • "itemID": 1,
  • "uuid": "string",
  • "folderID": 0,
  • "uniqueName": "string",
  • "label": "string",
  • "sourceType": "erdmanPLC",
  • "active": 1,
  • "published": 1,
  • "attributes": {
    }
}