Get audit trail for form data - Forms

Forms

Download API definition:

GET https://api.bentley.com/forms/{id}/auditTrailEntries

Retrieves a reverse-chronologically-ordered list of all changes that have been made to this form data instance, including authors, dates, and old vs. new property values.

Permissions

To use this endpoint, the user is required to have the Forms View (Forms_ViewAccess) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the View permission as well.)

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request

Request parameters

Yes

The ID of the form data instance for which to retrieve the audit trail.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 200 OK

json

{
    "auditTrailEntries": [{
            "id": "cdefMNUYw02hNz19awLcRglMXtJ6wX1Au90K-x30000",
            "changeBy": "Sue User2",
            "changeById": "f4fa6f4f-0000-1111-2222-f4fa6f4fa6f4",
            "changeDateTime": "2020-11-23T17:51:47.3533335Z",
            "action": "Modified",
            "changes": [{
                "property": "Severity",
                "oldValue": "Medium",
                "newValue": "High"
            }]
        },
        {
            "id": "cdefMNUYw02hNz19awLcRszUhyKBA2hFroBiHF70000",
            "changeBy": "Joe User",
            "changeById": "9e399e39-0000-1111-2222-8d8a8d8a8d8a",
            "changeDateTime": "2020-11-23T17:48:48.9505035Z",
            "action": "Opened",
            "changes": [{
                "property": "Closed",
                "oldValue": null,
                "newValue": "False"
            }]
        },
        {
            "id": "cdefMNUYw02hNz19awLcRvLVYgvQ009DsFLTfxs0000",
            "changeBy": "Joe User",
            "changeById": "9e399e39-0000-1111-2222-8d8a8d8a8d8a",
            "changeDateTime": "2020-11-23T17:48:48.9505035Z",
            "action": "Status",
            "changes": [{
                "property": "Status",
                "oldValue": null,
                "newValue": "Open"
            }]
        },
        {
            "id": "cdefMNUYw02hNz19awLcRlgCKHZ7PHZFnGYz4P_0000",
            "changeBy": "Joe User",
            "changeById": "9e399e39-0000-1111-2222-8d8a8d8a8d8a",
            "changeDateTime": "2020-11-23T17:48:48.8254245Z",
            "action": "Assigned",
            "changes": [{
                    "property": "AssignedTo",
                    "oldValue": null,
                    "newValue": "Sue User2"
                },
                {
                    "property": "AssignedToId",
                    "oldValue": null,
                    "newValue": "f4fa6f4f-0000-1111-2222-f4fa6f4fa6f4"
                }
            ]
        },
        {
            "id": "cdefMNUYw02hNz19awLcRkCOCh-gk3ZEhnNzf1A0000",
            "changeBy": "Joe User",
            "changeById": "9e399e39-0000-1111-2222-8d8a8d8a8d8a",
            "changeDateTime": "2020-11-23T17:48:48.7941806Z",
            "action": "Created",
            "changes": []
        }
    ]
}

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the specified form data instance does not exist or is inaccessible to the user.

json

{
    "error": {
        "code": "FormDataNotFound",
        "message": "Requested form data is not available.",
        "target": "id"
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Audit Trail

auditTrailEntries

audit-trail-entry-get[]

json

{
    "type": "object",
    "title": "Audit Trail",
    "properties": {
        "auditTrailEntries": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/audit-trail-entry-get"
            }
        }
    },
    "additionalProperties": false
}

Audit Trail Entry (get) action

The type of change that was made to the form. Possible values: 'Created', 'Modified', 'Assigned', 'Status', 'Closed', 'Opened', 'Draft', 'Deleted', 'Undeleted', 'File Attached', 'File Removed', 'Form Raised'

Created

String

Modified

String

Assigned

String

Status

String

Closed

String

Opened

String

Draft

String

Deleted

String

Undeleted

String

File Attached

String

File Removed

String

Form Raised

String

json

{
    "type": "string",
    "description": "The type of change that was made to the form.  Possible values: 'Created', 'Modified', 'Assigned', 'Status', 'Closed', 'Opened', 'Draft', 'Deleted', 'Undeleted', 'File Attached', 'File Removed', 'Form Raised'",
    "enum": [
        "Created",
        "Modified",
        "Assigned",
        "Status",
        "Closed",
        "Opened",
        "Draft",
        "Deleted",
        "Undeleted",
        "File Attached",
        "File Removed",
        "Form Raised"
    ],
    "title": "Audit Trail Entry (get) action"
}

Audit Trail Entry (get)

Information about a single occurrence of a change to this form.

String

String that uniquely identifies this entry.

changeBy

String

The display name (i.e., given name and surname) of the user who made this change.

changeById

String

The GUID of the user who made this change.

changeDateTime

Date-time

The date and time of this change.

Audit Trail Entry (get) action

audit-trail-entry-get-action

changes

Object[], null

The individual property modifications that were made in this changeset.

json

{
    "type": "object",
    "title": "Audit Trail Entry (get)",
    "description": "Information about a single occurrence of a change to this form.",
    "properties": {
        "id": {
            "type": "string",
            "description": "String that uniquely identifies this entry."
        },
        "changeBy": {
            "type": "string",
            "description": "The display name (i.e., given name and surname) of the user who made this change."
        },
        "changeById": {
            "type": "string",
            "description": "The GUID of the user who made this change."
        },
        "changeDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time of this change."
        },
        "action": {
            "type": "string",
            "description": "The type of change that was made to the form.  Possible values: 'Created', 'Modified', 'Assigned', 'Status', 'Closed', 'Opened', 'Draft', 'Deleted', 'Undeleted', 'File Attached', 'File Removed', 'Form Raised'",
            "enum": [
                "Created",
                "Modified",
                "Assigned",
                "Status",
                "Closed",
                "Opened",
                "Draft",
                "Deleted",
                "Undeleted",
                "File Attached",
                "File Removed",
                "Form Raised"
            ],
            "title": "Audit Trail Entry (get) action",
            "$ref": "#/components/schemas/audit-trail-entry-get-action"
        },
        "changes": {
            "type": "array",
            "nullable": true,
            "description": "The individual property modifications that were made in this changeset.",
            "items": {
                "type": "object",
                "properties": {
                    "property": {
                        "type": "string",
                        "nullable": true,
                        "description": "The name of the changed property."
                    },
                    "oldValue": {
                        "type": "string",
                        "nullable": true,
                        "description": "A string representation of the changed property's previous value, if any."
                    },
                    "newValue": {
                        "type": "string",
                        "nullable": true,
                        "description": "A string representation of the changed property's new value, if any."
                    }
                },
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?