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

List all Batch Audit Details

get

/capture/api/v1.1/audit/batches

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

As a batch flows through Capture, events occur pertaining to that batch. These events vary by the types of processing defined in the procedure, but are typically milestone events, or error events. As an example, the creation of the batch could be considered a milestone event. Any error as a result of processing would be considered an error 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 collection of documents is supported. If used, the response will contain all the associated Document Audit Detail objects for all documents in the batch. Additionally, the child resource of runtime is supported. When used, if the batch is presently in Capture, it's runtime state information will be returned in the response.

If there are no batch 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 are:

    • runtime
    • documents

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

    Example : ?expand=documents
    Expands the collection of documents of this batch audit detail, if any.

  • The limit parameter accepts a non-negative integer and is used to control the size of the resulting batch 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 batch audit details collection of the query.

    Default Value: 0

  • The orderBy parameter is used to control the ordering (ascending/descending) of results in the batch audit detail collection. This parameter is optional as a batch 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
    • name
    • createdDate
    • lastEventDate

    The attributes of the runtime child resource are also supported, such as runtime.status and runtime.priority. 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 batches. The runtime attributes runtime.state and runtime.lock.step.type are not supported.

    Examples:

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

  • The q parameter accepts a query expression condition that matches the attribute values of the batch audit detail, and is used for filtering results in 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 batch audit detail are supported in a q expression:

    • id
    • name
    • createdDate
    • lastEventDate

    The attributes of the runtime child resource are also supported, such as runtime.state are runtime.priority. 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 batches.

    Examples:

    • ?q=(id eq "636") or (id eq "637")
    • ?q=(runtime.status eq "Assigned Total" and createdDate ge "2021-05-01")
    • ?q=(runtime.priority gt 2)&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 batch audit details in the query.

    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

A list of all the batch audit details.

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

This represents a collection of Batch Audit Detail objects.

Show Source
Nested Schema : items
Type: array

The array of Batch 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
  • Batch Audit Detail
    Title: Batch Audit Detail

    A Batch Audit Detail in Capture is a set of events that occurred for a given batch. These are events such as the batch was created, the batching is being processed, the batch was deleted, etc.

    A Batch Audit Detail also encompasses associated Document Audit Detail objects, which represents events for documents the a given batch.

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

A Batch Audit Detail in Capture is a set of events that occurred for a given batch. These are events such as the batch was created, the batching is being processed, the batch was deleted, etc.

A Batch Audit Detail also encompasses associated Document Audit Detail objects, which represents events for documents the a given batch.

Show Source

  • 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.

  • events

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

  • The unique identifier of the batch.

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

  • links

  • 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

  • runtime

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

Nested Schema : events
Type: array

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

Show Source
Nested Schema : runtime
Type: object

If the batch is presently part of the Capture system, this object will contain its current runtime information. However, if the batch 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 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.

  • 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.

  • 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.

  • 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 : 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 : 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 : 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 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 : 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 : 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 : procedure
Type: object

If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.

Match All
Show Source
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 : Capture Procedure
Type: object
Title: Capture Procedure

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

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.

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