Get AuditLog by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/audit-log/:audit_log_id

GET

/api/v3/audit-log/:audit_log_id

curl https://{tenant_name}.benchling.com/api/v3/audit-log/audit_log_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "action": "action",
  "chatSessionId": "chatSessionId",
  "clientId": "clientId",
  "clientName": "clientName",
  "createdAt": "createdAt",
  "delegateUser": "delegateUser",
  "electronicallySigned": "electronicallySigned",
  "eventDescription": "eventDescription",
  "id": "id",
  "ipAddress": "ipAddress",
  "item": "item",
  "itemDeveloperId": "itemDeveloperId",
  "itemId": "itemId",
  "itemType": "itemType",
  "newValue": "newValue",
  "oldValue": "oldValue",
  "parentItem1": "parentItem1",
  "parentItem1DeveloperId": "parentItem1DeveloperId",
  "parentItem1Type": "parentItem1Type",
  "parentItem2": "parentItem2",
  "parentItem2DeveloperId": "parentItem2DeveloperId",
  "parentItem2Type": "parentItem2Type",
  "parentItem3": "parentItem3",
  "parentItem3DeveloperId": "parentItem3DeveloperId",
  "parentItem3Type": "parentItem3Type",
  "reasonCode": "reasonCode",
  "reasonComment": "reasonComment",
  "transactionId": "transactionId",
  "userHandle": "userHandle",
  "userId": "userId",
  "userName": "userName"
}

Get a single AuditLog by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

audit_log_idstringRequired

ID of the AuditLog.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

__typenamestringOptional

actionstringOptional

chatSessionIdstring or nullOptional

clientIdstring or nullOptional

clientNamestring or nullOptional

createdAtstringOptional

delegateUserstring or nullOptional

electronicallySignedstringOptional

eventDescriptionstringOptional

idstringOptional

ipAddressstringOptional

itemstringOptional

itemDeveloperIdstringOptional

itemIdstring or nullOptional

itemTypestringOptional

newValuestring or nullOptional

oldValuestring or nullOptional

parentItem1string or nullOptional

parentItem1DeveloperIdstring or nullOptional

parentItem1Typestring or nullOptional

parentItem2string or nullOptional

parentItem2DeveloperIdstring or nullOptional

parentItem2Typestring or nullOptional

parentItem3string or nullOptional

parentItem3DeveloperIdstring or nullOptional

parentItem3Typestring or nullOptional

reasonCodestring or nullOptional

reasonCommentstring or nullOptional

transactionIdstringOptional

userHandlestringOptional

userIdstringOptional

userNamestringOptional

Errors

400

Audit Log Get Request Bad Request Error

403

Audit Log Get Request Forbidden Error

404

Audit Log Get Request Not Found Error

429

Audit Log Get Request Too Many Requests Error

500

Audit Log Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors