REST API for Content Capture

List all Documents

get

/capture/api/v1.1/documents

This operation will return a collection of the documents 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. This operation supports the expand parameter as well, which is used to include child resources/collections inline. The child resource of batch is supported. If that resource is not expanded, then it just contains the summary information of id and name. The collection resource of attachments is also supported in the expand parameter; and will inline all the attachments of the document.

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 documents matching any specified query arguments regardless of procedure, batch, or step. 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 documents that are currently in a step in which the account has been granted explict access.

Request

Supported Media Types

application/json

Query Parameters

expand(optional): string
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 docment 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:
- batch
- attachments
Example : ?expand=batch
Expands the batch child resource of this document.

Example : ?expand=attachments
Expands the collection of attachments of this document, if any.
limit(optional): integer(int32)

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

Default Value: 50
offset(optional): integer(int32)

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

Default Value: 0
orderBy(optional): string
The orderBy parameter is used to control the ordering (ascending/descending) of results in the document collection. This parameter is optional as a document 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 document are supported in an orderBy with the exception of:
- stateToken
- mediaType
- fields
- links
Examples:
- ?orderBy=batch.id
- ?orderBy=batch.id;updatedDate:asc
- ?orderBy=title&orderBy=createdDate:desc
- ?orderBy=size:asc
- ?orderBy=profile.name;size:asc
q(optional): string
The q parameter accepts a query expression condition that matches the attribute values of the document, 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 document are supported in a q expression with the exception of:
- stateToken
- mediaType
Child resource attributes, such as batch.id and profile.name, are also supported. However, array resources such as fields and links, are not supported; nor are child collections such as attachments.

Examples:
- ?q=(step.id eq "06ed7cb1-6b1b-4828-b4ba-c8ab31a45903" and createdDate ge "2021-05-01")
- ?q=(step.id eq "06ed7cb1-6b1b-4828-b4ba-c8ab31a45903")&q=(createdDate ge "2021-05-01")
- ?q=(profile.name eq "Example Document Profile") and (size lt 50000)
- ?q=(updatedDate ge "2021-05-26")
- ?q=(batch.id eq "636") or (batch.id eq "637")
totalResults(optional): boolean

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

Default Value: false

Response

Supported Media Types

application/json

200 Response

A list of all the documents.

Root Schema : Document Collection

Type: object

Title: Document Collection

This represents a collection of Document objects.

Show Source

count: integer(int32)

The total number of records in the current response.
hasMore: boolean

An indicator of whether there are more pages to fetch.
items(optional): array items

The array of Document objects.

This will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.
limit: integer(int32)

The actual page size used by the server. This may not be the same as what client requests.
offset: integer(int32)

The actual index from which the singular resources are returned.
totalResults(optional): integer(int32)

The total number of rows that satisfy the client request (excluding the paging parameters).

{
    "type":"object",
    "title":"Document Collection",
    "description":"<p>This represents a collection of <i>Document</i> objects.</p> \n",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of rows that satisfy the client request (excluding the paging parameters).</p>\n"
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The actual page size used by the server. This may not be the same as what client requests.</p>\n"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of records in the current response.</p>\n"
        },
        "hasMore":{
            "type":"boolean",
            "description":"<p>An indicator of whether there are more pages to fetch.</p>\n"
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The actual index from which the singular resources are returned.</p>\n"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Document"
            },
            "description":"<p>The array of <i>Document</i> objects.</p>\n<p>This will in the order specified by <b>orderBy</b>, or the default sort order of descending by <code>updatedDate</code> if <b>orderBy</b> was not used.\n"
        }
    },
    "required":[
        "limit",
        "count",
        "hasMore",
        "offset"
    ]
}

Nested Schema : items

Type: array

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

Array of: object Document

Title: Document

A Document in Capture is a file combined with custom metadata fields. The metadata fields are defined in Capture procedures, and act as holders of information manged within Capture. A Document can also contain attachments. An Attachment is intended to augment the the Document, and there can be numerous attachments of varing types.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Document"
    },
    "description":"<p>The array of <i>Document</i> objects.</p>\n<p>This will in the order specified by <b>orderBy</b>, or the default sort order of descending by <code>updatedDate</code> if <b>orderBy</b> was not used.\n"
}

Nested Schema : Document

Type: object

Title: Document

A Document in Capture is a file combined with custom metadata fields. The metadata fields are defined in Capture procedures, and act as holders of information manged within Capture. A Document can also contain attachments. An Attachment is intended to augment the the Document, and there can be numerous attachments of varing types.

Show Source

batch(optional): object batch

The Capture Batch that contains this document.
comment(optional): string

A general use comment of this document.
createdBy(optional): object createdBy

The user that created the document.
createdDate(optional): string(date-time)

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.
fields(optional): array fields

