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

List all Batches

get

/capture/api/v1.1/batches

This operation will return a collection of the batches in Capture.

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. expand parameter as well, which is used to include child resources/collections inline. The collection resource of documents is supported in the expand parameter; and will inline all the documents of the batch.

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

Note: If the OAuth token represents an account that is a Capture Administator, the response will contain all batches matching any specified query arguments regardless of procedures. If the OAuth token does not represent an account that is a Capture Administator, meaning it is just a Capture User, the response will contain only those batches initiated from Client Profiles or Import Jobs in which the account has been granted explict access.

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 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:

    • documents

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

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

    Default Value: 50

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

    Default Value: 0

  • The orderBy parameter is used to control the ordering (ascending/descending) of results in the batch collection. This parameter is optional as a batch collection has a default sort order of updatedDate 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.

    All the attributes of a batch are supported in an orderBy with the exception of:

    • state
    • notes
    • error
    • links

    Attributes of the procedure and lock child resources, such as procedure.name and lock.lockedDate, are also supported. However, the attribute lock.step.type is not supported.

    Examples:

    • ?orderBy=id
    • ?orderBy=id;updatedDate:asc
    • ?orderBy=name&orderBy=createdDate:desc
    • ?orderBy=priority:desc
    • ?orderBy=priority:desc;status:asc

  • The q parameter accepts a query expression condition that matches the attribute values of the batch, 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.

    All simple attributes of a batch are supported in a q expression with the exception of:

    • notes
    • error

    Attributes of the procedure and lock child resources, such as procedure.id and lock.lockedDate, are also supported. Additionally, array attributes such as links are not supported; nor are child collections such as documents.

    Examples:

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

    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

A list of all the batches.

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

This represents a collection of Batch objects.

Show Source
Nested Schema : items
Type: array

The array of Batch 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
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

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