Show Source

• batchAuditMessages(optional): array batchAuditMessages

  This array contains all batch audit event messages. It is time ordered (descending) by the message timestamp.

• detailMessages(optional): array detailMessages

  This array contains all the logging messages associated with the batch. It is time ordered (descending) by the message timestamp.

• documentAuditMessages(optional): array documentAuditMessages

  This array contains all document audit event message that pertain to this batch. It is time ordered (descending) by the message timestamp.

{
    "type":"object",
    "title":"Batch History",
    "description":"<p>This object contains a collection of messages that detail the history of a batch as it progresses through Capture.</p>\n<p>The history is set of audit events and associated detail messages. For instance, several <i>processing</i> 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.</p>\n",
    "properties":{
        "batchAuditMessages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HistoryMessage"
            },
            "description":"<p>This array contains all batch audit event messages. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
        },
        "documentAuditMessages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HistoryMessage"
            },
            "description":"<p>This array contains all document audit event message that pertain to this batch. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
        },
        "detailMessages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HistoryMessage"
            },
            "description":"<p>This array contains all the logging messages associated with the batch. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
        }
    }
}

Show Source

• Array of: object History Message
  Title: History Message

  This message that occurs in Capture that represents a distinct audit event, or associated logging message.

  A message will always be associated to an individual audit event. But, the message can be the actual audit event. Other messages provide more detail related to that event.

  The message produced in Capture will be associated to a Batch. They may, or may not, be associated to a Document in that batch.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HistoryMessage"
    },
    "description":"<p>This array contains all batch audit event messages. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
}

Show Source

• Array of: object History Message
  Title: History Message

  This message that occurs in Capture that represents a distinct audit event, or associated logging message.

  A message will always be associated to an individual audit event. But, the message can be the actual audit event. Other messages provide more detail related to that event.

  The message produced in Capture will be associated to a Batch. They may, or may not, be associated to a Document in that batch.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HistoryMessage"
    },
    "description":"<p>This array contains all the logging messages associated with the batch. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
}

Show Source

• Array of: object History Message
  Title: History Message

  This message that occurs in Capture that represents a distinct audit event, or associated logging message.

  A message will always be associated to an individual audit event. But, the message can be the actual audit event. Other messages provide more detail related to that event.

  The message produced in Capture will be associated to a Batch. They may, or may not, be associated to a Document in that batch.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HistoryMessage"
    },
    "description":"<p>This array contains all document audit event message that pertain to this batch. It is time ordered (descending) by the\nmessage <code>timestamp</code>.</p>\n"
}

Show Source

• auditId(optional): string

  The audit identifier of the message. This identifier is used to correlate messages with each other. Messages with the same auditId are part of the same occurrence of the given audit event.

• batchId(optional): string

  The associated batch identifier.

• batchName(optional): string

  The associated batch name.

• documentId(optional): string

  The associated document identifier, if the message pertains to a document.

• documentTitle(optional): string

  The associated document name, if the message pertains to a document.

  The title of a document may change. This will be the title of the document at the time the message occurred.

• message(optional): string

  The message content produced by Capture.

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

  This identifies when the message occurred. 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":"History Message",
    "description":"<p>This message that occurs in Capture that represents a distinct audit event, or associated logging message.</p>\n<p>A 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.</p>\n<p>The message produced in Capture will be associated to a <i>Batch</i>. They may, or may not, be associated\nto a <i>Document</i> in that batch.</p>\n",
    "properties":{
        "auditId":{
            "type":"string",
            "description":"<p>The audit identifier of the message. This identifier is used to correlate messages with each other. Messages\nwith the same <code>auditId</code> are part of the same occurrence of the given audit event.</p>\n"
        },
        "batchId":{
            "type":"string",
            "description":"<p>The associated batch identifier.</p>\n"
        },
        "batchName":{
            "type":"string",
            "description":"<p>The associated batch name.</p>\n"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The associated document identifier, if the message pertains to a document.</p>\n"
        },
        "documentTitle":{
            "type":"string",
            "description":"<p>The associated document name, if the message pertains to a document.</p>\n<p>The title of a document may change. This will be the title of the document at the time the message occurred.</p>\n"
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This identifies when the message occurred. 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"
        },
        "message":{
            "type":"string",
            "description":"<p>The message content produced by Capture.</p>\n"
        }
    }
}