This is an array of all the field values available for this document.
id(optional): string

The unique identifier of the document in Capture.
links(optional): array links

HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
mediaType(optional): string

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(optional): object profile

The document profile that has been assigned to this document.
size(optional): integer(int64)

The size, in bytes, of the document.
sourceName(optional): string

The filename of the document when imported.
stateToken(optional): string

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(optional): object step

The current processing step, if any, this document is undergoing.
title(optional): string

The title of the document. This is generally the filename used during document import.
updatedBy(optional): object updatedBy

The last user that updated the document.
updatedDate(optional): string(date-time)

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.

{
    "type":"object",
    "title":"Document",
    "description":"<p>A <i>Document</i> in Capture is a file combined with custom metadata fields. The metadata fields are defined in Capture\nprocedures, and act as holders of information manged within Capture. A <i>Document</i> can also contain attachments. An <i>Attachment</i>\nis intended to augment the the <i>Document</i>, and there can be numerous attachments of varing types.</p>\n",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>The unique identifier of the document in Capture.</p>\n"
        },
        "title":{
            "type":"string",
            "description":"<p>The <i>title</i> of the document. This is generally the filename used during document import.</p>\n"
        },
        "batch":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Batch"
                }
            ],
            "description":"<p>The Capture Batch that contains this document.</p>\n"
        },
        "step":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Step"
                }
            ],
            "description":"<p>The current processing step, if any, this document is undergoing.</p>\n"
        },
        "profile":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/DocumentProfile"
                }
            ],
            "description":"<p>The document profile that has been assigned to this document.</p>\n"
        },
        "stateToken":{
            "type":"string",
            "description":"<p>A generated string value that represents a particular state of the document.</p>\n<p>In general, it is used to allow modifications of the document to proceed. It is essentially saying ...\n<u><i>modify this document if its current <code>stateToken</code> matches this value</i></u>. If the values do\nnot match, the modification is not permitted and the operation results in an error.</p>\n"
        },
        "mediaType":{
            "type":"string",
            "description":"<p>This represents the media type of the document. That is the two-part identifier for file formats and format contents\ntransmitted on the Internet.</p>\n"
        },
        "sourceName":{
            "type":"string",
            "description":"<p>The filename of the document when imported.</p>\n"
        },
        "size":{
            "type":"integer",
            "format":"int64",
            "description":"<p>The size, in bytes, of the document.</p>\n"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FieldValue"
            },
            "description":"<p>This is an array of all the field values available for this document.</p>\n"
        },
        "comment":{
            "type":"string",
            "description":"<p>A general use comment of this document.</p>\n"
        },
        "createdBy":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/User"
                }
            ],
            "description":"<p>The user that created the document.</p>\n"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the document was created. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "updatedBy":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/User"
                }
            ],
            "description":"<p>The last user that updated the document.</p>\n"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the last time the document was updated. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            },
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. This will include at least a <i>canonical</i> related link to the resource.</p>\n"
        }
    }
}

Nested Schema : batch

Type: object

The Capture Batch that contains this document.

Match All

Show Source

object Capture Batch

Title: Capture Batch

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Batch"
        }
    ],
    "description":"<p>The Capture Batch that contains this document.</p>\n"
}

Nested Schema : createdBy

Type: object

The user that created the document.

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/User"
        }
    ],
    "description":"<p>The user that created the document.</p>\n"
}

Nested Schema : fields

Type: array

This is an array of all the field values available for this document.

Show Source

Array of: object Field Value

Title: Field Value

A field value is a Capture metadata field that combines the basic field definition and an actual value.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FieldValue"
    },
    "description":"<p>This is an array of all the field values available for this document.</p>\n"
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.

Show Source

Array of: object HATEOAS Link
Title: HATEOAS Link
This is a HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Internet Assigned Numbers Authority (IANA) maintains a registry of link relations for use in a HATEOAS link. These are well known relations and have specific meanings. If they are applicale in Capture, they are used. For instance, canonical is well known relation, and Capture does use it.

Capture does define its own link relations in certain cases because none of the registered relations provided the proper meaning. As defined in RFC for Web Linking (RFC 8288) the relation needs to be a URI. The following link relations are defined by Capture:
- urn:oce:capture:document-content - Represents the link used to obtain a document's content
- urn:oce:capture:document-complete - Represents the link used to complete processing a document in a Step task queue
- urn:oce:capture:attachment-content - Represents the link used to obtain an attachment's content

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    },
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. This will include at least a <i>canonical</i> related link to the resource.</p>\n"
}

Nested Schema : profile

Type: object

The document profile that has been assigned to this document.

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/DocumentProfile"
        }
    ],
    "description":"<p>The document profile that has been assigned to this document.</p>\n"
}

Nested Schema : step

Type: object

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

Match All

Show Source

