Get AuditTrail - Grouping and Mapping

Grouping and Mapping

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/grouping-and-mapping/audit?iModelId[&path][&after][&before][&$top][&$continuationToken]

Gets Audit Trail Entries.

Audit Query Parameters

iModelId (required) - scope to query Audit Trail entries from. imodels_read permission is required in specified iModel.

path (optional) - hierarchy path to query Audit Trail entries from. All child elements are included. Supported values are:

mappings
mappings/{mappingId}
mappings/{mappingId}/groups
mappings/{mappingId}/groups/{groupId}
mappings/{mappingId}/groups/{groupId}/properties
mappings/{mappingId}/groups/{groupId}/properties/{propertyId}

after (optional) - DateTimeOffset value to return the entries from (inclusive). Suports ISO 8601 format e.g. 2023-07-27T02:55:36.77+01:00

before (optional) - DateTimeOffset value to return the entries up to (inclusive). Suports ISO 8601 format e.g. 2023-07-27T02:55:36.77Z

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request parameters

iModelId

Yes

The IModel Id.

path

Query entries in path (recursive).

after

DateTimeOffset value to return the entries from (inclusive).

before

DateTimeOffset value to return the entries up to (inclusive).

$top

Optional max items to be sent in response.

$continuationToken

Optional token to retrieve next page in paginated response.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

Retrieved Audit Trail Entries successfully.

json

{
    "auditTrailEntries": [{
        "timestamp": "2023-08-02T10:37:29.4840808+00:00",
        "path": "mappings/a5c26c0b-ae2b-43b8-b1ff-74399ce8e453",
        "userEmail": "john.doe@example.com",
        "action": "Update",
        "changes": [{
                "property": "mappingName",
                "oldValue": "Mapping_name_old",
                "newValue": "Mapping_name_new"
            },
            {
                "property": "extractionEnabled",
                "oldValue": "false",
                "newValue": "true"
            }
        ]
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/grouping-and-mapping/audit?iModelId=70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a&$top=100&$continuationToken=6c7f6c73-cae9-4efa-a195-cc9576a0f4db"
        },
        "self": {
            "href": "https://api.bentley.com/grouping-and-mapping/audit?iModelId=70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a&$top=100"
        }
    }
}

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 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidGroupingAndMappingRequest",
        "message": "Cannot retrieve Audit.",
        "details": [{
            "code": "InvalidParameter",
            "message": "Provided 'path' query parameter value is not valid. Requested AuditTrailEntry is not available.",
            "target": "path"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Audit Trail Collection

List of Audit Trail Entries.

auditTrailEntries

AuditTrail[]

List of Audit Trail Entries.

_links

PagedResponseLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Audit Trail Collection",
    "type": "object",
    "description": "List of Audit Trail Entries.",
    "properties": {
        "auditTrailEntries": {
            "type": "array",
            "description": "List of Audit Trail Entries.",
            "items": {
                "$ref": "#/components/schemas/AuditTrail"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "required": [
        "auditTrailEntries",
        "_links"
    ],
    "additionalProperties": false
}

Audit Trail Entry action

The action that was made.

Create

String

Update

String

Delete

String

Copy

String

json

{
    "type": "string",
    "description": "The action that was made.",
    "enum": [
        "Create",
        "Update",
        "Delete",
        "Copy"
    ],
    "additionalProperties": false,
    "title": "Audit Trail Entry action"
}

Audit Trail Entry

Defines Audit Trail Entry of a single change.

timestamp

Date-time

Time of the action.

path

String

Entity identification path.

userEmail

String, null

E-mail address of the user who made this change. null for changes made by services.

Audit Trail Entry action

AuditTrail-action

The action that was made.

changes

AuditPropertyChange[]

List of Entity Property changes.

json

{
    "title": "Audit Trail Entry",
    "type": "object",
    "description": "Defines Audit Trail Entry of a single change.",
    "properties": {
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Time of the action."
        },
        "path": {
            "type": "string",
            "description": "Entity identification path."
        },
        "userEmail": {
            "type": "string",
            "description": "E-mail address of the user who made this change. `null` for changes made by services.",
            "nullable": true
        },
        "action": {
            "type": "string",
            "description": "The action that was made.",
            "enum": [
                "Create",
                "Update",
                "Delete",
                "Copy"
            ],
            "additionalProperties": false,
            "title": "Audit Trail Entry action",
            "$ref": "#/components/schemas/AuditTrail-action"
        },
        "changes": {
            "type": "array",
            "description": "List of Entity Property changes.",
            "items": {
                "$ref": "#/components/schemas/AuditPropertyChange"
            }
        }
    },
    "required": [
        "timestamp",
        "path",
        "action",
        "changes"
    ],
    "additionalProperties": false
}

Entity Property Change Details

Defines a single Entity Property change.

property

String

Name of the changed Property.

oldValue

String, null

Original Property value.

newValue

String, null

New Property value.

json

{
    "title": "Entity Property Change Details",
    "type": "object",
    "description": "Defines a single Entity Property change.",
    "properties": {
        "property": {
            "type": "string",
            "description": "Name of the changed Property."
        },
        "oldValue": {
            "type": "string",
            "description": "Original Property value.",
            "nullable": true
        },
        "newValue": {
            "type": "string",
            "description": "New Property value.",
            "nullable": true
        }
    },
    "required": [
        "property"
    ],
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "title": "Link",
    "type": "object",
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "required": [
        "href"
    ],
    "additionalProperties": false
}

Paged Response Links

URLs for redoing the current request and/or getting the next page of results if applicable.

Link, null

URL to get the next page of results.

self

Link

URL to repeat the current request.

json

{
    "title": "Paged Response Links",
    "type": "object",
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable.",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to get the next page of results.",
            "nullable": true
        },
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to repeat the current request."
        }
    },
    "required": [
        "self"
    ],
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?