Viviot.Api

<back to all web services

GetActionLogs

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin
The following routes are available for this service:
GET/actionlogsGets all action logs.
GetActionLogs Parameters:
NameParameterData TypeRequiredDescription
UserIdqueryintegerNoThe ID of the user that performed the action
PagequeryintegerYesThe page number (first page = 1, second page = 2)
ItemsPerPagequeryintegerYesThe number of items per page
BusinessUserIdqueryintegerNoID of the business user that performed the action
ActionqueryintegerNoThe action that was performed and logged
TargetThingIdquerystringNoID of the thing that was the target of the action
TargetUserIdqueryintegerNoID of the targeted mobile user
TargetBusinessUserIdqueryintegerNoID of the targeted business user
TargetTaskIdquerystringNoID of the task that was the target of the action
TargetTaskListIdquerystringNoID of the tasklist that was the target of the action
FromquerystringNoLower bound for ActionLogs within a date range.
ToquerystringNoUpper bound for ActionLogs within a date range
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ActionLogResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<ActionLogView>No
TotalAvailableItemsformlongNo
TotalPagesformdecimalNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ActionLogView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TimestampformDateTimeNo
ActionInitiatorformstringNo
ActionformDictionary<int, string>No
ActionTargetThingformstringNo
ActionTargetUserformstringNo
OrganizationIdformGuid?No
ActionTargetTaskformstringNo
ActionTargetTaskListformstringNo
InformationformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /actionlogs HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	[
		{
			id: 00000000000000000000000000000000,
			timestamp: -62135596800000,
			actionInitiator: String,
			action: 
			{
				0: String
			},
			actionTargetThing: String,
			actionTargetUser: String,
			organizationId: 00000000000000000000000000000000,
			actionTargetTask: String,
			actionTargetTaskList: String,
			information: String
		}
	],
	totalAvailableItems: 0,
	totalPages: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}