object Procedure Step

Title: Procedure Step

A step in a procedure flow.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Step"
        }
    ],
    "description":"<p>The current processing step, if any, this document is undergoing.</p>\n"
}

Nested Schema : updatedBy

Type: object

The last user that updated the document.

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/User"
        }
    ],
    "description":"<p>The last user that updated the document.</p>\n"
}

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(optional): object createdBy

The user that created the batch.
createdDate(optional): string(date-time)

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.
error(optional): string

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.
id(optional): string

The unique identifier of the batch.
links(optional): array links

HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
lock(optional): object 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.
name(optional): string

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
notes(optional): string

User supplied general notes associated with a batch.
priority(optional): integer(int32)

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(optional): object procedure

The Capture Procedure associated with this batch.
state(optional): string
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.
status(optional): string

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(optional): object updatedBy

The last user that updated the batch. This can be the Capture system.
updatedDate(optional): string(date-time)

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.

{
    "type":"object",
    "title":"Capture Batch",
    "description":"<p>A collection of documents in Capture that represent a unit of work in a procedure.</p>\n",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>The unique identifier of the batch.</p>\n"
        },
        "name":{
            "type":"string",
            "description":"<p>The name given to the batch.</p>\n<p>When Capture creates a batch, the name is some defined prefix and a sequence number. For example, <b><i>inv_4781</i></b></p>\n"
        },
        "procedure":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Procedure"
                }
            ],
            "description":"<p>The Capture Procedure associated with this batch.</p>\n"
        },
        "state":{
            "type":"string",
            "default":"READY",
            "description":"<p>The current state of the batch.</p>\n<ul>\n  <li><code>READY</code> - The standard resting state of a batch. It is available to be locked by a client.</li>\n  <li><code>LOCKED</code> - The batch is locked by a client for editing, such as adding/removing documents and setting metadata field values.</li>\n  <li><code>ERROR</code> - An error occurred during processing. It is available to be locked by a client for edits to correct processing errors.</li>\n  <li><code>PROCESSING</code> - Capture is presently processing the batch. The batch is in one of the jobs defined in the Capture procedure.</li>\n</ul>\n"
        },
        "priority":{
            "type":"integer",
            "format":"int32",
            "default":0,
            "minimum":0,
            "maximum":10,
            "description":"<p>A user specified priority of the batch.</p>\n<p>This value is used prioritize the batch for a user's attention. Its used to filter and sort batches for viewing in the client.</p>\n"
        },
        "status":{
            "type":"string",
            "description":"<p>The current status assigned to the batch.</p>\n<p>The status values are defined in the procedure and can be assigned during batch creation, and during transitions between processing jobs.</p>\n"
        },
        "notes":{
            "type":"string",
            "description":"<p>User supplied general notes associated with a batch.</p>\n"
        },
        "error":{
            "type":"string",
            "description":"<p>The current error message of the batch, if any.</p>\n<p>If the batch is in the <b>ERROR</b> <code>state</code>, this will contain the error message detailing why the batch failed processing. This message\nwill remain until the batch re-enters processing.</p>\n"
        },
        "lock":{
            "type":"object",
            "description":"<p>If the <b>batch</b> is <i>locked</i> (by a user creating/editing the batch or if Capture is currently processing the batch), this object will\ncontain information about the lock. The <code>state</code> of the batch determines if this object exists.</p>\n",
            "properties":{
                "workstation":{
                    "type":"string",
                    "description":"<p>If the <b>batch</b> is <i>locked</i> within a Capture Client instance, this attribute will contain the computer name where the Capture Client instance\n<i>locked</i> the batch.</p>\n"
                },
                "lockedBy":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/User"
                        }
                    ],
                    "description":"<p>If the <b>batch</b> is <i>locked</i> within a Capture Client instance, this attribute will contain the user that <i>locked</i> the batch.</p>\n"
                },
                "step":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/Step"
                        }
                    ],
                    "description":"<p>If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.</p>\n"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>This identifies when the batch was locked. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
                }
            }
        },
        "createdBy":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/User"
                }
            ],
            "description":"<p>The user that created the batch.</p>\n"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the batch was created. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "updatedBy":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/User"
                }
            ],
            "description":"<p>The last user that updated the batch. This can be the Capture system.</p>\n"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the last time the batch was updated. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            },
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. This will include at least a <i>canonical</i> related link to the resource.</p>\n"
        }
    }
}

Nested Schema : createdBy

Type: object

The user that created the batch.

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/User"
        }
    ],
    "description":"<p>The user that created the batch.</p>\n"
}

Nested Schema : links

Type: array

HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.

Show Source

Array of: object HATEOAS Link
Title: HATEOAS Link
This is a HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Internet Assigned Numbers Authority (IANA) maintains a registry of link relations for use in a HATEOAS link. These are well known relations and have specific meanings. If they are applicale in Capture, they are used. For instance, canonical is well known relation, and Capture does use it.

