Planon IoT : IoT Platform - Developer's Guide : Audits Endpoints : Audits/Post : Request ‒ Audits/Post
Request ‒ Audits/Post
Property
Type
Description
Mandatory
entityName
String
The name of the entity (such as the name of the Device or the name of the User) on which the action (such as create or delete) was performed.
entityId
String
The unique identifier (such as tenantId or appId) on which the action was performed.
action
String
The action performed on the entity, such as Post, Put, Patch, Get or Delete. For example, to add a Device or Application.
category
String
The type of entity on which the action (described above) was performed, such as –
• Devices
• Products
• Rules
• Users
• Applications
• Events
• Auth
userEmail
String
The email of the IoT Platform user that performed the action.
userId
String
The unique identifier (ID) of the IoT Platform user that performed the action.
requestDateTime
DateTime
The timestamp of the request for this action to be performed.
responseDateTime
String
The timestamp when the response was sent, which indicates when the event took place.
application
String
The name of the Application on which the action was performed.
tenant
String
The name of the Tenant of the Application on which the action was performed.
correlationId
For internal IoT Platform use.
ip
String
The IP of the request sender.
result
String
The response code received as the result to the request.
request DurationMs
String
The number of milliseconds it took to fulfil the request.
requestURL
String
Shows the entire URL string used to execute the request, which is comprised of the domain, the Tenant and the action itself.
actionDisplay
String
Free text that describes the action.
categoryDisplay
String
Free text to describe the entity on which the action was performed (meaning the Device, Application or Product).
userName
String
Name of the user that performed the request, whether it is in the IoT Platform Portal or using the IoT Platform REST API.
roles
Array String
The roles of the user at the time the request was performed.
sourceName
String
The name of the service requester.
sourceType
String/Enum
The type of the requester –
• Unknown
• Portal
• Rules Engine
• XStream
• Gateways
appId
String
The identifier of the Application of the Audit. This appId was returned in the response to the Applications/Post endpoint.
additionalInfo
Strings
This property consists of various keys and values that contain the properties used in the request body, such as a serial number.
{
“Key”: “serialNumber”,
“Value”: “NewSerialNumber”
}
Both mandatory and optional keys and values are provided.
Example JSON Audits/Post Request
curl -X POST \
https://api.stg.axonize.com/odata/audits/ \
-H ‘Authorization: Token’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \
-d ‘{
“entityName”: “device123”,
“entityId”: “1321233231123”,
“action”: “CreateDevice”,
“category”: “Devices”
}
‘