• createdBy(optional): object createdBy

  The user that created the batch.

• createdDate(optional): string(date-time)

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

• error(optional): string

  The current error message of the batch, if any.

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

• id(optional): string

  The unique identifier of the batch.

• links(optional): array links

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

• lock(optional): object lock

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

• name(optional): string

  The name given to the batch.

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

• notes(optional): string

  User supplied general notes associated with a batch.

• priority(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 10

  Default Value: 0

  A user specified priority of the batch.

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

• procedure(optional): object procedure

  The Capture Procedure associated with this batch.

• state(optional): string
  Default Value: READY

  The current state of the batch.

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

  The current status assigned to the batch.

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

• updatedBy(optional): object updatedBy

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

• updatedDate(optional): string(date-time)

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

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

• object User Information
  Title: User Information

  This object contains information about a given user of Capture.

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

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

• Array of: object HATEOAS Link
  Title: HATEOAS Link

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

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

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

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

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

• lockedBy(optional): object lockedBy

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

• lockedDate(optional): string(date-time)

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

• step(optional): object step

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

• workstation(optional): string

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

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

• object Capture Procedure
  Title: Capture Procedure

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

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

• object User Information
  Title: User Information

  This object contains information about a given user of Capture.

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

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

• name: string

  The user's name.

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

• href(optional): string

  The target resource URI. URI RFC 3986 or URI Template RFC 6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string
  Default Value: application/json

  Media type, as defined by RFC 2046, describing the link target. The property can be assumed to be application/json if the property is not present.

• method(optional): string
  Default Value: GET

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

  The property can be assumed to be GET if the property is not present.

• profile(optional): string(uri)

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

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean
  Default Value: false

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

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

• object User Information
  Title: User Information

  This object contains information about a given user of Capture.

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

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

• object Procedure Step
  Title: Procedure Step

  A step in a procedure flow.

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

• id(optional): string

  The unique identifier of the step within the procedure.

• name(optional): string

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

• type(optional): string

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

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

• id(optional): string

  The unique identifier of the procedure in Capture.

• name(optional): string

  The name given to the procedure when created

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