Capture does define its own link relations in certain cases because none of the registered relations provided the proper meaning. As defined in RFC for Web Linking (RFC 8288) the relation needs to be a URI. The following link relations are defined by Capture:
- urn:oce:capture:document-content - Represents the link used to obtain a document's content
- urn:oce:capture:document-complete - Represents the link used to complete processing a document in a Step task queue
- urn:oce:capture:attachment-content - Represents the link used to obtain an attachment's content

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    },
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. This will include at least a <i>canonical</i> related link to the resource.</p>\n"
}

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

lockedBy(optional): object lockedBy

If the batch is locked within a Capture Client instance, this attribute will contain the user that locked the batch.
lockedDate(optional): string(date-time)

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

If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.
workstation(optional): string

If the batch is locked within a Capture Client instance, this attribute will contain the computer name where the Capture Client instance locked the batch.

{
    "type":"object",
    "description":"<p>If the <b>batch</b> is <i>locked</i> (by a user creating/editing the batch or if Capture is currently processing the batch), this object will\ncontain information about the lock. The <code>state</code> of the batch determines if this object exists.</p>\n",
    "properties":{
        "workstation":{
            "type":"string",
            "description":"<p>If the <b>batch</b> is <i>locked</i> within a Capture Client instance, this attribute will contain the computer name where the Capture Client instance\n<i>locked</i> the batch.</p>\n"
        },
        "lockedBy":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/User"
                }
            ],
            "description":"<p>If the <b>batch</b> is <i>locked</i> within a Capture Client instance, this attribute will contain the user that <i>locked</i> the batch.</p>\n"
        },
        "step":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Step"
                }
            ],
            "description":"<p>If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.</p>\n"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the batch was locked. The date/time in ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>) UTC,\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        }
    }
}

Nested Schema : procedure

Type: object

The Capture Procedure associated with this batch.

Match All

Show Source

object Capture Procedure

Title: Capture Procedure

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Procedure"
        }
    ],
    "description":"<p>The Capture Procedure associated with this batch.</p>\n"
}

Nested Schema : updatedBy

Type: object

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

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/User"
        }
    ],
    "description":"<p>The last user that updated the batch. This can be the Capture system.</p>\n"
}

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

name: string

The user's name.

