RetrieveActionLogs

SystemService / RetrieveActionLogs

Description: Retrieve action logs

URL: http://{your-server-url}/api/v1/core/system/actionlogs

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}
currentaccountid: {accountid - optional and default value is user's own account}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require
Basic	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
resourceids	int[]	True	comma separated values, eg. resourceids=1,2,3
actionlogids	int[]	True	comma separated values, eg. actionlogids=1,2,3
userids	int[]	True	comma separated values, eg. userids=1,2,3
scopes	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope[]	True	comma separated values, eg. scopes=content,applications
operations	Nexus.AppSpace.Service.Contract.Model.Enums.Systems.Operation[]	True	comma separated values, eg. scopes=create,update
starttime	DateTime	True	return items with timestamp >= starttime. format: dd/MM/yyyy HH:mm:ss, eg. starttime=10/03/2014 01:01:01
endtime	DateTime	True	return items with timestamp <= endtime. format: dd/MM/yyyy HH:mm:ss, eg. endtime=10/05/2014 01:01:01
sort	string	True	sorting fields: id, timestamp. Comma seperated values, unary negative to imply descending sort order, e.g. sort=-id
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/system/actionlogs?resourceids=1,2,3&actionlogids=1,2,3&userids=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Systems.SystemResponse

Parameter	Type
Response.ActionLogs	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.System.ActionLog[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int
Response.TotalCount	int

The following is an example response Xml body:

<SystemResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Systems" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <ActionLogs xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Systems">
    <a:ActionLog>
      <a:Id>123</a:Id>
      <a:Metadata xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:Metadata>
      <a:Operation>Special</a:Operation>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceScope>Player_Groups</a:ResourceScope>
      <a:TimeStamp>2014-04-09T15:18:30.8688555Z</a:TimeStamp>
      <a:User xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
        <b:AccountId>123</b:AccountId>
        <b:CloudGuid>String</b:CloudGuid>
        <b:CreatedDate>2014-04-09T15:18:30.8688555Z</b:CreatedDate>
        <b:Email>String</b:Email>
        <b:EntitlementIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <c:int>123</c:int>
        </b:EntitlementIds>
        <b:FirstName>String</b:FirstName>
        <b:GroupId>123</b:GroupId>
        <b:HomeNetworkId>123</b:HomeNetworkId>
        <b:Id>123</b:Id>
        <b:LastAccess>2014-04-09T15:18:30.8688555Z</b:LastAccess>
        <b:Lastname>String</b:Lastname>
        <b:MobileNo>String</b:MobileNo>
        <b:Password>String</b:Password>
        <b:RoleIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <c:int>123</c:int>
        </b:RoleIds>
        <b:SecretAnswer>String</b:SecretAnswer>
        <b:SecretQuestion>String</b:SecretQuestion>
        <b:Status>Disabled</b:Status>
        <b:UserDN>String</b:UserDN>
        <b:Username>String</b:Username>
        <b:WorkNo>String</b:WorkNo>
      </a:User>
    </a:ActionLog>
  </ActionLogs>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</SystemResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"ActionLogs":[
		{
			"Id":123,
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Operation":14,
			"ResourceId":123,
			"ResourceScope":23,
			"TimeStamp":"\/Date(1397056710868)\/",
			"User":{
				"AccountId":123,
				"CloudGuid":"String",
				"CreatedDate":"\/Date(1397056710868)\/",
				"Email":"String",
				"EntitlementIds":[
					123
				],
				"FirstName":"String",
				"GroupId":123,
				"HomeNetworkId":123,
				"Id":123,
				"LastAccess":"\/Date(1397056710868)\/",
				"Lastname":"String",
				"MobileNo":"String",
				"Password":"String",
				"RoleIds":[
					123
				],
				"SecretAnswer":"String",
				"SecretQuestion":"String",
				"Status":0,
				"UserDN":"String",
				"Username":"String",
				"WorkNo":"String"
			}
		}
	],
	"CurrentPage":123,
	"Rpp":123,
	"TotalCount":123,
	"TotalPages":123
}