Last updated: March 2023.
", "version":"2023.03.21", "x-summary":"The REST API for Content Capture provides a way to integrate and augment the overall processing capabilities of Content Capture in Oracle Content Management." }, "basePath":"/capture/api/v1.1", "schemes":[ "https" ], "tags":[ { "name":"Attachments", "description":"Management of Document Attachments in Capture" }, { "name":"Auditing", "description":"Query and Analize Batch and Document Processing" }, { "name":"Batches", "description":"Management of Batches in Capture" }, { "name":"Documents", "description":"Management of Documents in Capture" }, { "name":"Steps", "description":"Query and Update Processing Task Queues" }, { "name":"System", "description":"System Level Operations" } ], "consumes":[ "application/json" ], "produces":[ "application/json" ], "definitions":{ "AnyObject":{ "type":"object", "title":"Any Object", "description":"This represents any kind of object. The object may or may not have a defined schema.
\nThis is used by parts of the Content Capture REST API that could vary, or are not known during design time.
\n" }, "ErrorDetail":{ "type":"object", "title":"Error Detail", "description":"This represents an error in the system, and is the response object returned.
\n", "properties":{ "type":{ "type":"string", "format":"URI", "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
\n" }, "title":{ "type":"string", "description":"Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.
Corresponding HTTP status code for the error.
\n" }, "detail":{ "type":"string", "description":"Description specific to this occurrence of the problem. The human-readable, potentially multi-line, description the problem in more details.
\n" }, "instance":{ "type":"string", "format":"URI", "description":"URI to the link that provides more detail about the error.
\n" }, "o:errorCode":{ "type":"string", "description":"Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.
XPath or JSON path to indicate where the error occurs.
\n" }, "o:errorDetails":{ "type":"array", "title":"Error Details", "items":{ "$ref":"#/definitions/ErrorDetail" } } }, "required":[ "type", "title" ] }, "SystemInfo":{ "type":"object", "title":"System Information", "description":"This object defines basic Capture system information, such as version and build date.
\n", "properties":{ "name":{ "type":"string", "description":"Name of the Content Capture REST API.
\n" }, "apiVersion":{ "type":"string", "description":"The particular version of the REST API. It will resemble something like: v1, v1.1, v1.1.1, etc.\ndepending on the actual version. However, it will always begin with v.
\n" }, "buildTimestamp":{ "type":"string", "format":"date-time", "description":"The date/time of the REST API build in ISO-8601 Instant format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'),\ngoverned by RFC 3339.
The build version of the REST API.
\n" } } }, "Link":{ "type":"object", "title":"HATEOAS Link", "description":"This is a HATEOAS link and related metadata. If responses provide links\n(for example, a self link to the resource itself) the links provided will include one or more of the\nproperties defined on this link structure.
Internet Assigned Numbers Authority (IANA) maintains a registry of link relations\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, canonical is well known relation, and Capture does use it.
\n\nCapture 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 (RFC 8288) the relation needs to be\na URI. The following link relations are defined by Capture:
\nurn:oce:capture:document-content - Represents the link used to obtain a document's contenturn:oce:capture:document-complete - Represents the link used to complete processing a document in a Step task queueurn:oce:capture:attachment-content - Represents the link used to obtain an attachment's contentName of the link relation that, in addition to the type property, can be used to retrieve link details.
\n" }, "href":{ "type":"string", "description":"The target resource URI. URI RFC 3986 or URI Template\nRFC 6570. If the value is set to URI Template, then the templated\nproperty must be set to true.
Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the\nproperty is not present.
Media type, as defined by RFC 2046, describing the link target. The property can be assumed to be application/json if\nthe property is not present.
HTTP method for requesting the target of the link.
\nValid values are:
\nOPTIONS - HTTP OPTIONSHEAD - HTTP HEADGET - HTTP GETPOST - HTTP POSTPUT - HTTP PUTPATCH - HTTP PATCHDELETE - HTTP DELETEThe property can be assumed to be GET if the property is not present.
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.
\n" } } }, "User":{ "type":"object", "title":"User Information", "description":"This object contains information about a given user of Capture.
\n\nModels 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 updatedBy that is a user object. This indicates it\nwas last updated by that given user.
The user's name.
\n" } }, "required":[ "name" ] }, "Procedure":{ "type":"object", "title":"Capture Procedure", "description":"A Capture Procedure defines metadata and procesing steps of a flow.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the procedure in Capture.
\n" }, "name":{ "type":"string", "description":"The name given to the procedure when created
\n" } } }, "Step":{ "type":"object", "title":"Procedure Step", "description":"A step in a procedure flow.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the step within the procedure.
\n" }, "name":{ "type":"string", "description":"The name given to the step when created. For instance, the name of the processing job or commit profile.
\n" }, "type":{ "type":"string", "description":"The type of step. Some example include: External Processor, TIFF Conversion Processor, Asset Lookup Processor, etc.
\n" } } }, "Batch":{ "type":"object", "title":"Capture Batch", "description":"A collection of documents in Capture that represent a unit of work in a procedure.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the batch.
\n" }, "name":{ "type":"string", "description":"The name given to the batch.
\nWhen Capture creates a batch, the name is some defined prefix and a sequence number. For example, inv_4781
\n" }, "procedure":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Procedure" } ], "description":"The Capture Procedure associated with this batch.
\n" }, "state":{ "type":"string", "default":"READY", "description":"The current state of the batch.
\nREADY - 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.A user specified priority of the batch.
\nThis value is used prioritize the batch for a user's attention. Its used to filter and sort batches for viewing in the client.
\n" }, "status":{ "type":"string", "description":"The current status assigned to the batch.
\nThe status values are defined in the procedure and can be assigned during batch creation, and during transitions between processing jobs.
\n" }, "notes":{ "type":"string", "description":"User supplied general notes associated with a batch.
\n" }, "error":{ "type":"string", "description":"The current error message of the batch, if any.
\nIf the batch is in the ERROR state, this will contain the error message detailing why the batch failed processing. This message\nwill remain until the batch re-enters processing.
If the batch is locked (by a user creating/editing the batch or if Capture is currently processing the batch), this object will\ncontain information about the lock. The state of the batch determines if this object exists.
If the batch is locked within a Capture Client instance, this attribute will contain the computer name where the Capture Client instance\nlocked the batch.
\n" }, "lockedBy":{ "type":"object", "allOf":[ { "$ref":"#/definitions/User" } ], "description":"If the batch is locked within a Capture Client instance, this attribute will contain the user that locked the batch.
\n" }, "step":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Step" } ], "description":"If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.
\n" }, "lockedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The user that created the batch.
\n" }, "createdDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The last user that updated the batch. This can be the Capture system.
\n" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
\n" } } }, "DocumentProfile":{ "type":"object", "title":"Document Profile", "description":"A Document Profile associates a collection of custom metadata fields defined in a Capture procedure with a document. Additionally,\nit can have associated attachment types.
\n\nThese 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.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the document profile.
\n" }, "name":{ "type":"string", "description":"The name given to the document profile.
\n" } } }, "FieldValue":{ "type":"object", "title":"Field Value", "description":"A field value is a Capture metadata field that combines the basic field definition and an actual value.
\n", "properties":{ "name":{ "type":"string", "description":"The name of the field.
\n" }, "dataType":{ "type":"string", "default":"ALPHA_NUMERIC", "description":"The data type of the field. Capture supports the following six data types:
\nNUMERIC - Integer based number valueALPHA_NUMERIC - Any general text or string valueDATE - 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 3339FLOAT - Floating point number valuesITEM_REFERENCE - A pointer to a content item in Oracle Content ManagementASSET_REFERENCE - A pointer to a digital asset in Oracle Content ManagementCATEGORY_REFERENCE - A pointer to a taxonomy category in Oracle Content ManagementLANGUAGE - A language code as defined by RFC 4647.\nThe actual value of this metadata field as it pertains to the given Capture document.
\nFields 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.
\nThe fields in Capture do not have a concept of a null value. The fields either have a value or do not have\na value. Blank means there is no value.
\n" } } }, "Document":{ "type":"object", "title":"Document", "description":"A Document 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 Document can also contain attachments. An Attachment\nis intended to augment the the Document, and there can be numerous attachments of varing types.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the document in Capture.
\n" }, "title":{ "type":"string", "description":"The title of the document. This is generally the filename used during document import.
\n" }, "batch":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Batch" } ], "description":"The Capture Batch that contains this document.
\n" }, "step":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Step" } ], "description":"The current processing step, if any, this document is undergoing.
\n" }, "profile":{ "type":"object", "allOf":[ { "$ref":"#/definitions/DocumentProfile" } ], "description":"The document profile that has been assigned to this document.
\n" }, "stateToken":{ "type":"string", "description":"A generated string value that represents a particular state of the document.
\nIn general, it is used to allow modifications of the document to proceed. It is essentially saying ...\nmodify this document if its current stateToken matches this value. If the values do\nnot match, the modification is not permitted and the operation results in an error.
This represents the media type of the document. That is the two-part identifier for file formats and format contents\ntransmitted on the Internet.
\n" }, "sourceName":{ "type":"string", "description":"The filename of the document when imported.
\n" }, "size":{ "type":"integer", "format":"int64", "description":"The size, in bytes, of the document.
\n" }, "fields":{ "type":"array", "items":{ "$ref":"#/definitions/FieldValue" }, "description":"This is an array of all the field values available for this document.
\n" }, "comment":{ "type":"string", "description":"A general use comment of this document.
\n" }, "createdBy":{ "type":"object", "allOf":[ { "$ref":"#/definitions/User" } ], "description":"The user that created the document.
\n" }, "createdDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The last user that updated the document.
\n" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
\n" } } }, "AttachmentType":{ "type":"object", "title":"Attachment Type", "description":"An Attachment Type can be used to categorize, and provides process filtering, of attachents of documents.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the attachment type.
\n" }, "name":{ "type":"string", "description":"The name given to the attachment type.
\n" } } }, "Attachment":{ "type":"object", "title":"Attachment", "description":"An Attachment in Capture is a file that contains auxiliary content for a Document. In essence, its\nstructure is very similar to that of a Document; however, there are no metadata fields.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the attachment in Capture.
\n" }, "documentId":{ "type":"string", "description":"The unique identifier of the document in Capture to which this attachment belongs.
\n" }, "title":{ "type":"string", "description":"The title of the attachment. This is generally the filename of the attachment used during document import.
\n" }, "batch":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Batch" } ], "description":"The Capture Batch that contains this attachment's parent document.
\n" }, "step":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Step" } ], "description":"The current processing step, if any, this attachment's parent document is undergoing.
\n" }, "type":{ "type":"object", "allOf":[ { "$ref":"#/definitions/AttachmentType" } ], "description":"The attachment type that has been assigned to this attachment.
\n" }, "stateToken":{ "type":"string", "description":"A generated string value that represents a particular state of the attachment.
\nIn general, it is used to allow modifications of the attachment to proceed. It is essentially saying ...\nmodify this attachment if its current stateToken matches this value. If the values do\nnot match, the modification is not permitted and the operation results in an error.
This represents the media type of the attachment. That is the two-part identifier for file formats and format contents\ntransmitted on the Internet.
\n" }, "sourceName":{ "type":"string", "description":"The filename of the attachment when imported.
\n" }, "size":{ "type":"integer", "format":"int64", "description":"The size, in bytes, of the attachment.
\n" }, "comment":{ "type":"string", "description":"A general use comment of this attachment.
\n" }, "createdBy":{ "type":"object", "allOf":[ { "$ref":"#/definitions/User" } ], "description":"The user that created the attachment.
\n" }, "createdDate":{ "type":"string", "format":"date-time", "description":"This identifies when the attachment was created. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC,\ngoverned by RFC 3339.
The last user that updated the attachment.
\n" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"This identifies when the last time the attachment was updated.
\n" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" }, "description":"HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
\n" } } }, "Batches":{ "type":"object", "title":"Batch Collection", "description":"This represents a collection of Batch objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/Batch" }, "description":"The array of Batch objects.
\nThis will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"Documents":{
"type":"object",
"title":"Document Collection",
"description":"
This represents a collection of Document objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/Document" }, "description":"The array of Document objects.
\nThis will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"Attachments":{
"type":"object",
"title":"Attachment Collection",
"description":"
This represents a collection of Attachment objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/Attachment" }, "description":"The array of Attachment objects.
\nThis will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"DocumentTask":{
"type":"object",
"title":"Document Task",
"description":"
A Document Task is a document that is waiting to be processed in a step of a given procedure.
\n", "properties":{ "taskNumber":{ "type":"integer", "format":"int64", "description":"An incrementing number that is unique to the document and step task queue. This number gets assigned a the document enters the task queue.
\n" }, "document":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Document" } ], "description":"This is the Document that needs to be completed.
\n" } }, "required":[ "taskNumber", "document" ] }, "DocumentTasks":{ "type":"object", "title":"Document Task Collection", "description":"This represents a collection of Document Task objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/DocumentTask" }, "description":"The array of Document Task objects.
\nThis will in the order specified by orderBy, or the default sort order of ascending by taskNumber if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"DocumentTaskResult":{
"type":"object",
"title":"Document Task Result",
"description":"
A Document Task Result is a document task that has completed processing. It can either be a successful completion or a failure completion.
\n\nThe taskNumber is required. The document is required and must contain, at a mimimum the stateToken attribute.\nIt may also contain other attributes that are desired to be updated in the document. If the processing result is an error, it must contain a proper error detail.
The document parameter of each task in the array is a document object and essentially\npatches the document with the attributes that are both present in the request body and updatable.\nA merge-patch media sub-type isn't used because the document object contains an array, and that\nwould require the entire contents of the array to be in the request body.\nRFC 7386, which governs the merge-patch,\nprovides no sematics in which to update elements an array. Even though a merge-patch isn't used,\njust the desired changes are required in the request body, and therefore, just the fields that are being\nupdated need to be present. The updatable attributes of a document are:
titleprofilefieldscommentAn update to either the title or comment is a simple string change. An update to the\ndocment profile (profile) requires setting its value to a different document profile object. The\nobject must contain either the id attribute or the name attribute, or it can contain both.\nOnly one attribute is necessary because the names are unique in the procedure definition. To clear a current document\nprofile, or any of the other attributes, its value in the document object must be set to null. Lastly,\nonly those fields that are being set or changed, need to exist in the fields array.
The document parameter of each task in the array must contain, at a minimum, its stateToken.\nThis is necessary to ensure the object is still the same that is being updated. The stateToken will be\ndifferent if it was was already updated from the last time it was requested. This ensures there aren't concurrent updates,\nand prevents overwriting of data.
If there was a failure during processing, the error attribute must contain the error that occurred in processing.
An incrementing number that is unique to the document and step task queue. This needs to be the same number that that\nprovided by Content Capture in the DocumentTask obtained from the step task queue.
This is the Document to be completed. It can contain attributes of the document that should be updated.\nAt a minimum, it must contain the document's stateToken.
The is an Error Detail that describes any error that occurred during processing.
\n" } }, "required":[ "taskNumber", "document" ] }, "DocumentTaskError":{ "type":"object", "title":"Document Task Error", "description":"A Document Task Error is a document that failed to be completed for some reason, which is identified by the error.
\nThe Document object is the same object that part of the request body for the complete operation. The Error Detail\nobject will contain information that identifies why the document task failed to complete.
\n", "properties":{ "taskNumber":{ "type":"integer", "format":"int64", "description":"That task number that failed to be completed. This needs to be the same number that that provided by Content Capture in\nthe DocumentTask obtained from the step task queue.
This is the Document object that was in the request body of the complete operation for this task.
\n" }, "error":{ "type":"object", "allOf":[ { "$ref":"#/definitions/ErrorDetail" } ], "description":"The is the Error Detail that describes the reason the complete operation failed for this task.
\n" } }, "required":[ "taskNumber", "document", "error" ] }, "DocumentTaskResults":{ "type":"array", "title":"Document Task Results", "description":"This is an array of Document Task Result objects. Each object represent a document task to complete.
\n", "items":{ "$ref":"#/definitions/DocumentTaskResult" } }, "DocumentTaskErrors":{ "type":"array", "title":"Document Task Errors", "description":"This is an array of Document Task Error objects. Each object identifies a document that failed to complete.
\n", "items":{ "$ref":"#/definitions/DocumentTaskError" } }, "AuditEvent":{ "type":"object", "title":"Audit Event", "description":"This represents a given action that occurred within Capture that has been tracked.
\n", "properties":{ "correlationId":{ "type":"string", "description":"A correlation identifier of the event. It is important to note that this value is not unique.
\nAn event may cause other events to occur. This identifier is used express a causal relationships between events,\nparticulally between batches and documents.
\n" }, "type":{ "type":"number", "format":"int32", "description":"The unique identifer of the kind of event.
\n" }, "action":{ "type":"string", "description":"A simple description of the event, generally a verb, such as CREATED, UPDATED, PROCESSED, etc.
The simple message the describes the event.
\n" }, "detail":{ "type":"string", "description":"Detail information about the the event.
\n" }, "locale":{ "type":"string", "description":"The locale that was used to produce the message. The value will be in the form of standard language tags as defined\nby RFC 4647.
The unique key that correlates to the message pattern used to generate the detail message.
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\nis determined by the order of the argument indexes in the message pattern.
\nThe specific keys and values are dependent on the type of event. Also, the event type could allow for more complex object\ndefinition than just simple key/value pairs. Some examples are:
Document Committed Events
\n\n[\n { \"documentId\": \"58be0662-a758-491a-9eed-cc6f56124acf\" },\n { \"documentTitle\": \"Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]\" },\n { \"repositoryName\": \"Plumbing Invoice Type\" },\n { \"assetType\": \"Plumbing Invoice Type\" }\n]\n\nEmail Events
\n\n[\n { \"emailFromName\": \"Joe Smith\" },\n { \"emailFromAddress\": \"joe.smith@someplace.com\" },\n { \"emailSubject\": \"Sales Invoice\" }\n]\n\n"
},
"eventBy":{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/User"
}
],
"description":"The user that trigged/caused the event.
\nThis is only present if the event was triggered by a user of Capture. It is not present when events are triggered by Capture.
\n" }, "eventDate":{ "type":"string", "format":"date-time", "description":"This identifies when the event occurred. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC,\ngoverned by RFC 3339.
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\ncreated, the batching is being processed, the batch was deleted, etc.
\n\nA Batch Audit Detail also encompasses associated Document Audit Detail objects, which represents events for documents\nthe a given batch.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the batch.
\n" }, "name":{ "type":"string", "description":"The name given to the batch.
\nWhen Capture creates a batch, the name is some defined prefix and a sequence number. For example, inv_4781
\n" }, "runtime":{ "type":"object", "description":"If the batch is presently part of the Capture system, this object will contain its current runtime information. However, if the batch has\nbeen committed, or has otherwise been deleted from the Capture system, there will be no runtime information.
\n", "properties":{ "state":{ "type":"string", "default":"READY", "description":"The current state of the batch.
\nREADY - 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.A user specified priority of the batch.
\nThis value is used prioritize the batch for a user's attention. Its used to filter and sort batches for viewing in the client.
\n" }, "status":{ "type":"string", "description":"The current status assigned to the batch.
\nThe status values are defined in the procedure and can be assigned during batch creation, and during transitions between processing jobs.
\n" }, "notes":{ "type":"string", "description":"User supplied general notes associated with a batch.
\n" }, "error":{ "type":"string", "description":"The current error message of the batch, if any.
\nIf the batch is in the ERROR state, this will contain the error message detailing why the batch failed processing. This message\nwill remain until the batch re-enters processing.
If the batch is locked (by a user creating/editing the batch or if Capture is currently processing the batch), this object will\ncontain information about the lock. The state of the batch determines if this object exists.
If the batch is locked within a Capture Client instance, this attribute will contain the computer name where the Capture Client instance\nlocked the batch.
\n" }, "lockedBy":{ "type":"object", "allOf":[ { "$ref":"#/definitions/User" } ], "description":"If the batch is locked within a Capture Client instance, this attribute will contain the user that locked the batch.
\n" }, "procedure":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Procedure" } ], "description":"If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.
\n" }, "step":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Step" } ], "description":"If Capture is currently processing the batch, this object will contain current processing step the batch is undergoing.
\n" }, "lockedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The user that created the batch.
\n" }, "createdDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The last user that updated the batch. This can be the Capture system.
\n" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
This array contains all individual events that pertain to this batch, in eventDate ascending order.
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,\ngoverned by RFC 3339.
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,\ngoverned by RFC 3339.
HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
\n" } } }, "BatchAuditDetails":{ "type":"object", "title":"Batch Audit Detail Collection", "description":"This represents a collection of Batch Audit Detail objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/BatchAuditDetail" }, "description":"The array of Batch Audit Detail objects.
\nThis will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"DocumentAuditDetail":{
"type":"object",
"title":"Document Audit Detail",
"description":"
A Document Audit Detail in Capture is a set of events that occurred for a given document. These are events such as the document was\ncreated, the document was converted, the document was committed, etc.
\n\nA Document Audit Detail is independent in Capture, but is associated with a given Batch Audit Detail resource as documents are\ncontained in batches.
\n", "properties":{ "id":{ "type":"string", "description":"The unique identifier of the document in Capture.
\n" }, "title":{ "type":"string", "description":"The title of the document. This is generally the filename used during document import.
\n" }, "documentId":{ "type":"string", "description":"If this audit detail represents an attachment of a docuument, this is the unique identifier of the document.
\nThis only applies to audit details on attachments of a document. It does not apply to audit details on documents. It will not be present if the audit details applies to a document.
\n" }, "batch":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Batch" } ], "description":"The Capture Batch that contains (or contained) this document.
\n" }, "runtime":{ "type":"object", "description":"If the document is presently part of the Capture system, this object will contain its current runtime information. However, if the document has\nbeen committed, or has otherwise been deleted from the Capture system, there will be no runtime information.
\n", "properties":{ "step":{ "type":"object", "allOf":[ { "$ref":"#/definitions/Step" } ], "description":"The current processing step, if any, this document is undergoing.
\n" }, "profile":{ "type":"object", "allOf":[ { "$ref":"#/definitions/DocumentProfile" } ], "description":"If this audit detail represents a docuument, this is the document profile that has been assigned.
\nThis only applies to audit details on documents. It does not apply to events on audit details of an attachment. It will not be present if the audit details applies to an attachment of a document.
.\n" }, "type":{ "type":"object", "allOf":[ { "$ref":"#/definitions/AttachmentType" } ], "description":"If this audit detail represents an attachment to a docuument, this is the attachment type that has been assigned.
\nThis only applies to audit details on attachments of a document. It does not apply to audit details on documents. It will not be present if the audit details applies to a document.
.\n" }, "stateToken":{ "type":"string", "description":"A generated string value that represents a particular state of the document.
\nIn general, it is used to allow modifications of the document to proceed. It is essentially saying ...\nmodify this document if its current stateToken matches this value. If the values do\nnot match, the modification is not permitted and the operation results in an error.
This represents the media type of the document. That is the two-part identifier for file formats and format contents\ntransmitted on the Internet.
\n" }, "sourceName":{ "type":"string", "description":"The filename of the document when imported.
\n" }, "size":{ "type":"integer", "format":"int64", "description":"The size, in bytes, of the document.
\n" }, "createdBy":{ "type":"object", "allOf":[ { "$ref":"#/definitions/User" } ], "description":"The user that created the document.
\n" }, "createdDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
The last user that updated the document.
\n" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"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,\ngoverned by RFC 3339.
This array contains all individual events that pertain to this document, in eventDate ascending order.
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,\ngoverned by RFC 3339.
This identifies the date/time of the last event that occurred for this document. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC,\ngoverned by RFC 3339.
HATEOS link to related resources and actions or actions on this resource. This will include at least a canonical related link to the resource.
\n" } } }, "DocumentAuditDetails":{ "type":"object", "title":"Document Audit Detail Collection", "description":"This represents a collection of Document Audit Detail objects.
\n", "properties":{ "totalResults":{ "type":"integer", "format":"int32", "description":"The total number of rows that satisfy the client request (excluding the paging parameters).
\n" }, "limit":{ "type":"integer", "format":"int32", "description":"The actual page size used by the server. This may not be the same as what client requests.
\n" }, "count":{ "type":"integer", "format":"int32", "description":"The total number of records in the current response.
\n" }, "hasMore":{ "type":"boolean", "description":"An indicator of whether there are more pages to fetch.
\n" }, "offset":{ "type":"integer", "format":"int32", "description":"The actual index from which the singular resources are returned.
\n" }, "items":{ "type":"array", "items":{ "$ref":"#/definitions/DocumentAuditDetail" }, "description":"The array of Document Audit Detail objects.
\nThis will in the order specified by orderBy, or the default sort order of descending by updatedDate if orderBy was not used.\n"
}
},
"required":[
"limit",
"count",
"hasMore",
"offset"
]
},
"HistoryMessage":{
"type":"object",
"title":"History Message",
"description":"
This message that occurs in Capture that represents a distinct audit event, or associated logging message.
\nA message will always be associated to an individual audit event. But, the message can be the actual audit\nevent. Other messages provide more detail related to that event.
\nThe message produced in Capture will be associated to a Batch. They may, or may not, be associated\nto a Document in that batch.
\n", "properties":{ "auditId":{ "type":"string", "description":"The audit identifier of the message. This identifier is used to correlate messages with each other. Messages\nwith the same auditId are part of the same occurrence of the given audit event.
The associated batch identifier.
\n" }, "batchName":{ "type":"string", "description":"The associated batch name.
\n" }, "documentId":{ "type":"string", "description":"The associated document identifier, if the message pertains to a document.
\n" }, "documentTitle":{ "type":"string", "description":"The associated document name, if the message pertains to a document.
\nThe title of a document may change. This will be the title of the document at the time the message occurred.
\n" }, "timestamp":{ "type":"string", "format":"date-time", "description":"This identifies when the message occurred. The date/time in ISO-8601 Date Time format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTC,\ngoverned by RFC 3339.
The message content produced by Capture.
\n" } } }, "BatchHistory":{ "type":"object", "title":"Batch History", "description":"This object contains a collection of messages that detail the history of a batch as it progresses through Capture.
\nThe history is set of audit events and associated detail messages. For instance, several processing audit events\nmay occur in the life of a batch. As batch processing is happening, detail messages are written to logs that provide more\ninformation as to what is happening during processing.
\n", "properties":{ "batchAuditMessages":{ "type":"array", "items":{ "$ref":"#/definitions/HistoryMessage" }, "description":"This array contains all batch audit event messages. It is time ordered (descending) by the\nmessage timestamp.
This array contains all document audit event message that pertain to this batch. It is time ordered (descending) by the\nmessage timestamp.
This array contains all the logging messages associated with the batch. It is time ordered (descending) by the\nmessage timestamp.
This is a simple operation that will return Capture system and API information.
\n", "responses":{ "200":{ "description":"General Content Capture System and REST API information.
\n", "schema":{ "$ref":"#/definitions/SystemInfo" } }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/audit/batches":{ "get":{ "x-internal-id":"audit-batches-get", "x-filename-id":"audit-batches-get", "summary":"List all Batch Audit Details", "operationId":"listBatchAuditDetails", "tags":[ "Auditing" ], "description":"This operation will return a collection of all the audit details for batches in Capture.
\n\nAs a batch flows through Capture, events occur pertaining to that batch. These events vary by the types of processing defined\nin the procedure, but are typically milestone events, or error events. As an example, the creation of the batch could be considered\na milestone event. Any error as a result of processing would be considered an error event.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results.
\n\nThis operation supports the expand parameter as well, which is used to include child resources/collections inline. The\nchild collection of documents is supported. If used, the response will contain all the associated Document Audit\nDetail objects for all documents in the batch. Additionally, the child resource of runtime is supported. When used,\nif 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.
\n", "parameters":[ { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all in'\nlower 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\nresources/collections are:
\nruntimedocumentsExample : ?expand=runtime
\nExpands the runtime object of this batch audit detail, if any.
Example : ?expand=documents
\nExpands the collection of documents of this batch audit detail, if any.
The locale parameter is used to specify the language translations used for messages in the audit events. The value must be in\nthe form of standard language tags as defined by RFC 4647.
\n\nIf this is not specified, the default language settings locale will be used.
\n" }, { "name":"orderBy", "in":"query", "type":"string", "required":false, "description":"The orderBy parameter is used to control the ordering (ascending/descending) of results in the batch audit detail collection. This parameter\nis 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).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nOnly the following attributes of a batch audit detail are supported in an orderBy:
\nidnamecreatedDatelastEventDateThe attributes of the runtime child resource are also supported, such as runtime.status and runtime.priority.\nHowever, that requires the runtime object to be included in the expand parameter (either through the use of all or\nruntime values), and they have no effect for historical batches. The runtime attributes runtime.state and\nruntime.lock.step.type are not supported.
Examples:
\n?orderBy=id?orderBy=name;lastEventDate:asc?orderBy=name&orderBy=lastEventDate:desc?orderBy=createdDate:asc?orderBy=createdDate:asc;runtime.priorityThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include\nthe total number of batch audit details in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting batch audit details collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"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.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the batch audit detail, and is used for filtering\nresults in collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can be muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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\nRFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). 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:
\nidnamecreatedDatelastEventDateThe attributes of the runtime child resource are also supported, such as runtime.state are runtime.priority.\nHowever, that requires the runtime object to be included in the expand parameter (either through the use of all or\nruntime values), and they have no effect for historical batches.
Examples:
\n?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\")A list of all the batch audit details.
\n", "schema":{ "$ref":"#/definitions/BatchAuditDetails" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/audit/batches/{batchId}":{ "get":{ "x-internal-id":"audit-batches-{batchId}-get", "x-filename-id":"audit-batches-batchid-get", "summary":"Get a Batch Audit Detail", "operationId":"readBatchAuditDetail", "tags":[ "Auditing" ], "description":"This operation will return the audit details for the batch specified by the batchId parameter.
\n\nThe expand parameter can used in this operation, which will result in child resources/collections being included inline.\nThe child collection of documents is supported. If used, the response will contain all the associated Document Audit Detail\nobjects for all documents in the batch. Additionally, the child resource of runtime is supported. When used, if the batch is\npresently in Capture, it's runtime state information will be returned in the response.
The unique identifier of the batch in Capture.
\n" }, { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all\nin 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\nresources/collections are:
\nruntimedocumentsExample : ?expand=runtime
\nExpands the runtime object of this batch audit detail, if any.
Example : ?expand=documents
\nExpands the collection of documents of this batch audit detail, if any.
The locale parameter is used to specify the language translations used for messages in the audit events. The value must be in\nthe form of standard language tags as defined by RFC 4647.
\n\nIf this is not specified, the default language settings locale will be used.
\n" } ], "responses":{ "200":{ "description":"The batch audit detail specified by batchId.
\n", "schema":{ "$ref":"#/definitions/BatchAuditDetail" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/audit/documents":{ "get":{ "x-internal-id":"audit-documents-get", "x-filename-id":"audit-documents-get", "summary":"List all Document Audit Details", "operationId":"listDocumentAuditDetails", "tags":[ "Auditing" ], "description":"This operation will return a collection of all the audit details for documents in Capture.
\n\nAs a batch flows through Capture, events occur pertaining to that batch. This occurrs for documents as well. Events for documents\ncan include that it was committed, or perhaps that its document profile was changed. It could also be runtime requirements such as\nthe document was skipped in a processing job because it wasn't part of the restricted to criteria. Error conditions, such as a barcode\nnot being present, can generate a document event.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results.
\n\nThis operation supports the expand parameter as well, which is used to include child resources/collections inline. The\nchild resource of runtime is supported. When used, if the document is presently in Capture, it's runtime state\ninformation will be returned in the response.
If there are no document audit details, or they don't match the filtering criteria, an empty collection will be returned.
\n", "parameters":[ { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all in'\nlower 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\nresources/collections of a document audit detail are:
\nruntimeExample : ?expand=runtime
\nExpands the runtime object of this document audit detail, if any.
The locale parameter is used to specify the language translations used for messages in the audit events. The value must be in\nthe form of standard language tags as defined by RFC 4647.
\n\nIf this is not specified, the default language settings locale will be used.
\n" }, { "name":"orderBy", "in":"query", "type":"string", "required":false, "description":"The orderBy parameter is used to control the ordering (ascending/descending) of results in the document audit detail collection.\nThis parameter is optional as a document audit detail collection has a default sort order of lastEventDate descending.
This parameter accepts the attribute name, and can be separated by a colon (:) for which the user wants to sort the results (ascending/descending).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nOnly the following attributes of a batch audit detail are supported in an orderBy:
\nidtitlecreatedDatelastEventDatebatch.idbatch.nameThe attributes of the runtime child resource are also supported, such as runtime.sourceName and runtime.profile.name.\nHowever, that requires the runtime object to be included in the expand parameter (either through the use of all or\nruntime values), and they have no effect for historical documents. The runtime attributes runtime.stateToken and\nruntime.mediaType are not supported.
Examples:
\n?orderBy=id?orderBy=name;lastEventDate:asc?orderBy=name&orderBy=lastEventDate:desc?orderBy=createdDate:asc?orderBy=createdDate:asc;runtime.sourceNameThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of document\naudit details in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting document audit details collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"The offset parameter accepts a non-negative integer and is used to control the start index of the dopcument audit details collection of the query.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the document audit detail, and is used for filtering\nresults in the collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can be muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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\nRFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). For example: (({expression}) and ({expression})). This forms more complex filters.
Multiple q query parameters are supported, and imply the and logical operator.
Only the following attributes of a document audit detail are supported in a q expression:
\nidtitlecreatedDatelastEventDatebatch.idbatch.nameThe attributes of the runtime child resource are also supported, such as runtime.sourceName and runtime.profile.name.\nHowever, that requires the runtime object to be included in the expand parameter (either through the use of all or\nruntime values), and they have no effect for historical documents. The runtime attributes runtime.stateToken and\nruntime.mediaType are not supported.
Examples:
\n?q=(batch.id eq \"342\") and (lastEventDate ge \"2021-05-26\")?q=(runtime.profile.name eq \"Plumbing Invoice\" and createdDate ge \"2021-05-01\")?q=(runtime.size gt 250000)&q=(createdDate ge \"2021-05-01\")?q=(lastEventDate ge \"2021-05-26\")A list of all the document audit details.
\n", "schema":{ "$ref":"#/definitions/DocumentAuditDetails" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/audit/documents/{docId}":{ "get":{ "x-internal-id":"audit-documents-{docId}-get", "x-filename-id":"audit-documents-docid-get", "summary":"Get a Document Audit Detail", "operationId":"readDocumentAuditDetail", "tags":[ "Auditing" ], "description":"This operation will return the audit details for the document specified by the docId parameter.
\n\nThe expand parameter can used, which will include child resources/collections inline. The child resource of runtime\nis supported. When used, if the document is presently in Capture, it's runtime state information will be returned in the response.
The unique identifier of the document in Capture.
\n" }, { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all\nin 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\nresources/collections are:
\nruntimeExample : ?expand=runtime
\nExpands the runtime object of this document audit detail, if any.
The locale parameter is used to specify the language translations used for messages in the audit events. The value must be in\nthe form of standard language tags as defined by RFC 4647.
\n\nIf this is not specified, the default language settings locale will be used.
\n" } ], "responses":{ "200":{ "description":"The document audit detail specified by docId.
\n", "schema":{ "$ref":"#/definitions/DocumentAuditDetail" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/steps/{stepId}/tasks/documents":{ "get":{ "x-internal-id":"steps-{stepId}-tasks-documents-get", "x-filename-id":"steps-stepid-tasks-documents-get", "summary":"Get Documents from a Processing Task Queue", "operationId":"listDocumentTasks", "tags":[ "Steps" ], "description":"This operation is used by external systems to see which documents in Capture are presently in a given step that need to be processed. Once\na document task has been completed, it is no longer in the task queue.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results.
\n\nIf there are no documents, or they don't match the filtering criteria, an empty collection will be returned.
\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will contain all document\ntasks for the queue matching any specified query arguments. If the OAuth token does not represent an account that is a\nCapture Administator, meaning it is just a Capture User, an error will be returned if the account has not been granted explict\naccess to the step. If the account has been granted explict access to the step, all the document taks for the queue matching any specified\nquery arguments.
\n", "parameters":[ { "name":"stepId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the processing step in Capture.
\n" }, { "name":"orderBy", "in":"query", "type":"string", "required":false, "description":"The orderBy parameter is used to control the ordering (ascending/descending) of results in the collection. This parameter is optional\nas a document task collection has a default sort order of taskNumber ascending.
This parameter accepts an attribute name, and can be separated by a colon (:) for which the user wants to sort the results (ascending/descending).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nAll the attributes of the document of the task are supported in an orderBy with the exception of:
document.mediaTypedocument.fieldsdocument.linksHowever, the default sort order of taskNumber ascending is typically what is desired.
Examples:
\n?orderBy=task.number?orderBy=document.batch.id?orderBy=document.batch.id;document.updatedDate:asc?orderBy=document.title&orderBy=document.createdDate:desc?orderBy=document.size:asc?orderBy=document.profile.name;document.size:ascThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of document tasks in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting document task collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"The offset parameter accepts a non-negative integer and is used to control the start index of the document task collection of the query.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the document, and is used for filtering\nresults in collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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\nRFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). 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 task are supported in a q expression with the exception of:
\ndocument.step.iddocument.step.namedocument.step.typedocument.mediaTypeChild resource attributes, such as document.batch.id and document.profile.name, are also supported. However, array\nattributes such as documents.fields and document.links, are not supported.\n\n
A typical use case is to query for document tasks that are greater than document tasks previously queried. In this case, the query expression\nwould be q=(taskNumber gt 7832)
\n\nExamples:
\n?q=(taskNumber gt 7832)?q=(document.batch.id eq \"323\" and document.createdDate ge \"2021-05-01\")?q=(document.profile.name eq \"Example Document Profile\") and (document.size lt 50000)A list of all the document tasks that need to be processed in the given step.
\n", "schema":{ "$ref":"#/definitions/DocumentTasks" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/steps/{stepId}/tasks/documents/complete":{ "put":{ "x-internal-id":"steps-{stepId}-tasks-documents-complete-put", "x-filename-id":"steps-stepid-tasks-documents-complete-put", "summary":"Complete Document Processing in a Task Queue", "operationId":"completeDocumentTasks", "tags":[ "Steps" ], "description":"This operation is used by external systems to identify to Capture that supplied documents have been processed. The processing of the task\ncan either be successful or result in a failure, and the request body needs to identify that. Regardless, this indicates that the external\nsystem has completed processing of the document.
\n\nThe request body is an array of document task results that have been completed.
\n\nIf a document task result in the array fails to complete, other results in the array are not affected. However, the response will\nindicate an error with the status code of 422 Unprocessable Entity, and will contain an array of results, along with errors, that\ncould not be completed.
\n\nNote: The OAuth token used in this request must represent an account that has been granted explict access to the step\nidentified by stepId. It makes no difference if the account represents a Capture Administator or a Capture User.
\n", "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"stepId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the processing step in Capture.
\n" }, { "in":"body", "name":"tasks", "required":true, "schema":{ "$ref":"#/definitions/DocumentTaskResults" } } ], "responses":{ "204":{ "description":"No Content
\n" }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "422":{ "description":"Unprocessable Entity
\nThe request was well-formed, but the server was unable to process the contained resources/instructions.
\nThe response is an array of Document Task Error objects. There will be an entry in the array for\neach document task that failed to complete. It will be in ascending order by taskNumber of the\nDocument Task Error object. Each Document Task Error in the array will contain an\nError Detail object that provides details on the underlying cause.
\n", "schema":{ "$ref":"#/definitions/DocumentTaskErrors" } }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/batches":{ "get":{ "x-internal-id":"batches-get", "x-filename-id":"batches-get", "summary":"List all Batches", "operationId":"listBatches", "tags":[ "Batches" ], "description":"This operation will return a collection of the batches in Capture.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results.\n\ndocuments 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.
\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will contain all batches\nmatching any specified query arguments regardless of procedures. If the OAuth token does not represent an account that is a Capture\nAdministator, meaning it is just a Capture User, the response will contain only those batches initiated from Client Profiles\nor Import Jobs in which the account has been granted explict access.
\n", "parameters":[ { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all\nin 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\nresources/collections are:
\ndocumentsExample : ?expand=documents
\nExpands the collection of documents of this batch, if any.
The orderBy parameter is used to control the ordering (ascending/descending) of results in the batch collection. This parameter is optional\nas 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).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nAll the attributes of a batch are supported in an orderBy with the exception of:
\nstatenoteserrorlinksAttributes of the procedure and lock child resources, such as procedure.name and lock.lockedDate, are also supported.\nHowever, the attribute lock.step.type is not supported.
Examples:
\n?orderBy=id?orderBy=id;updatedDate:asc?orderBy=name&orderBy=createdDate:desc?orderBy=priority:desc?orderBy=priority:desc;status:ascThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of batches in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting batch collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"The offset parameter accepts a non-negative integer and is used to control the start index of the batch collection of the query.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the batch, and is used for filtering\nresults in collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can be muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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\nRFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). 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:
\nnoteserrorAttributes of the procedure and lock child resources, such as procedure.id and lock.lockedDate, are also supported.\nAdditionally, array attributes such as links are not supported; nor are child collections such as documents.
Examples:
\n?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\")A list of all the batches.
\n", "schema":{ "$ref":"#/definitions/Batches" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/batches/{batchId}":{ "get":{ "x-internal-id":"batches-{batchId}-get", "x-filename-id":"batches-batchid-get", "summary":"Get a Batch", "operationId":"readBatch", "tags":[ "Batches" ], "description":"This operation will return the batch specified by the batchId parameter.
\n\nThis operation supports the expand parameter as well, which is used to include child resources/collections inline. The collection\nresource of documents is supported in the expand parameter; and will inline all the documents of the batch.
Note: If the OAuth token represents an account that is a Capture Administator, the response will return the given\nbatch, provided it exists. If the OAuth token does not represent an account that is a Capture Administator, meaning it\nis just a Capture User, the response will only return the batch if it exists and the batch was initiated from a Client Profile\nor an Import Job in which the account has been granted explict access.
\n", "parameters":[ { "name":"batchId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the batch in Capture.
\n" }, { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all\nin 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\nresources/collections are:
\ndocumentsExample : ?expand=documents
\nExpands the collection of documents of this batch, if any.
The batch specified by batchId.
\n", "schema":{ "$ref":"#/definitions/Batch" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/batches/{batchId}/history":{ "get":{ "x-internal-id":"batches-{batchId}-history-get", "x-filename-id":"batches-batchid-history-get", "summary":"Get the history of a Batch", "operationId":"readBatchHistory", "tags":[ "Batches" ], "description":"This operation will return this history of a given batch as specified by the batchId parameter. This history\nis a collection of message activities have occurred within the batch, as well as associated documents. In essence, it represents\nactivity logging of that batch processing.
\n\nThe history is only available while the batch is present. Once the batch is deleted from Capture, either manually or\nthrough a Commit operation, this history is removed from the system. At that point, only audit information may be obtained.
\n", "parameters":[ { "name":"batchId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the batch in Capture.
\n" }, { "name":"locale", "in":"query", "type":"string", "required":false, "description":"The locale parameter is used to specify the language translations used for messages in the audit events. It does not\neffect the language of detail activity messages. The value must be in the form of standard language tags as defined by\nRFC 4647.
\n\nIf this is not specified, the default language settings locale will be used.
\n" } ], "responses":{ "200":{ "description":"The batch history specified by batchId.
\n", "schema":{ "$ref":"#/definitions/BatchHistory" } }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents":{ "get":{ "x-internal-id":"documents-get", "x-filename-id":"documents-get", "summary":"List all Documents", "operationId":"listDocuments", "tags":[ "Documents" ], "description":"This operation will return a collection of the documents in Capture.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results. This operation supports the expand\nparameter as well, which is used to include child resources/collections inline. The child resource of batch is supported.\nIf that resource is not expanded, then it just contains the summary information of id and name. The collection\nresource 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.
\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will contain all documents\nmatching any specified query arguments regardless of procedure, batch, or step. If the OAuth token does not represent an account that is a\nCapture Administator, meaning it is just a Capture User, the response will contain only those documents that are currently in a\nstep in which the account has been granted explict access.
\n", "parameters":[ { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all\nin 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\nresources/collections are:
\nbatchattachmentsExample : ?expand=batch
\nExpands the batch child resource of this document.
Example : ?expand=attachments
\nExpands the collection of attachments of this document, if any.
The orderBy parameter is used to control the ordering (ascending/descending) of results in the document collection. This parameter is optional\nas 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).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nAll the attributes of a document are supported in an orderBy with the exception of:
\nstateTokenmediaTypefieldslinksExamples:
\n?orderBy=batch.id?orderBy=batch.id;updatedDate:asc?orderBy=title&orderBy=createdDate:desc?orderBy=size:asc?orderBy=profile.name;size:ascThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of documents in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting document collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"The offset parameter accepts a non-negative integer and is used to control the start index of the document collection of the query.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the document, and is used for filtering\nresults in collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can be muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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,\ngoverned by RFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). 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:
\nstateTokenmediaTypeChild resource attributes, such as batch.id and profile.name, are also supported. However, array resources such as\nfields and links, are not supported; nor are child collections such as attachments.
Examples:
\n?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\")A list of all the documents.
\n", "schema":{ "$ref":"#/definitions/Documents" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents/{docId}":{ "get":{ "x-internal-id":"documents-{docId}-get", "x-filename-id":"documents-docid-get", "summary":"Get a Document", "operationId":"readDocument", "tags":[ "Documents" ], "description":"This operation will return the document specified by the docId parameter.
\n\nThis operation supports the expand parameter, which includes child resources/collections inline. The child resource of\nbatch is supported. If that resource is not expanded, then it just contains the summary information of id\nand name. The collection resource of attachments is also supported in the expand parameter, and will inline\nall the attachments of the document.\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will return the given\ndocument, provided it exists. If the OAuth token does not represent an account that is a Capture Administator, meaning it\nis just a Capture User, the response will only return the document if it exists and the document is currently in a step in which\nthe account as been granted explict access.
\n", "parameters":[ { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"expand", "in":"query", "type":"string", "required":false, "description":"The expand parameter provides the option of getting child resources/collections inline with the response. It accepts\na comma-separated list of attribute names or all. When expand is specified as all (with all in\nlower 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\nresources/collections are:
\nbatchattachmentsExample : ?expand=batch
\nExpands the batch child resource of this document.
Example : ?expand=attachments
\nExpands the collection of attachments of this document, if any.
The document specified by docId.
\n", "schema":{ "$ref":"#/definitions/Document" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } }, "put":{ "x-internal-id":"documents-{docId}-put", "x-filename-id":"documents-docid-put", "summary":"Update a Document", "operationId":"updateDocument", "tags":[ "Documents" ], "description":"This operation is used to modify a document. It allows for both the document data, and its content, to be modified in a \nsingle operation.
\n\nThe request body of the operation requires at least the document parameter. The content\nparameter is optional, and only necessary if a change of the document contents is desired.
The document parameter is a document object and essentially patches the document with the attributes that\nare both present in the request body and updatable. A merge-patch media sub-type isn't used because the document\nobject contains an array, and that would require the entire contents of the array to be in the request body.\nRFC 7386, which governs the merge-patch, provides no\nsematics in which to update elements an array. Even though a merge-patch isn't used, just the desired changes are\nrequired in the request body, and therefore, just the fields that are being updated need to be present.\nThe updatable attributes are:
titleprofilefieldscommentAn update to either the title or comment is a simple string change. An update to the docment profile\n(profile) requires setting its value to a different document profile object. The object must contain either the\nid attribute or the name attribute, or it can contain both. Only one attribute is necessary because the\nnames are unique in the procedure definition. To clear a current document profile, or any other attributes, its value in the document\nobject must be set to null. Lastly, only those fields that are being set or changed, need to exist in the\nfields array.
The document object must also contain its stateToken. This is necessary to ensure the object is still the same\nthat is being updated. The stateToken will be different if it was was already updated from the last time it was\nrequested. This ensures there aren't concurrent updates, and prevents overwriting of data.
Note: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which this document presently resides. It makes no difference if the account represents a Capture Administator\nor a Capture User.
\n", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "in":"formData", "name":"document", "type":"string", "required":true, "description":"This is a document object. The Content-Type of the mulitpart must be used and must identify\nthe application encoding used for the string value. This must be application/json.
\n\nThe document object must also contain its stateToken that represents its believed current state.\nIf the supplied stateToken does not match the document's current stateToken, the update\noperation will result in an error.
This is the actual document content, for instance, an updated image as a result of processing.
The Content-Type\nof the multipart must identify the type of file. And, the Content-Disposition must contain the filename.\n" } ], "responses":{ "200":{ "description":"The document, containing any updates.
\n", "schema":{ "$ref":"#/definitions/Document" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "409":{ "description":"Conflict
\nThis response indicates the request conflicts with current state of the target resource. The response will be an\nError Detail object.
\nGenerally, an error response of 412 (Precondition Failed) will be returned. But a Conflict can occur when\nthere are simultaneous edits on a resource.
\n" }, "412":{ "description":"Precondition Failed
\nThe server does not meet one of the preconditions of the request. The response will be an\nError Detail object.
\nThis error response is used specifically when the stateToken used in the request body does not\nmatch the current stateToken of the resource.
Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } }, "delete":{ "x-internal-id":"documents-{docId}-delete", "x-filename-id":"documents-docid-delete", "summary":"Delete a Document", "operationId":"deleteDocument", "tags":[ "Documents" ], "description":"This operation will delete, from Capture, the document specified by the docId parameter.
\n\nNote: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which this document presently resides. It makes no difference if the account represents a Capture Administator\nor a Capture User.
\n", "consumes":[ "application/json" ], "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "in":"body", "name":"document", "required":true, "schema":{ "type":"object", "properties":{ "stateToken":{ "type":"string", "description":"A generated string value that represents a particular state of the document.
\nIn general, it is used to allow modifications of the document to proceed. It is essentially saying ...\ndelete this document if its current stateToken matches this value. If the values do\nnot match, the modification is not permitted and the operation results in an error.
This represents the document to be deleted. It can be the entire document object, but the only attribute that is necessary is\nthe stateToken. It is necessary to verify the delete operation can proceed.
The value of the stateToken needs to be the value from the document to delete, its believed current state. If the stateToken\nvalue does not match the document's current stateToken value, the delete operation will result in an error.
Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "409":{ "description":"Conflict
\nThis response indicates the request conflicts with current state of the target resource. The response will be an\nError Detail object.
\nGenerally, an error response of 412 (Precondition Failed) will be returned. But a Conflict can occur when\nthere are simultaneous edits on a resource.
\n" }, "412":{ "description":"Precondition Failed
\nThe server does not meet one of the preconditions of the request. The response will be an\nError Detail object.
\nThis error response is used specifically when the stateToken used in the request body does not\nmatch the current stateToken of the resource.
Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents/{docId}/content":{ "get":{ "x-internal-id":"documents-{docId}-content-get", "x-filename-id":"documents-docid-content-get", "summary":"Get the Document Content", "operationId":"readDocumentContent", "tags":[ "Documents" ], "description":"This operation will return the raw content of the document specified by the docId parameter.
\n\nThe Content-Type of the response is dependent on the mediaType of the document. Typically, the document will be some type of image\nsuch as TIFF, JPG, PNG, etc. However, it could also be a Microsoft Office document or PDF file.
Note: If the OAuth token represents an account that is a Capture Administator, the response will return the given\ndocument content, provided it exists. If the OAuth token does not represent an account that is a Capture Administator, meaning it\nis just a Capture User, the response will only return the document if it exists and the document is currently in a step in which\nthe account as been granted explict access.
\n", "parameters":[ { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" } ], "produces":[ "*/*" ], "responses":{ "200":{ "description":"The document's raw content specified by the docId parameter.
\nThe Content-Type of the response is dependent on the mediaType of the document. Typically, the document will be some type of image,\nsuch as TIFF, JPG, PNG, etc. However, it could also be a Microsoft Office document or PDF file.
Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents/{docId}/attachments":{ "get":{ "x-internal-id":"documents-{docId}-attachments-get", "x-filename-id":"documents-docid-attachments-get", "summary":"List all Document Attachments", "operationId":"listAttachments", "tags":[ "Attachments" ], "description":"This operation will return the collection of attachments, if any, of the document specified by docId.
\n\nThe q parameter can be used to filter the results in this collection. The orderBy parameter provides a means to\nsort the collection. The totalResults parameter will return the total number of results that match the query. The other\nparameters, limit and offset, are used for paging of the results.
\n\nIf there are no attachments of the document, or they don't match the filtering criteria, an empty collection will be returned.
\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will contain all attachments\nmatching any specified query arguments regardless of procedure, batch, or step. If the OAuth token does not represent an account that is a\nCapture Administator, meaning it is just a Capture User, the response will contain the attachments of the document if it is currently in a\nstep in in which the account has been granted explict access.
\n", "parameters":[ { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"orderBy", "in":"query", "type":"string", "required":false, "description":"The orderBy parameter is used to control the ordering (ascending/descending) of results in the attachment collection. This parameter is optional\nas an attachment 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).\nIf a sort order it not specified, it will be sorted in ascending order. Note : asc stands for ascending and desc for descending.\nMultiple sort orders can be separated by semicolon (;). For example, orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}. Also,\nthere can also be mulitple orderBy query parameters, and they are applied in query string parameter order.
\n\nAll the attributes of an attachment are supported in an orderBy with the exception of:
\nstateTokenmediaTypeExamples:
\n?orderBy=batch.id?orderBy=documentId;updatedDate:asc?orderBy=title&orderBy=createdDate:desc?orderBy=size:asc?orderBy=type.name;size:ascThe totalResults parameter accepts a boolean flag. If specified as true, then the returned result will include the total number of attachments in the query.
The limit parameter accepts a non-negative integer and is used to control the size of the resulting attachment collection.
\n" }, { "name":"offset", "in":"query", "type":"integer", "format":"int32", "required":false, "default":0, "description":"The offset parameter accepts a non-negative integer and is used to control the start index of the attachment collection of the query.
\n" }, { "name":"q", "in":"query", "type":"string", "required":false, "description":"The q parameter accepts a query expression condition that matches the attribute values of the attachment, and is used for filtering\nresults in collection. The value of the parameter can be a simple expression in the form of\n{attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators.
\n\nThe following conditional operators are supported:
\neq - Equalsne - Not Equalslt - Less Thangt - Greater Thanle - Less Than or Equal toge - Greater Than or Equal toOnly the conditional operators eq and ne can be used with string attributes; and, string attributes must be enclosed in\nquote characters ("). Likewise, boolean data types can only use the conditional operators eq and ne. All conditional\noperators 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,\ngoverned by RFC 3339. For example, \"2021-04-12\"\nor \"2021-04-15T04:27:15-06:00\". Even though the values are in a string format, they will support numerical type operators, such as\nlt and gt.
Conditional expressions can be joined by the logical operators of and or or. And, can also be grouped using parentheses\n(). 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 an attachment are supported in a q expression with the exception of:
\nstateTokenmediaTypeChild resource attributes, such as batch.id and type.name, are also supported.
Examples:
\n?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=(type.name eq \"Example Attachment Type\") and (size lt 50000)?q=(updatedDate ge \"2021-05-26\")?q=(batch.id eq \"636\") or (batch.id eq \"637\")A list of all the attachments for the document specified by docId.
\n", "schema":{ "$ref":"#/definitions/Attachments" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } }, "post":{ "x-internal-id":"documents-{docId}-attachments-post", "x-filename-id":"documents-docid-attachments-post", "summary":"Create an Attachment", "operationId":"createAttachment", "tags":[ "Attachments" ], "description":"This operation can be used to create an attachment for a given document.
\n\nThe request body of the operation requires at least the content parameter. The attributes that make up an\nattachment can be obtained from the content (e.g. the attachment title). However, if desired, the\nattachment parameter can be used to set attributes. And, this is necessary if the attachment is to be of a\nspecific attachment type.
The attachment parameter is an attachment object and essentially patches the default attributes that\nmake up and attachment. Just the attributes that are desired to be set are required in the object. The only attributes that\ncan be set are:
titletypecommentBoth the title and comment are simple strings. To set the attachment type (type)\nrequires specifying an attachment type object. The object must contain either the id attribute or the\nname attribute, or it can contain both. Only one attribute is necessary because the names are unique in the\nprocedure definition.
Note: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which the attachment's document presently resides. It makes no difference if the account represents a\nCapture Administator or a Capture User.
\n", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "in":"formData", "name":"content", "type":"file", "required":true, "description":"This is the actual attachment content, for instance, an image as a result of processing.
The Content-Type\nof the multipart must identify the type of file. And, the Content-Disposition must contain the filename.\n" }, { "in":"formData", "name":"attachment", "type":"string", "required":false, "description":"This is an attachment object. The Content-Type of the mulitpart must be used and must identify\nthe application encoding used for the string value. This must be application/json.
\n" } ], "responses":{ "201":{ "description":"The new attachment
\n", "schema":{ "$ref":"#/definitions/Attachment" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "409":{ "description":"Conflict
\nThis response indicates the request conflicts with current state of the target resource. The response will be an\nError Detail object.
\nGenerally, this will typically occur when the given document is not presently in a processing step.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents/{docId}/attachments/{attId}":{ "get":{ "x-internal-id":"documents-{docId}-attachments-{attId}-get", "x-filename-id":"documents-docid-attachments-attid-get", "summary":"Get an Attachment", "operationId":"readAttachment", "tags":[ "Attachments" ], "description":"This operation will return the attachment specified by the docId and attId parameters.
\n\nIt is an error if the attachment is not attached to the given document.
\n\nNote: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which this document presently resides. It makes no difference if the account represents a Capture Administator\nor a Capture User.
\n", "parameters":[ { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"attId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the attachment in Capture.
\n" } ], "responses":{ "200":{ "description":"The attachment specified by docId and attId.
\n", "schema":{ "$ref":"#/definitions/Attachment" } }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } }, "put":{ "x-internal-id":"documents-{docId}-attachments-{attId}-put", "x-filename-id":"documents-docid-attachments-attid-put", "summary":"Update an Attachment", "operationId":"updateAttachment", "tags":[ "Attachments" ], "description":"This operation is used to modify an attachment. It allows for both the attachment data, and its content, to be modified in a \nsingle operation.
\n\nThe request body of the operation requires at least the attachment parameter. The content\nparameter is optional, and only necessary if a change of the attachment contents is desired.
The attachment object of the request bodies essentially patches the attachment with the attributes that are both\npresent in the request body and updatable. A merge-patch media sub-type isn't used to be consistent with other\noperations that cannot use a merge-patch. Even though a merge-patch isn't used, just the desired changes are\nrequired in the request body, and therefore, just the fields that are being updated need to be present.\nThe updatable attributes are:
\ntitletypecommentAn update to either the title or comment is a simple string change. An update to the attachment type\n(type) requires setting its value to a different attachment type object. The object must contain either the\nid attribute or the name attribute, or it can contain both. Only one attribute is necessary because the\nnames are unique in the procedure definition. To clear a current attachment type, its value in the document object must be set\nto null.
The attachment object must also contain its stateToken. This is necessary to ensure the object is still the same\nthat is being updated. The stateToken will be different if it was was already updated from the last time it was\nrequested. This ensures there aren't concurrent updates, and prevents overwriting of data.
It is an error if the attachment is not attached to the given document.
\n\nNote: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which this document presently resides. It makes no difference if the account represents a Capture Administator\nor a Capture User.
\n", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"attId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the attachment in Capture.
\n" }, { "in":"formData", "name":"attachment", "type":"string", "required":true, "description":"This is an attachment object. The Content-Type of the mulitpart must be used and must identify\nthe application encoding used for the string value. This must be application/json.
\n\nThe attachment object must also contain its stateToken that represents its believed current state.\nIf the supplied stateToken does not match the attachment's current stateToken, the update\noperation will result in an error.
This is the actual attachment content, for instance, an updated image as a result of processing.
The Content-Type\nof the mulitpart must identify the type of file. And, the Content-Disposition must contain the filename.\n" } ], "responses":{ "200":{ "description":"The attachment, containing any updates.
\n", "schema":{ "$ref":"#/definitions/Attachment" } }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "409":{ "description":"Conflict
\nThis response indicates the request conflicts with current state of the target resource. The response will be an\nError Detail object.
\nGenerally, an error response of 412 (Precondition Failed) will be returned. But a Conflict can occur when\nthere are simultaneous edits on a resource.
\n" }, "412":{ "description":"Precondition Failed
\nThe server does not meet one of the preconditions of the request. The response will be an\nError Detail object.
\nThis error response is used specifically when the stateToken used in the request body does not\nmatch the current stateToken of the resource.
Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } }, "delete":{ "x-internal-id":"documents-{docId}-attachments-{attId}-delete", "x-filename-id":"documents-docid-attachments-attid-delete", "summary":"Delete an Attachment", "operationId":"deleteAttachment", "tags":[ "Attachments" ], "description":"This operation will delete, from Capture, the attachment specified by the docId and attId parameters.
\n\nIt is an error if the attachment is not attached to the given document.
\n\nNote: The OAuth token used in this request must represent an account that has been granted explict access\nto the step in which this document presently resides. It makes no difference if the account represents a Capture Administator\nor a Capture User.
\n", "consumes":[ "application/json" ], "parameters":[ { "name":"X-Requested-With", "in":"header", "type":"string", "required":true, "description":"A header used to prevent Cross-Site Request Forgery (CSRF) attacks. The only supported value is XMLHttpRequest.
\n" }, { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"attId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the attachment in Capture.
\n" }, { "in":"body", "name":"attachment", "required":true, "schema":{ "type":"object", "properties":{ "stateToken":{ "type":"string", "description":"A generated string value that represents a particular state of the attachment.
\nIn general, it is used to allow modifications of the attachment to proceed. It is essentially saying ...\ndelete this attachment if its current stateToken matches this value. If the values do\nnot match, the modification is not permitted and the operation results in an error.
This represents the attachment to be deleted. It can be the entire attachment object, but the only attribute that is necessary is\nthe stateToken. It is necessary to verify the delete operation can proceed.
The value of the stateToken needs to be the value from the attachment to delete, its believed current state. If the stateToken\nvalue does not match the attachment's current stateToken value, the delete operation will result in an error.
No Content
\n" }, "400":{ "description":"Bad Request
\nThe request could not be processed because it contains missing or invalid information, such as a\nvalidation error on an input field or a missing required value. The response will be an\nError Detail object.
\n" }, "403":{ "description":"Forbidden
\nThe request was valid and was understood, but the server is refusing action. This may be due to the account\nnot having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate\nitem where only one is allowed). The response will be an Error Detail object.
\n" }, "404":{ "description":"Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "409":{ "description":"Conflict
\nThis response indicates the request conflicts with current state of the target resource. The response will be an\nError Detail object.
\nGenerally, an error response of 412 (Precondition Failed) will be returned. But a Conflict can occur when\nthere are simultaneous edits on a resource.
\n" }, "412":{ "description":"Precondition Failed
\nThe server does not meet one of the preconditions of the request. The response will be an\nError Detail object.
\nThis error response is used specifically when the stateToken used in the request body does not\nmatch the current stateToken of the resource.
Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } }, "/documents/{docId}/attachments/{attId}/content":{ "get":{ "x-internal-id":"documents-{docId}-attachments-{attId}-content-get", "x-filename-id":"documents-docid-attachments-attid-content-get", "summary":"Get the Attachment Content", "operationId":"readAttachmentContent", "tags":[ "Attachments" ], "description":"This operation will return the raw content of the attachment specified by the docId and attId parameters.
\n\nThe Content-Type of the response is dependent on the mediaType of the attachment. This can vary.
It is an error if the attachment is not attached to the given document.
\n\nNote: If the OAuth token represents an account that is a Capture Administator, the response will return the given\nattachment, provided it exists. If the OAuth token does not represent an account that is a Capture Administator, meaning it\nis just a Capture User, the response will only return the attachment if it exists and its document is currently in a step in which\nthe account as been granted explict access.
\n", "parameters":[ { "name":"docId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the document in Capture.
\n" }, { "name":"attId", "in":"path", "type":"string", "required":true, "description":"The unique identifier of the attachment in Capture.
\n" } ], "produces":[ "*/*" ], "responses":{ "200":{ "description":"The attachment's raw content specified by the docId and attId parameters.
\nThe Content-Type of the response is dependent on the mediaType of the attachment.
Not Found
\nThe request includes a resource URI that does not exist. The response will be an\nError Detail object.
\n" }, "500":{ "description":"Internal Server Error
\nThe server encountered an unexpected condition that prevented it from fulfilling the request. The response\nwill be an Error Detail object.
\n" } } } } } }