{
    "type":"object",
    "title":"User Information",
    "description":"<p>This object contains information about a given user of Capture.</p>\n\n<p>Models use this object to denote some relation between a user and some other object. For instance, a\nmodel of the API may define the attribute <code>updatedBy</code> that is a user object. This indicates it\nwas last updated by that given user.</p>\n",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>The user's name.</p>\n"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : HATEOAS Link

Type: object

Title: HATEOAS Link

This is a HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Internet Assigned Numbers Authority (IANA) maintains a registry of link relations for use in a HATEOAS link. These are well known relations and have specific meanings. If they are applicale in Capture, they are used. For instance, canonical is well known relation, and Capture does use it.

Capture does define its own link relations in certain cases because none of the registered relations provided the proper meaning. As defined in RFC for Web Linking (RFC 8288) the relation needs to be a URI. The following link relations are defined by Capture:

urn:oce:capture:document-content - Represents the link used to obtain a document's content
urn:oce:capture:document-complete - Represents the link used to complete processing a document in a Step task queue
urn:oce:capture:attachment-content - Represents the link used to obtain an attachment's content

Show Source

href(optional): string

The target resource URI. URI RFC 3986 or URI Template RFC 6570. If the value is set to URI Template, then the templated property must be set to true.
mediaType(optional): string

Default Value: application/json

Media type, as defined by RFC 2046, describing the link target. The property can be assumed to be application/json if the property is not present.
method(optional): string
Default Value: GET
HTTP method for requesting the target of the link.

Valid values are:
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
The property can be assumed to be GET if the property is not present.
profile(optional): string(uri)

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource. If not available, this property will not be present.
rel(optional): string

Name of the link relation that, in addition to the type property, can be used to retrieve link details.
templated(optional): boolean

Default Value: false

Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

{
    "type":"object",
    "title":"HATEOAS Link",
    "description":"<p>This is a <a href=\"https://en.wikipedia.org/wiki/HATEOAS\">HATEOAS</a> link and related metadata. If responses provide links\n(for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the\nproperties defined on this link structure.</p>\n\n<p>Internet Assigned Numbers Authority (IANA) maintains a registry of <a href=\"https://www.iana.org/assignments/link-relations/link-relations.xml\">link relations</a>\nfor use in a HATEOAS link. These are well known relations and have specific meanings. If they are applicale in Capture, they are used.\nFor instance, <b>canonical</b> is well known relation, and Capture does use it.</p>\n\n<p>Capture does define its own link relations in certain cases because none of the registered relations provided the proper meaning.\nAs defined in RFC for Web Linking (<a href=\"https://datatracker.ietf.org/doc/html/rfc8288\">RFC 8288</a>) the relation needs to be\na URI. The following link relations are defined by Capture:</p>\n<ul>\n  <li><code>urn:oce:capture:document-content</code> - Represents the link used to obtain a document's content</li>\n  <li><code>urn:oce:capture:document-complete</code> - Represents the link used to complete processing a document in a <b>Step</b> task queue</li>\n  <li><code>urn:oce:capture:attachment-content</code> - Represents the link used to obtain an attachment's content</li>\n</ul>\n",
    "properties":{
        "rel":{
            "type":"string",
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>\n"
        },
        "href":{
            "type":"string",
            "description":"<p>The target resource URI. URI <a href=\"https://datatracker.ietf.org/doc/html/rfc3986\">RFC 3986</a> or URI Template\n<a href=\"https://datatracker.ietf.org/doc/html/rfc6570\">RFC 6570</a>. If the value is set to URI Template, then the <code>templated</code>\nproperty must be set to <code>true</code>.</p>\n"
        },
        "templated":{
            "type":"boolean",
            "default":false,
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the\nproperty is not present.</p>\n"
        },
        "mediaType":{
            "type":"string",
            "default":"application/json",
            "description":"<p>Media type, as defined by <a href=\"https://datatracker.ietf.org/doc/html/rfc2046\">RFC 2046</a>, describing the link target. The property can be assumed to be <code>application/json</code> if\nthe property is not present.</p>\n"
        },
        "method":{
            "type":"string",
            "default":"GET",
            "description":"<p>HTTP method for requesting the target of the link.</p>\n<p>Valid values are:</p>\n<ul>\n  <li><code>OPTIONS</code> - HTTP OPTIONS</li>\n  <li><code>HEAD</code> - HTTP HEAD</li>\n  <li><code>GET</code> - HTTP GET</li>\n  <li><code>POST</code> - HTTP POST</li>\n  <li><code>PUT</code> - HTTP PUT</li>\n  <li><code>PATCH</code> - HTTP PATCH</li>\n  <li><code>DELETE</code> - HTTP DELETE</li>\n</ul>\n<p>The property can be assumed to be <code>GET</code> if the property is not present.</p>\n"
        },
        "profile":{
            "type":"string",
            "format":"uri",
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.\nIf not available, this property will not be present.</p>\n"
        }
    }
}

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

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/User"
        }
    ],
    "description":"<p>If the <b>batch</b> is <i>locked</i> within a Capture Client instance, this attribute will contain the user that <i>locked</i> the batch.</p>\n"
}

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

object Procedure Step

Title: Procedure Step

A step in a procedure flow.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Step"
        }
    ],
    "description":"<p>If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.</p>\n"
}

Nested Schema : Procedure Step

Type: object

Title: Procedure Step

A step in a procedure flow.

Show Source

id(optional): string

The unique identifier of the step within the procedure.
name(optional): string

The name given to the step when created. For instance, the name of the processing job or commit profile.
type(optional): string

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

{
    "type":"object",
    "title":"Procedure Step",
    "description":"<p>A step in a procedure flow.</p>\n",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>The unique identifier of the step within the procedure.</p>\n"
        },
        "name":{
            "type":"string",
            "description":"<p>The name given to the step when created. For instance, the name of the processing job or commit profile.</p>\n"
        },
        "type":{
            "type":"string",
            "description":"<p>The type of step. Some example include: <i>External Processor</i>, <i>TIFF Conversion Processor</i>, <i>Asset Lookup Processor</i>, etc.</p>\n"
        }
    }
}

Nested Schema : Capture Procedure

Type: object

Title: Capture Procedure

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

Show Source

id(optional): string

The unique identifier of the procedure in Capture.
name(optional): string

The name given to the procedure when created

{
    "type":"object",
    "title":"Capture Procedure",
    "description":"<p>A Capture Procedure defines metadata and procesing steps of a flow.</p>\n",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>The unique identifier of the procedure in Capture.</p>\n"
        },
        "name":{
            "type":"string",
            "description":"<p>The name given to the procedure when created</p>\n"
        }
    }
}

Nested Schema : Field Value

Type: object

Title: Field Value

A field value is a Capture metadata field that combines the basic field definition and an actual value.

Show Source

