1. REST API for Content Capture
  2. Tasks
  3. Auditing

List all Document Audit Details

get

/capture/api/v1.1/audit/documents

This operation will return a collection of all the audit details for documents in Capture.

As a batch flows through Capture, events occur pertaining to that batch. This occurrs for documents as well. Events for documents can include that it was committed, or perhaps that its document profile was changed. It could also be runtime requirements such as the document was skipped in a processing job because it wasn't part of the restricted to criteria. Error conditions, such as a barcode not being present, can generate a document event.

The q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to sort the collection. The totalResults parameter will return the total number of results that match the query. The other parameters, limit and offset, are used for paging of the results.

This operation supports the expand parameter as well, which is used to include child resources/collections inline. The child resource of runtime is supported. When used, if the document is presently in Capture, it's runtime state information will be returned in the response.

If there are no document audit details, or they don't match the filtering criteria, an empty collection will be returned.

Request

Supported Media Types
Query Parameters

  • The expand parameter provides the option of getting child resources/collections inline with the response. It accepts a comma-separated list of attribute names or all. When expand is specified as all (with all in' lower case), all child resources/collections of the requested batch audit detail are expanded.

    When the expand parameter contains a non-defined child resource, the request operation results in an error. The available child resources/collections of a document audit detail are:

    • runtime

    Example : ?expand=runtime
    Expands the runtime object of this document audit detail, if any.

  • The limit parameter accepts a non-negative integer and is used to control the size of the resulting document audit details collection.

    Default Value: 50

  • The locale parameter is used to specify the language translations used for messages in the audit events. The value must be in the form of standard language tags as defined by RFC 4647.

    If this is not specified, the default language settings locale will be used.

  • The offset parameter accepts a non-negative integer and is used to control the start index of the dopcument audit details collection of the query.

    Default Value: 0

  • The orderBy parameter is used to control the ordering (ascending/descending) of results in the document audit detail collection. This parameter is optional as a document audit detail collection has a default sort order of lastEventDate descending.

    This parameter accepts the attribute name, and can be separated by a colon (:) for which the user wants to sort the results (ascending/descending). If a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending. Multiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also, there can also be mulitple orderBy query parameters, and they are applied in query string parameter order.

    Only the following attributes of a batch audit detail are supported in an orderBy:

    • id
    • title
    • createdDate
    • lastEventDate
    • batch.id
    • batch.name

    The attributes of the runtime child resource are also supported, such as runtime.sourceName and runtime.profile.name. However, that requires the runtime object to be included in the expand parameter (either through the use of all or runtime values), and they have no effect for historical documents. The runtime attributes runtime.stateToken and runtime.mediaType are not supported.

    Examples:

    • ?orderBy=id
    • ?orderBy=name;lastEventDate:asc
    • ?orderBy=name&orderBy=lastEventDate:desc
    • ?orderBy=createdDate:asc
    • ?orderBy=createdDate:asc;runtime.sourceName

  • The q parameter accepts a query expression condition that matches the attribute values of the document audit detail, and is used for filtering results in the collection. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be muliple expressions grouped and combined with logical operators.

    The following conditional operators are supported:

    • eq - Equals
    • ne - Not Equals
    • lt - Less Than
    • gt - Greater Than
    • le - Less Than or Equal to
    • ge - Greater Than or Equal to

    Only the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in quote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional operators can be used with other attribute data types.

    Date/time attributes must have their value represented as a string in ISO-8601 Date Time format, governed by RFC 3339. For example, "2021-04-12" or "2021-04-15T04:27:15-06:00". Even though the values are in a string format, they will support numerical type operators, such as lt and gt.

    Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters.

    Multiple q query parameters are supported, and imply the and logical operator.

    Only the following attributes of a document audit detail are supported in a q expression:

    • id
    • title
    • createdDate
    • lastEventDate
    • batch.id
    • batch.name

    The attributes of the runtime child resource are also supported, such as runtime.sourceName and runtime.profile.name. However, that requires the runtime object to be included in the expand parameter (either through the use of all or runtime values), and they have no effect for historical documents. The runtime attributes runtime.stateToken and runtime.mediaType are not supported.

    Examples:

    • ?q=(batch.id eq "342") and (lastEventDate ge "2021-05-26")
    • ?q=(runtime.profile.name eq "Plumbing Invoice" and createdDate ge "2021-05-01")
    • ?q=(runtime.size gt 250000)&q=(createdDate ge "2021-05-01")
    • ?q=(lastEventDate ge "2021-05-26")

  • The totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of document audit details in the query.

    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

A list of all the document audit details.

Body ()
Root Schema : Document Audit Detail Collection
Type: object
Title: Document Audit Detail Collection

This represents a collection of Document Audit Detail objects.

Show Source
Nested Schema : items
Type: array

The array of Document Audit Detail objects.

This will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.

Show Source
  • Document Audit Detail
    Title: Document Audit Detail

    A Document Audit Detail in Capture is a set of events that occurred for a given document. These are events such as the document was created, the document was converted, the document was committed, etc.

    A Document Audit Detail is independent in Capture, but is associated with a given Batch Audit Detail resource as documents are contained in batches.

Nested Schema : Document Audit Detail
Type: object
Title: Document Audit Detail

A Document Audit Detail in Capture is a set of events that occurred for a given document. These are events such as the document was created, the document was converted, the document was committed, etc.

A Document Audit Detail is independent in Capture, but is associated with a given Batch Audit Detail resource as documents are contained in batches.

Show Source
  • batch

    The Capture Batch that contains (or contained) this document.

  • This identifies when the document was created. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

  • If this audit detail represents an attachment of a docuument, this is the unique identifier of the document.

    This only applies to audit details on attachments of a document. It does not apply to audit details on documents. It will not be present if the audit details applies to a document.

  • events

    This array contains all individual events that pertain to this document, in eventDate ascending order.

  • The unique identifier of the document in Capture.

  • This identifies the date/time of the last event that occurred for this document. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

  • links
  • runtime

    If the document is presently part of the Capture system, this object will contain its current runtime information. However, if the document has been committed, or has otherwise been deleted from the Capture system, there will be no runtime information.

  • The title of the document. This is generally the filename used during document import.

Nested Schema : batch
Type: object

The Capture Batch that contains (or contained) this document.

Match All
Show Source
  • Capture Batch
    Title: Capture Batch

    A collection of documents in Capture that represent a unit of work in a procedure.

Nested Schema : events
Type: array

This array contains all individual events that pertain to this document, in eventDate ascending order.

Show Source
Nested Schema : runtime
Type: object

If the document is presently part of the Capture system, this object will contain its current runtime information. However, if the document has been committed, or has otherwise been deleted from the Capture system, there will be no runtime information.

Show Source
  • createdBy

    The user that created the document.

  • This identifies when the document was created. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

  • This represents the media type of the document. That is the two-part identifier for file formats and format contents transmitted on the Internet.

  • profile

    If this audit detail represents a docuument, this is the document profile that has been assigned.

    This only applies to audit details on documents. It does not apply to events on audit details of an attachment. It will not be present if the audit details applies to an attachment of a document.

    .

  • The size, in bytes, of the document.

  • The filename of the document when imported.

  • A generated string value that represents a particular state of the document.

    In general, it is used to allow modifications of the document to proceed. It is essentially saying ... modify this document if its current stateToken matches this value. If the values do not match, the modification is not permitted and the operation results in an error.

  • step

    The current processing step, if any, this document is undergoing.

  • type

    If this audit detail represents an attachment to a docuument, this is the attachment type that has been assigned.

    This only applies to audit details on attachments of a document. It does not apply to audit details on documents. It will not be present if the audit details applies to a document.

    .
  • updatedBy

    The last user that updated the document.

  • This identifies when the last time the document was updated. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

Nested Schema : Capture Batch
Type: object
Title: Capture Batch

A collection of documents in Capture that represent a unit of work in a procedure.

Show Source
  • createdBy

    The user that created the batch.

  • This identifies when the batch was created. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

  • The current error message of the batch, if any.

    If the batch is in the ERROR state, this will contain the error message detailing why the batch failed processing. This message will remain until the batch re-enters processing.

  • The unique identifier of the batch.

  • links
  • lock

    If the batch is locked (by a user creating/editing the batch or if Capture is currently processing the batch), this object will contain information about the lock. The state of the batch determines if this object exists.

  • The name given to the batch.

    When Capture creates a batch, the name is some defined prefix and a sequence number. For example, inv_4781

  • User supplied general notes associated with a batch.

  • Minimum Value: 0
    Maximum Value: 10
    Default Value: 0

    A user specified priority of the batch.

    This value is used prioritize the batch for a user's attention. Its used to filter and sort batches for viewing in the client.

  • procedure

    The Capture Procedure associated with this batch.

  • Default Value: READY

    The current state of the batch.

    • READY - The standard resting state of a batch. It is available to be locked by a client.
    • LOCKED - The batch is locked by a client for editing, such as adding/removing documents and setting metadata field values.
    • ERROR - An error occurred during processing. It is available to be locked by a client for edits to correct processing errors.
    • PROCESSING - Capture is presently processing the batch. The batch is in one of the jobs defined in the Capture procedure.

  • The current status assigned to the batch.

    The status values are defined in the procedure and can be assigned during batch creation, and during transitions between processing jobs.

  • updatedBy

    The last user that updated the batch. This can be the Capture system.

  • This identifies when the last time the batch was updated. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

Nested Schema : createdBy
Type: object

The user that created the batch.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : lock
Type: object

If the batch is locked (by a user creating/editing the batch or if Capture is currently processing the batch), this object will contain information about the lock. The state of the batch determines if this object exists.

Show Source
Nested Schema : procedure
Type: object

The Capture Procedure associated with this batch.

Match All
Show Source
Nested Schema : updatedBy
Type: object

The last user that updated the batch. This can be the Capture system.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : User Information
Type: object
Title: User Information

This object contains information about a given user of Capture.

Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Show Source
Nested Schema : lockedBy
Type: object

If the batch is locked within a Capture Client instance, this attribute will contain the user that locked the batch.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : step
Type: object

If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.

Match All
Show Source
Nested Schema : Procedure Step
Type: object
Title: Procedure Step

A step in a procedure flow.

Show Source

  • The unique identifier of the step within the procedure.

  • The name given to the step when created. For instance, the name of the processing job or commit profile.

  • The type of step. Some example include: External Processor, TIFF Conversion Processor, Asset Lookup Processor, etc.

Nested Schema : Capture Procedure
Type: object
Title: Capture Procedure

A Capture Procedure defines metadata and procesing steps of a flow.

Show Source
Nested Schema : Audit Event
Type: object
Title: Audit Event

This represents a given action that occurred within Capture that has been tracked.

Show Source

  • A simple description of the event, generally a verb, such as CREATED, UPDATED, PROCESSED, etc.

  • A correlation identifier of the event. It is important to note that this value is not unique.

    An event may cause other events to occur. This identifier is used express a causal relationships between events, particulally between batches and documents.

  • Detail information about the the event.

  • eventBy

    The user that trigged/caused the event.

    This is only present if the event was triggered by a user of Capture. It is not present when events are triggered by Capture.

  • This identifies when the event occurred. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC, governed by RFC 3339.

  • The locale that was used to produce the message. The value will be in the form of standard language tags as defined by RFC 4647.

  • The simple message the describes the event.

  • The unique key that correlates to the message pattern used to generate the detail message.

  • messageProperties

    An array of individual property keys and values that are attributes of the event, and used to produce the message. The order of the array is determined by the order of the argument indexes in the message pattern.

    The specific keys and values are dependent on the type of event. Also, the event type could allow for more complex object definition than just simple key/value pairs. Some examples are:

    Document Committed Events

    [
    { "documentId": "58be0662-a758-491a-9eed-cc6f56124acf" },
    { "documentTitle": "Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]" },
    { "repositoryName": "Plumbing Invoice Type" },
    { "assetType": "Plumbing Invoice Type" }
]

    Email Events

    [
    { "emailFromName": "Joe Smith" },
    { "emailFromAddress": "joe.smith@someplace.com" },
    { "emailSubject": "Sales Invoice" }
]

  • The unique identifer of the kind of event.

Nested Schema : eventBy
Type: object

The user that trigged/caused the event.

This is only present if the event was triggered by a user of Capture. It is not present when events are triggered by Capture.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : messageProperties
Type: array

An array of individual property keys and values that are attributes of the event, and used to produce the message. The order of the array is determined by the order of the argument indexes in the message pattern.

The specific keys and values are dependent on the type of event. Also, the event type could allow for more complex object definition than just simple key/value pairs. Some examples are:

Document Committed Events

[
    { "documentId": "58be0662-a758-491a-9eed-cc6f56124acf" },
    { "documentTitle": "Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]" },
    { "repositoryName": "Plumbing Invoice Type" },
    { "assetType": "Plumbing Invoice Type" }
]

Email Events

[
    { "emailFromName": "Joe Smith" },
    { "emailFromAddress": "joe.smith@someplace.com" },
    { "emailSubject": "Sales Invoice" }
]
Show Source
  • Any Object
    Title: Any Object

    This represents any kind of object. The object may or may not have a defined schema.

    This is used by parts of the Content Capture REST API that could vary, or are not known during design time.

Nested Schema : Any Object
Type: object
Title: Any Object

This represents any kind of object. The object may or may not have a defined schema.

This is used by parts of the Content Capture REST API that could vary, or are not known during design time.

Nested Schema : createdBy
Type: object

The user that created the document.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : profile
Type: object

If this audit detail represents a docuument, this is the document profile that has been assigned.

This only applies to audit details on documents. It does not apply to events on audit details of an attachment. It will not be present if the audit details applies to an attachment of a document.

.
Match All
Show Source
  • Document Profile
    Title: Document Profile

    A Document Profile associates a collection of custom metadata fields defined in a Capture procedure with a document. Additionally, it can have associated attachment types.

    These are used in Capture to help categorize and process documents. While a document profile does relate custom metadata fields and attachment types from the procedure to a document, it does not restrict metadata to just those fields or attachments to just those types. It they are used for display/management within the Capture Client.

Nested Schema : step
Type: object

The current processing step, if any, this document is undergoing.

Match All
Show Source
Nested Schema : type
Type: object

If this audit detail represents an attachment to a docuument, this is the attachment type that has been assigned.

This only applies to audit details on attachments of a document. It does not apply to audit details on documents. It will not be present if the audit details applies to a document.

.
Match All
Show Source
  • Attachment Type
    Title: Attachment Type

    An Attachment Type can be used to categorize, and provides process filtering, of attachents of documents.

Nested Schema : updatedBy
Type: object

The last user that updated the document.

Match All
Show Source
  • User Information
    Title: User Information

    This object contains information about a given user of Capture.

    Models use this object to denote some relation between a user and some other object. For instance, a model of the API may define the attribute updatedBy that is a user object. This indicates it was last updated by that given user.

Nested Schema : Document Profile
Type: object
Title: Document Profile

A Document Profile associates a collection of custom metadata fields defined in a Capture procedure with a document. Additionally, it can have associated attachment types.

These are used in Capture to help categorize and process documents. While a document profile does relate custom metadata fields and attachment types from the procedure to a document, it does not restrict metadata to just those fields or attachments to just those types. It they are used for display/management within the Capture Client.

Show Source
Nested Schema : Attachment Type
Type: object
Title: Attachment Type

An Attachment Type can be used to categorize, and provides process filtering, of attachents of documents.

Show Source

400 Response

Bad Request

The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value. The response will be an Error Detail object.

500 Response

Internal Server Error

The server encountered an unexpected condition that prevented it from fulfilling the request. The response will be an Error Detail object.

Back to Top