Reference

Audittrailentry

The audittrailentry object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this audittrailentry
ActionBy: string optional
AuditType: Nexudus.Coworking.Core.Enums.eAuditType optional
BusinessId: Id required
Description: string required
EntityId: int required
EntityShortName: string required
NewValue: string optional
OldValue: string optional
PropertyName: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this audittrailentry
SystemId: string optional api-only
User defined data about this audittrailentry. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ActionBy": "0",
  "AuditType": 1,
  "BusinessId": 12345678,
  "Description": "00001",
  "EntityId": ,
  "EntityShortName": "00001",
  "NewValue": "0",
  "OldValue": "0",
  "PropertyName": "00001",
  "UniqueId": "e5ec44e8-f528-40e8-862d-9bf110bfc774",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a AuditTrailEntry

This endpoint allows you to GET a list of audittrailentries based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/audittrailentries?...

๐Ÿ”’ Requires role "AuditTrailEntry-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=UpdatedOn
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search audittrailentry records based on their different properties.
Id number
?Id=12345678
AuditTrailEntry_ActionBy string
?AuditTrailEntry_ActionBy=...
AuditTrailEntry_AuditType Nexudus.Coworking.Core.Enums.eAuditType
?AuditTrailEntry_AuditType=...
AuditTrailEntry_Business Business
?AuditTrailEntry_Business=...
AuditTrailEntry_Description string
?AuditTrailEntry_Description=...
AuditTrailEntry_EntityId int
?AuditTrailEntry_EntityId=...
AuditTrailEntry_EntityShortName string
?AuditTrailEntry_EntityShortName=...
AuditTrailEntry_NewValue string
?AuditTrailEntry_NewValue=...
AuditTrailEntry_OldValue string
?AuditTrailEntry_OldValue=...
AuditTrailEntry_PropertyName string
?AuditTrailEntry_PropertyName=...

Range search querystring parameters
Lets you search audittrailentry records based on a range of date or numeric values.
To_AuditTrailEntry_CreatedOn date
?To_AuditTrailEntry_CreatedOn=2010-01-01T20:32
From_AuditTrailEntry_CreatedOn date
?From_AuditTrailEntry_CreatedOn=2010-01-01T20:32
To_AuditTrailEntry_UpdatedOn date
?To_AuditTrailEntry_UpdatedOn=2010-01-01T20:32
From_AuditTrailEntry_UpdatedOn date
?From_AuditTrailEntry_UpdatedOn=2010-01-01T20:32
To_AuditTrailEntry_EntityId number
?To_AuditTrailEntry_EntityId=0
From_AuditTrailEntry_EntityId number
?From_AuditTrailEntry_EntityId=10

Example request

GET https://spaces.nexudus.com/api/sys/audittrailentries?AuditTrailEntry_Description=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "EntityShortName": "00001",
        "Description": "00001",
        "PropertyName": "00001",
        "AuditType": 1,
        "OldValue": "0",
        "NewValue": "0",
        "ActionBy": "0",
        "EntityId": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "282d5eaf-df2d-4d65-8d89-f2cce25c15ea",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find AuditTrailEntries by IDs

Gets one or more audittrailentry records based on their Id.
GET https://spaces.nexudus.com/api/sys/audittrailentries?AuditTrailEntry_Id=[:id1,:id2,...]

๐Ÿ”’ Requires role "AuditTrailEntry-List"

Querystring parameters
AuditTrailEntry_Id: array requried
?AuditTrailEntry_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/audittrailentries?AuditTrailEntry_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "EntityShortName": "00001",
        "Description": "00001",
        "PropertyName": "00001",
        "AuditType": 1,
        "OldValue": "0",
        "NewValue": "0",
        "ActionBy": "0",
        "EntityId": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "71dc7f5d-fbf9-481c-b1e4-efa289de7581",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "UpdatedOn",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single AuditTrailEntry by Id

Gets one audittrailentry record by its Id.
GET https://spaces.nexudus.com/api/sys/audittrailentries/:Id

๐Ÿ”’ Requires role "AuditTrailEntry-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/audittrailentries/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "ActionBy": "0",
  "AuditType": 1,
  "BusinessId": 12345678,
  "Description": "00001",
  "EntityId": ,
  "EntityShortName": "00001",
  "NewValue": "0",
  "OldValue": "0",
  "PropertyName": "00001",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "d6ff6bf0-0ddc-4978-a141-75c4784dbcec",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new AuditTrailEntry

Creates a new audittrailentry.
POST https://spaces.nexudus.com/api/sys/audittrailentries

๐Ÿ”’ Requires role "AuditTrailEntry-Create"

Body parameters
BusinessId: number required
EntityShortName: string required
Description: string required
PropertyName: string required
AuditType: Nexudus.Coworking.Core.Enums.eAuditType optional
OldValue: string optional
NewValue: string optional
ActionBy: string optional
EntityId: int required

Example request

POST https://spaces.nexudus.com/api/sys/audittrailentries
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "EntityShortName": "00001",
    "Description": "00001",
    "PropertyName": "00001",
    "AuditType": 1, //(check Enumerated values section below)
    "OldValue": "0",
    "NewValue": "0",
    "ActionBy": "0",
    "EntityId": ,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Commands

Commands allow to perform actions against one or more audittrailentry records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for audittrailentry records.
GET https://spaces.nexudus.com/api/sys/audittrailentries/commands

Example request

GET https://spaces.nexudus.com/api/sys/audittrailentries/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more audittrailentry record IDs.
POST https://spaces.nexudus.com/api/sys/audittrailentries/runacommand
๐Ÿ”’ Requires role "AuditTrailEntry-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/audittrailentries/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Enumerated values

AuditType

GET /api/utils/enums?name=eAuditType

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.