dataType(optional): string
Default Value: ALPHA_NUMERIC
The data type of the field. Capture supports the following six data types:
- NUMERIC - Integer based number value
- ALPHA_NUMERIC - Any general text or string value
- DATE - A date/time value in the form of ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'), as governed by RFC 3339
- FLOAT - Floating point number values
- ITEM_REFERENCE - A pointer to a content item in Oracle Content Management
- ASSET_REFERENCE - A pointer to a digital asset in Oracle Content Management
- CATEGORY_REFERENCE - A pointer to a taxonomy category in Oracle Content Management
- LANGUAGE - A language code as defined by RFC 4647.
name(optional): string

The name of the field.
value(optional): string

The actual value of this metadata field as it pertains to the given Capture document.

Fields do not initially have values. They must be set. This is either done through a default value in the metadata field definition, user supplied in Capture Client, or some Capture processing job.

The fields in Capture do not have a concept of a null value. The fields either have a value or do not have a value. Blank means there is no value.

{
    "type":"object",
    "title":"Field Value",
    "description":"<p>A field value is a Capture metadata field that combines the basic field definition and an actual value.</p>\n",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>The name of the field.</p>\n"
        },
        "dataType":{
            "type":"string",
            "default":"ALPHA_NUMERIC",
            "description":"<p>The data type of the field. Capture supports the following six data types:</p>\n<ul>\n  <li><code>NUMERIC</code> - Integer based number value</li>\n  <li><code>ALPHA_NUMERIC</code> - Any general text or string value</li>\n  <li><code>DATE</code> - A date/time value in the form of ISO-8601 Date Time format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>), as governed by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a></li>\n  <li><code>FLOAT</code> - Floating point number values</li>\n  <li><code>ITEM_REFERENCE</code> - A <i>pointer</i> to a content item in Oracle Content Management</li>\n  <li><code>ASSET_REFERENCE</code> - A <i>pointer</i> to a digital asset in Oracle Content Management</li>\n  <li><code>CATEGORY_REFERENCE</code> - A <i>pointer</i> to a taxonomy category in Oracle Content Management</li>\n  <li><code>LANGUAGE</code> - A language code as defined by <a href=\"https://datatracker.ietf.org/doc/html/rfc4647\">RFC 4647</a>.\n</ul>\n"
        },
        "value":{
            "type":"string",
            "description":"<p>The actual value of this metadata field as it pertains to the given Capture document.</p>\n<p>Fields do not initially have values. They must be set. This is either done through a default value in the\nmetadata field definition, user supplied in Capture Client, or some Capture processing job.</p>\n<p>The fields in Capture do not have a concept of a <b>null</b> value. The fields either have a value or do not have\na value. <i>Blank</i> means there is no value.</p>\n"
        }
    }
}

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

id(optional): string

The unique identifier of the document profile.
name(optional): string

The name given to the document profile.

{
    "type":"object",
    "title":"Document Profile",
    "description":"<p>A <i>Document Profile</i> associates a collection of custom metadata fields defined in a Capture procedure with a document. Additionally,\nit can have associated attachment types.</p>\n\n<p>These are used in Capture to help categorize and process documents. While a document profile does relate custom metadata fields and\nattachment types from the procedure to a document, it does not restrict metadata to just those fields or attachments to just those types.\nIt they are used for display/management within the Capture Client.</p>\n",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>The unique identifier of the document profile.</p>\n"
        },
        "name":{
            "type":"string",
            "description":"<p>The name given to the document profile.</p>\n"
        }
    }
}

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.

Examples

Example 1:

The following example shows how to list all documents.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents'

