Skip to main content
PUT
Update the current user’s runtime

Authorizations

JSESSIONID
string
cookie
required

Body

application/json

The data transfer object that contains all possible runtime properties to be updated

RuntimeDto Model

displayName
string

The display name

Example:

"Entity display name"

version
string

The runtime’s version

Example:

"4.1.1"

attributes
object

Response

OK

The data model that contains the possible runtime properties. Some properties come on a ULM entity by default. Service providers can create and add their own additional properties in order to extend the ULM platform.

activatedDate
integer<int64>

The entity’s activation date and time, expressed in UNIX Epoch time

Example:

1514766808000

attributes
object

Runtime Response Attributes

buildType
string

The customer-defined build type of this specific runtime. This can be used to discriminate between known beta versus production hardware.

Example:

"Production"

createdDate
integer<int64>

The entity’s creation date and time in UNIX Epoch time

Example:

1538682581776

deactivatedDate
integer<int64>

The entity’s deactivation date and time, expressed in UNIX Epoch time

Example:

1543833950000

deviceType
string

The runtime’s type of physical device

Example:

"phone"

displayName
string

The display name of the entity

Example:

"Paul's iPad"

guid
string

The global unique identifier of the runtime provided at login. If this is not provided by the customer, ULM will assign one for tracking purposes.

Example:

"DEF123"

id
integer<int64>

The unique ID of an entity.

Example:

1

platformType
string

The runtime’s platform type

Example:

"android"

status
enum<string>

The status of the entity. Possible values include:

  • activating - The entity has been provisioned, but is not yet ready to be used or consumed.
  • activated - The entity is active, and the functionality to which it is tied is enabled.
  • suspended - The entity is temporarily deactivated, but can be reactivated in the future.
  • deactivated - The entity is permanently deactivated, and may be deleted from the system in the near future.
  • pending - The entity has been added but is not yet verified for use. It may be linked to an existing entity in order to eventually replace the original entity.
  • unknown - This is a generic, catch all state for specific entities.

Note: This field is the current status in GET calls, and the desired status in PUT and POST calls.

Available options:
activating,
activated,
suspended,
deactivated,
pending,
unknown
Example:

"activated"

suspendedDate
integer<int64>

The entity’s suspension date and time, expressed in UNIX Epoch time

Example:

1527917430000

type
string

A particular type of a given entity.

Example:

"com.uxpsystems.ulm.entity.RegularEntityType"

updatedDate
integer<int64>

The most recent date and time that the entity was updated, expressed in UNIX Epoch time

Example:

1538682581776

userAgent
string

The runtime’s browser and operating system information

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"

version
string

The runtime’s version

Example:

"4.1.1"