Post external runtime entity events
curl --request POST \
--url https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data @- <<EOF
{
"runtime": {
"activatedDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"details": {},
"name": "operationsSupportSystemNumber",
"value": "abc123"
}
],
"buildType": "Production",
"createdDate": "2023-11-07T05:31:56Z",
"customer": "Apple",
"deactivatedDate": "2023-11-07T05:31:56Z",
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": "2023-11-07T05:31:56Z",
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": "2023-11-07T05:31:56Z",
"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"
},
"id": "<string>",
"applicationName": "BSS"
}
EOFimport requests
url = "https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime"
payload = {
"runtime": {
"activatedDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"details": {},
"name": "operationsSupportSystemNumber",
"value": "abc123"
}
],
"buildType": "Production",
"createdDate": "2023-11-07T05:31:56Z",
"customer": "Apple",
"deactivatedDate": "2023-11-07T05:31:56Z",
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": "2023-11-07T05:31:56Z",
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": "2023-11-07T05:31:56Z",
"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"
},
"id": "<string>",
"applicationName": "BSS"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
runtime: {
activatedDate: '2023-11-07T05:31:56Z',
attributes: [{details: {}, name: 'operationsSupportSystemNumber', value: 'abc123'}],
buildType: 'Production',
createdDate: '2023-11-07T05:31:56Z',
customer: 'Apple',
deactivatedDate: '2023-11-07T05:31:56Z',
deviceType: 'phone',
displayName: 'Paul\'s iPad',
guid: 'DEF123',
id: 1,
platformType: 'android',
status: 'activated',
suspendedDate: '2023-11-07T05:31:56Z',
type: 'com.uxpsystems.ulm.entity.RegularEntityType',
updatedDate: '2023-11-07T05:31:56Z',
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'
},
id: '<string>',
applicationName: 'BSS'
})
};
fetch('https://int-prodtest.m1amdocs.io/eventmgr/v1/event/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://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'runtime' => [
'activatedDate' => '2023-11-07T05:31:56Z',
'attributes' => [
[
'details' => [
],
'name' => 'operationsSupportSystemNumber',
'value' => 'abc123'
]
],
'buildType' => 'Production',
'createdDate' => '2023-11-07T05:31:56Z',
'customer' => 'Apple',
'deactivatedDate' => '2023-11-07T05:31:56Z',
'deviceType' => 'phone',
'displayName' => 'Paul\'s iPad',
'guid' => 'DEF123',
'id' => 1,
'platformType' => 'android',
'status' => 'activated',
'suspendedDate' => '2023-11-07T05:31:56Z',
'type' => 'com.uxpsystems.ulm.entity.RegularEntityType',
'updatedDate' => '2023-11-07T05:31:56Z',
'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'
],
'id' => '<string>',
'applicationName' => 'BSS'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime"
payload := strings.NewReader("{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.post("https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Post external runtime entity events
API to notify MarketONE of significant runtime (devices) lifecycle events occured outside MarketONE.
POST
/
eventmgr
/
v1
/
event
/
runtime
Post external runtime entity events
curl --request POST \
--url https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data @- <<EOF
{
"runtime": {
"activatedDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"details": {},
"name": "operationsSupportSystemNumber",
"value": "abc123"
}
],
"buildType": "Production",
"createdDate": "2023-11-07T05:31:56Z",
"customer": "Apple",
"deactivatedDate": "2023-11-07T05:31:56Z",
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": "2023-11-07T05:31:56Z",
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": "2023-11-07T05:31:56Z",
"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"
},
"id": "<string>",
"applicationName": "BSS"
}
EOFimport requests
url = "https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime"
payload = {
"runtime": {
"activatedDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"details": {},
"name": "operationsSupportSystemNumber",
"value": "abc123"
}
],
"buildType": "Production",
"createdDate": "2023-11-07T05:31:56Z",
"customer": "Apple",
"deactivatedDate": "2023-11-07T05:31:56Z",
"deviceType": "phone",
"displayName": "Paul's iPad",
"guid": "DEF123",
"id": 1,
"platformType": "android",
"status": "activated",
"suspendedDate": "2023-11-07T05:31:56Z",
"type": "com.uxpsystems.ulm.entity.RegularEntityType",
"updatedDate": "2023-11-07T05:31:56Z",
"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"
},
"id": "<string>",
"applicationName": "BSS"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
runtime: {
activatedDate: '2023-11-07T05:31:56Z',
attributes: [{details: {}, name: 'operationsSupportSystemNumber', value: 'abc123'}],
buildType: 'Production',
createdDate: '2023-11-07T05:31:56Z',
customer: 'Apple',
deactivatedDate: '2023-11-07T05:31:56Z',
deviceType: 'phone',
displayName: 'Paul\'s iPad',
guid: 'DEF123',
id: 1,
platformType: 'android',
status: 'activated',
suspendedDate: '2023-11-07T05:31:56Z',
type: 'com.uxpsystems.ulm.entity.RegularEntityType',
updatedDate: '2023-11-07T05:31:56Z',
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'
},
id: '<string>',
applicationName: 'BSS'
})
};
fetch('https://int-prodtest.m1amdocs.io/eventmgr/v1/event/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://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'runtime' => [
'activatedDate' => '2023-11-07T05:31:56Z',
'attributes' => [
[
'details' => [
],
'name' => 'operationsSupportSystemNumber',
'value' => 'abc123'
]
],
'buildType' => 'Production',
'createdDate' => '2023-11-07T05:31:56Z',
'customer' => 'Apple',
'deactivatedDate' => '2023-11-07T05:31:56Z',
'deviceType' => 'phone',
'displayName' => 'Paul\'s iPad',
'guid' => 'DEF123',
'id' => 1,
'platformType' => 'android',
'status' => 'activated',
'suspendedDate' => '2023-11-07T05:31:56Z',
'type' => 'com.uxpsystems.ulm.entity.RegularEntityType',
'updatedDate' => '2023-11-07T05:31:56Z',
'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'
],
'id' => '<string>',
'applicationName' => 'BSS'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime"
payload := strings.NewReader("{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.post("https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-prodtest.m1amdocs.io/eventmgr/v1/event/runtime")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"runtime\": {\n \"activatedDate\": \"2023-11-07T05:31:56Z\",\n \"attributes\": [\n {\n \"details\": {},\n \"name\": \"operationsSupportSystemNumber\",\n \"value\": \"abc123\"\n }\n ],\n \"buildType\": \"Production\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"customer\": \"Apple\",\n \"deactivatedDate\": \"2023-11-07T05:31:56Z\",\n \"deviceType\": \"phone\",\n \"displayName\": \"Paul's iPad\",\n \"guid\": \"DEF123\",\n \"id\": 1,\n \"platformType\": \"android\",\n \"status\": \"activated\",\n \"suspendedDate\": \"2023-11-07T05:31:56Z\",\n \"type\": \"com.uxpsystems.ulm.entity.RegularEntityType\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n \"version\": \"4.1.1\"\n },\n \"id\": \"<string>\",\n \"applicationName\": \"BSS\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid-request",
"message": "<string>",
"validationErrors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "authentication-required",
"message": "<string>"
}{
"code": "not-found",
"message": "<string>"
}{
"code": "server-error",
"message": "<string>"
}Authorizations
The authorization key obtained from MarketONE.
Headers
The TraceId indicates the overall ID of the trace. Every span in a trace shares this ID. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like 463ac35c9f6413ad48485a3953bb6124.
The SpanId is 64-bit in length and indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like a2fb4a1d1a96d312. Unless propagating only the Sampling State, the X-B3-SpanId header is required.
The ParentSpanId is 64-bit in length and indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like 0020000000000001.
Body
application/json
Available options:
deleted, updated 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.
Show child attributes
Show child attributes
the event id provided by application generating the event.
Maximum string length:
36the name of the application sending this event
Maximum string length:
128Example:
"BSS"
Response
OK
Was this page helpful?