This gets a list of all the documents in Content Capture.

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 4,
  "limit": 4,
       "items": [
                 {
               "id": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
               "title": "Invoice20210810124042797000.tiff",
                "batch": {
                         "id": "864",
                         "name": "inv_53"
                        },
                "step": {
                          "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                          "name": "Find Invoice Date",
                          "type": "External Processor"
                        },
               "profile": {
                           "id": "0cf49a7f-cb9e-4c8c-8541-118a9d997981",
                           "name": "Invoice Profile Tires"
                        },
               "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
               "mediaType": "image/tiff",
               "sourceName": "Invoice20210810124042797000.TIF",
               "size": 32709,
               "fields": [
                          {
                           "name": "Invoice Date",
                           "dataType": "DATE",
                           "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
            "createdBy": {
                          "name": "ssvrint.mtadmin"
                        },
          "createdDate": "2021-08-18T05:01:38.453Z",
            "updatedBy": {
                         "name": "ssvrint.mtadmin"
                        },
          "updatedDate": "2021-08-17T05:01:41.419Z",
                "links": [
                            {
                             "rel": "canonical",
                             "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    },
                 {
          "id": "59447318-b145-41b7-be71-454840b913a9",
          "title": "Invoice20210810124042798000.tiff",
          "batch": {
                            "id": "864",
                            "name": "inv_53"
                        },
          "step": {
                       "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                       "name": "Find Invoice Date",
                       "type": "External Processor"
                        },
       "profile": {
                     "id": "64e58456-acd1-448f-b7a3-ed76b978f064",
                     "name": "Invoice Profile Struts"
                        },
      "stateToken": "d732c7864c45b405900d086dc54efd09",
       "mediaType": "image/tiff",
      "sourceName": "Invoice20210810124042798000.TIF",
            "size": 34781,
                "fields": [
                           {
                             "name": "Invoice Date",
                             "dataType": "DATE",
                             "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
              "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
              "createdDate": "2021-08-17T05:01:37.869Z",
                "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
             "updatedDate": "2021-08-18T05:01:41.047Z",
                        "links": [
                            {
                            "rel": "canonical",
                            "href": "http://server.example.com/capture/api/v1/documents/59447318-b145-41b7-be71-454840b913a9"
                            },
                            {
                            "rel": "urn:oce:capture:document-content",
                            "href": "http://server.example.com/capture/api/v1/documents/59447318-b145-41b7-be71-454840b913a9/content",
                            "mediaType": "image/tiff"
                            }
                        ]
                    },
                    {
           "id": "d6ebb4cc-31b7-4208-9d9f-228b569eedf9",
         "title": "Invoice20210810124044319100.tiff",
         "batch": {
                    "id": "896",
                    "name": "inv_68"
                    },
         "step": {
                    "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                   "name": "Find Invoice Date",
                   "type": "External Processor"
                        },
         "profile": {
                     "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                    "name": "Invoice Profile Shocks"
                        },
        "stateToken": "840e99f711c54fccaa168c02e9c93236",
        "mediaType": "image/tiff",
       "sourceName": "Invoice20210810124044319100.TIF",
             "size": 33417,
           "fields": [
                       {
                           "name": "Invoice Date",
                           "dataType": "DATE",
                           "value": ""
                            },
                            {
                            "name": "Invoice Number",
                            "dataType": "NUMERIC",
                            "value": ""
                            },
                            {
                             "name": "Company Name",
                             "dataType": "ALPHA_NUMERIC",
                             "value": ""
                            },
                            {
                              "name": "Invoice Total",
                              "dataType": "FLOAT",
                              "value": ""
                            }
                        ],
               "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
             "createdDate": "2021-08-18T05:01:37.537Z",
               "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
             "updatedDate": "2021-08-17T05:01:40.974Z",
                   "links": [
                            {
                             "rel": "canonical",
                             "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9"
                            },
                            {
                             "rel": "urn:oce:capture:document-content",
                             "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9/content",
                             "mediaType": "image/tiff"
                            }
                        ]
                    },
                {
                 "id": "e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e",
                 "title": "Invoice20210810124043522000.tiff",
                  "batch": {
                            "id": "896",
                            "name": "inv_68"
                        },
                  "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                  "profile": {
                            "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                            "name": "Invoice Profile Shocks"
                        },
                   "stateToken": "995bf46bc1eb4dfc9908d7c887a77bb6",
                   "mediaType": "image/tiff",
                   "sourceName": "Invoice20210810124043522000.TIF",
                        "size": 39457,
                        "fields": [
                            {
                              "name": "Invoice Date",
                              "dataType": "DATE",
                              "value": ""
                            },
                            {
                             "name": "Invoice Number",
                             "dataType": "NUMERIC",
                             "value": ""
                            },
                            {
                             "name": "Company Name",
                             "dataType": "ALPHA_NUMERIC",
                             "value": ""
                            },
                            {
                              "name": "Invoice Total",
                              "dataType": "FLOAT",
                              "value": ""
                            }
                        ],
               "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
               "createdDate": "2021-08-17T05:01:37.181Z",
                 "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
              "updatedDate": "2021-08-18T05:01:40.517Z",
                    "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    }
                ]
             }

Example 2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents?q=(batch.name eq \"inv_68\")&orderBy=createdDate:asc'

This gets a list of the docments in Content Capture, filtered by batch name and ordered by the creation date (ascending).

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 2,
    "items": [
                {
                  "id": "e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e",
                  "title": "Invoice20210810124043522000.tiff",
                  "batch": {
                            "id": "896",
                            "name": "inv_68"
                        },
                  "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                 "profile": {
                            "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                            "name": "Invoice Profile Shocks"
                        },
                 "stateToken": "995bf46bc1eb4dfc9908d7c887a77bb6",
                  "mediaType": "image/tiff",
                 "sourceName": "Invoice20210810124043522000.TIF",
                       "size": 39457,
                     "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
                  "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                  "createdDate": "2021-08-17T05:01:37.181Z",
                    "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                   pdatedDate": "2021-08-18T05:01:40.517Z",
                       "links": [
                            {
                           "rel": "canonical",
                           "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e"
                            },
                            {
                           "rel": "urn:oce:capture:document-content",
                           "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e/content",
                           "mediaType": "image/tiff"
                            }
                        ]
                    },
                    {
                      "id": "d6ebb4cc-31b7-4208-9d9f-228b569eedf9",
                      "title": "Invoice20210810124044319100.tiff",
                      "batch": {
                            "id": "896",
                            "name": "inv_68"
                        },
                        "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                        "profile": {
                            "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                            "name": "Invoice Profile Shocks"
                        },
                        "stateToken": "840e99f711c54fccaa168c02e9c93236",
                        "mediaType": "image/tiff",
                        "sourceName": "Invoice20210810124044319100.TIF",
                        "size": 33417,
                        "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
                        "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "createdDate": "2021-08-18T05:01:37.537Z",
                        "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "updatedDate": "2021-08-17T05:01:40.974Z",
                        "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    }
                ]
            }

Example 3:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents?q=(profile.id eq \"64e58456-acd1-448f-b7a3-ed76b978f064\" and updatedDate gt \"2021-07-01\")"'

This gets a list of the docments in Content Capture, with a given document profile and a last modification date greater than July 1, 2021.

Response Body

{
     "hasMore": false,
     "offset": 0,
     "count": 1,
     "limit": 1,
                "items": [
                    {
                        "id": "59447318-b145-41b7-be71-454840b913a9",
                        "title": "Invoice20210810124042798000.tiff",
                        "batch": {
                            "id": "864",
                            "name": "inv_53"
                        },
                        "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                        "profile": {
                            "id": "64e58456-acd1-448f-b7a3-ed76b978f064",
                            "name": "Invoice Profile Struts"
                        },
                        "stateToken": "d732c7864c45b405900d086dc54efd09",
                        "mediaType": "image/tiff",
                        "sourceName": "Invoice20210810124042798000.TIF",
                        "size": 34781,
                        "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
                        "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "createdDate": "2021-08-17T05:01:37.869Z",
                        "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "updatedDate": "2021-08-18T05:01:41.047Z",
                        "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/capture/api/v1/documents/59447318-b145-41b7-be71-454840b913a9"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/59447318-b145-41b7-be71-454840b913a9/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    }
                ]
            }

Example 4:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents?offset=2&limit=2'

This example shows how to use paging (limit, offset) to get a subset of documents.

Response Body

{
   "hasMore": false,
   "offset": 2,
   "count": 2,
   "limit": 2,
                  "items": [
                       {
                        "id": "d6ebb4cc-31b7-4208-9d9f-228b569eedf9",
                        "title": "Invoice20210810124044319100.tiff",
                        "batch": {
                            "id": "896",
                            "name": "inv_68"
                        },
                        "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                        "profile": {
                            "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                            "name": "Invoice Profile Shocks"
                        },
                        "stateToken": "840e99f711c54fccaa168c02e9c93236",
                        "mediaType": "image/tiff",
                        "sourceName": "Invoice20210810124044319100.TIF",
                        "size": 33417,
                        "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
                        "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "createdDate": "2021-08-18T05:01:37.537Z",
                        "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "updatedDate": "2021-08-17T05:01:40.974Z",
                        "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/d6ebb4cc-31b7-4208-9d9f-228b569eedf9/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    },
                    {
                        "id": "e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e",
                        "title": "Invoice20210810124043522000.tiff",
                        "batch": {
                            "id": "896",
                            "name": "inv_68"
                        },
                        "step": {
                            "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                            "name": "Find Invoice Date",
                            "type": "External Processor"
                        },
                       "profile": {
                            "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                            "name": "Invoice Profile Shocks"
                        },
                        "stateToken": "995bf46bc1eb4dfc9908d7c887a77bb6",
                        "mediaType": "image/tiff",
                        "sourceName": "Invoice20210810124043522000.TIF",
                        "size": 39457,
                        "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": ""
                            },
                            {
                                "name": "Invoice Number",
                                "dataType": "NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Company Name",
                                "dataType": "ALPHA_NUMERIC",
                                "value": ""
                            },
                            {
                                "name": "Invoice Total",
                                "dataType": "FLOAT",
                                "value": ""
                            }
                        ],
                        "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "createdDate": "2021-08-17T05:01:37.181Z",
                        "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "updatedDate": "2021-08-18T05:01:40.517Z",
                        "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e"
                            },
                            {
                                "rel": "urn:oce:capture:document-content",
                                "href": "http://server.example.com/capture/api/v1/documents/e2a1853e-9675-4c7d-8c33-e0c5f2ec5f3e/content",
                                "mediaType": "image/tiff"
                            }
                        ]
                    }
                ]
            }

Example 5:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents?q=(batchName eq \"epe_36\")'

This example shows the error response when attempting to filter by an attribute that does not exist.

Response Body

{
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "The attribute 'batchName' is not a valid query attribute."
 }