Short Description

Chapter Contents:

Long Description

Properties

Property	Type	Description	Comments
objectName	String	New attribute. It specifies the Dataloy object name the audit log refers to (Voyage, Document, ..)	since API 3.5
attributeName	String	New attribute. It specifies the attribute name of the object the audit log refers to	since API 3.5
actionTime	Date	Audit log creation date
entryText	String	Short text description of what has been changed
source	Integer	The key of the dataloy object the audit log refers to
newValue	String	The new value for the fields in string format
oldValue	String	The old value for the fields in string format

Supported Methods

GET /AuditLog

Get a list of AuditLog objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

Examples:

http://localhost:8080/ws/rest/AuditLog?filter=objectName(EQ)VoyageHeader&filter=attributeName(EQ)voyageStatus&filter=newValue(EQ)SCH&filter=actionTime(GT)2017-05-01T09:50:10

Gather all AuditLog for the VoyageHeader object where the attribute voyageStatus has changed to SCH value after the specified date.

http://localhost:8080/ws/rest/AuditLog?filter=objectName(EQ)VoyageHeader&filter=attributeName(EQ)voyageStatus&filter=newValue(EQ)NOM&filter=actionTime(GT)2017-05-01T09:50:10&filter=oldValue(EQ)SCH

Gather all AuditLog for the VoyageHeader object where the attribute voyageStatus has changed from the value SCH to NOM after the specified date.

GET /AuditLog/{key}

Get a single AuditLog object.

Example Response Body

GET /AuditLog/41094057

Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)

{
    "key": 41094057,
    "self": "http://localhost:8080/ws/rest/AuditLog/41094057",
    "objectName": "VoyageHeader",
    "attributeName": "voyageStatus",
    "source": 15562857,
    "newValue": "SCH",
    "oldValue": "NOM",
    "entryText": "Field update: voyageStatus",
    "actionTime": "2017-06-08T12:45:00",
    "modifiedDate": "2017-06-08T10:45:00",
    "action": {
        "key": 1000009,
        "self": "http://localhost:8080/ws/rest/Action/1000009",
        "actionName": "EDIT"
    },
    "user": {
        "key": 999999,
        "self": "http://localhost:8080/ws/rest/User/999999",
        "userName": "dataloy - KEEP",
        "userCode": "DATALOY"
    },
    "createdDate": "2017-06-08T10:45:00",
    "createdById": 999999,
    "remarks": []
}

Top
Back

Long Description

Properties

Supported Methods

Example Response Body

Related Content

Browser not supported