Device Logs

Used to fetch a log containing all the activities performed for the given DeviceID.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v4/device/{deviceId}/logs?limit=<limit>&offset=<offset>

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_device/{deviceId}/logs?limit=<limit>&offset=<offset>

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters (*Required)

Parameter Name	Type	Description
*limit	Integer	provide limit
*offset	Integer	provide offset

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Array	List of all device details. Refer Data Representation for details.

Sample Response

{
	"data": {
		"moreResultsAvailable": true,
		"reportingFilterUsed": {
			"deviceId": "4501",
			"limit": 2,
			"offset": 5
		},
		"reportingInfoItems": [{
				"action": "20",
				"alertErrorCode": 72,
				"archived": false,
				"certificateSerialNumber": "2033460708",
				"details": "Starting a transaction failed: User ID of transaction [testuser23] does not match the user ID, which is assigned to the device [joker]4501",
				"deviceId": "4501",
				"id": 186089,
				"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
				"logDate": "1601221875",
				"status": "-129",
				"subSystemId": 501,
				"userId": "joker"
			},
			{
				"action": "20",
				"alertErrorCode": 72,
				"archived": false,
				"certificateSerialNumber": "2033460708",
				"details": "Starting a transaction failed: User ID of transaction [testuser23] does not match the user ID, which is assigned to the device [joker]4501",
				"deviceId": "4501",
				"id": 186088,
				"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
				"logDate": "1601221865",
				"status": "-129",
				"subSystemId": 501,
				"userId": "joker"
			}
		]
	},
	"message": "Logs fetched successfully",
	"status": "OK",
	"subSystem": 5
}

Data Representation

Field Name	Type	Description
reportingFilterUsed	Object	Filters applied to retrieve info items
reportingInfoItem	Array	Available reporting informations
moreResultsAvailable	Boolean	This value is true, if the available records are more than the limit set.
limit	Integer	Number of records to be fetched per request.
offset	Integer	Indicates the page number.
action	Integer	Action of device to be worked on. This is usually an UUID
archived	Boolean	If true the record is archived.
certificateSerialNumber	Integer	A unique number identifying the certificate.
deviceId	Integer	The SSMS registered id of the device used.
id	Integer	Id of device to be worked on. This is usually an UUID.
issuerDN	String	The CA that issues the certificate
logDate	Integer	Device log date
status	Integer	Device current status
uid	String	Unique user id

Response Status Information

Status Code	Status	Message
200	OK	Logs fetched successfully
400	BAD_REQUEST	DeviceID should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized
404	DEVICE_NOT_FOUND	Device does not exist