curl --request PUT \
--url https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime \
--header 'Content-Type: application/json' \
--cookie JSESSIONID= \
--data '
{
"displayName": "Entity display name",
"version": "4.1.1",
"attributes": {
"macAddress": "<string>",
"externalDeviceGUID": "<string>"
}
}
'import requests
url = "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime"
payload = {
"displayName": "Entity display name",
"version": "4.1.1",
"attributes": {
"macAddress": "<string>",
"externalDeviceGUID": "<string>"
}
}
headers = {
"cookie": "JSESSIONID=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'JSESSIONID=', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: 'Entity display name',
version: '4.1.1',
attributes: {macAddress: '<string>', externalDeviceGUID: '<string>'}
})
};
fetch('https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => 'Entity display name',
'version' => '4.1.1',
'attributes' => [
'macAddress' => '<string>',
'externalDeviceGUID' => '<string>'
]
]),
CURLOPT_COOKIE => "JSESSIONID=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime"
payload := strings.NewReader("{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "JSESSIONID=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime")
.header("cookie", "JSESSIONID=")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'JSESSIONID='
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"activatedDate": 1514766808000,
"attributes": {
"macAddress": "000000000001A0",
"externalDeviceGUID": "<string>"
},
"buildType": "Production",
"createdDate": 1538682581776,
"deactivatedDate": 1543833950000,
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": 1527917430000,
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": 1538682581776,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"version": "4.1.1"
}{
"fieldErrors": [
{
"field": "<string>",
"code": "<string>",
"code_v2": "length",
"message": "length must be between 0 and 255",
"rejectedValue": "a string that contains more than 255 characters"
}
],
"operationErrors": [
{
"code": "missing-or-invalid-input-field",
"message": "GUID not present in request, provide GUID in login request"
}
]
}{
"operationError": {
"code": "<string>",
"message": "Bad user input",
"type": "<string>",
"authorities": [
"<string>"
]
},
"stackTrace": "<string>",
"operationErrors": [
{
"code": "authentication-required",
"message": "Full Authentication Required"
}
]
}{
"operationError": {
"code": "<string>",
"message": "Bad user input",
"type": "<string>",
"authorities": [
"<string>"
]
},
"stackTrace": "<string>",
"operationErrors": [
{
"code": "ACCESS_FORBIDDEN",
"message": "Access Denied"
}
]
}{
"operationErrors": [
{
"code": "restClientRuntime-not-found",
"message": "Information for the following resource was not found: com.uxpsystems.mint.framework.device.model.RestClientRuntime[id:909]"
}
]
}Update the current user’s runtime
Changes the Connect runtime information for the current runtime specified by the user’s open session. The runtime entity is updated according to the details in the request. Thhe updated runtime, including its properties and attributes, is returned in the response.
curl --request PUT \
--url https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime \
--header 'Content-Type: application/json' \
--cookie JSESSIONID= \
--data '
{
"displayName": "Entity display name",
"version": "4.1.1",
"attributes": {
"macAddress": "<string>",
"externalDeviceGUID": "<string>"
}
}
'import requests
url = "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime"
payload = {
"displayName": "Entity display name",
"version": "4.1.1",
"attributes": {
"macAddress": "<string>",
"externalDeviceGUID": "<string>"
}
}
headers = {
"cookie": "JSESSIONID=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'JSESSIONID=', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: 'Entity display name',
version: '4.1.1',
attributes: {macAddress: '<string>', externalDeviceGUID: '<string>'}
})
};
fetch('https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => 'Entity display name',
'version' => '4.1.1',
'attributes' => [
'macAddress' => '<string>',
'externalDeviceGUID' => '<string>'
]
]),
CURLOPT_COOKIE => "JSESSIONID=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime"
payload := strings.NewReader("{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "JSESSIONID=")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime")
.header("cookie", "JSESSIONID=")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://nxt-ulm-pdt.m1amdocs.io/platform/rest/v85/runtime")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'JSESSIONID='
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"Entity display name\",\n \"version\": \"4.1.1\",\n \"attributes\": {\n \"macAddress\": \"<string>\",\n \"externalDeviceGUID\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"activatedDate": 1514766808000,
"attributes": {
"macAddress": "000000000001A0",
"externalDeviceGUID": "<string>"
},
"buildType": "Production",
"createdDate": 1538682581776,
"deactivatedDate": 1543833950000,
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": 1527917430000,
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": 1538682581776,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"version": "4.1.1"
}{
"fieldErrors": [
{
"field": "<string>",
"code": "<string>",
"code_v2": "length",
"message": "length must be between 0 and 255",
"rejectedValue": "a string that contains more than 255 characters"
}
],
"operationErrors": [
{
"code": "missing-or-invalid-input-field",
"message": "GUID not present in request, provide GUID in login request"
}
]
}{
"operationError": {
"code": "<string>",
"message": "Bad user input",
"type": "<string>",
"authorities": [
"<string>"
]
},
"stackTrace": "<string>",
"operationErrors": [
{
"code": "authentication-required",
"message": "Full Authentication Required"
}
]
}{
"operationError": {
"code": "<string>",
"message": "Bad user input",
"type": "<string>",
"authorities": [
"<string>"
]
},
"stackTrace": "<string>",
"operationErrors": [
{
"code": "ACCESS_FORBIDDEN",
"message": "Access Denied"
}
]
}{
"operationErrors": [
{
"code": "restClientRuntime-not-found",
"message": "Information for the following resource was not found: com.uxpsystems.mint.framework.device.model.RestClientRuntime[id:909]"
}
]
}Authorizations
Body
The data transfer object that contains all possible runtime properties to be updated
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.
The entity’s activation date and time, expressed in UNIX Epoch time
1514766808000
Runtime Response Attributes
Show child attributes
Show child attributes
The customer-defined build type of this specific runtime. This can be used to discriminate between known beta versus production hardware.
"Production"
The entity’s creation date and time in UNIX Epoch time
1538682581776
The entity’s deactivation date and time, expressed in UNIX Epoch time
1543833950000
The runtime’s type of physical device
"phone"
The display name of the entity
"Paul's iPad"
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.
"DEF123"
The unique ID of an entity.
1
The runtime’s platform type
"android"
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.
activating, activated, suspended, deactivated, pending, unknown "activated"
The entity’s suspension date and time, expressed in UNIX Epoch time
1527917430000
A particular type of a given entity.
"com.uxpsystems.ulm.entity.RegularEntityType"
The most recent date and time that the entity was updated, expressed in UNIX Epoch time
1538682581776
The runtime’s browser and operating system information
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
The runtime’s version
"4.1.1"

