機械翻訳について

移動

• リクエスト
• レスポンス

バッチの履歴の取得

get

/capture/api/v1.1/batches/{batchId}/history

この操作では、batchIdパラメータで指定された指定バッチのこのhistoryが返されます。 この履歴は、バッチ内で発生したメッセージ・アクティビティのコレクションおよび関連ドキュメントです。 基本的に、そのバッチ処理のアクティビティ・ロギングを表します。

historyは、バッチが存在する場合にのみ使用できます。 手動またはコミット操作によってキャプチャからバッチが削除されると、このhistoryはシステムから削除されます。 その時点で取得できるのは監査情報のみです。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• batchId: string

  取得でのバッチの一意識別子。

問合せパラメータ

• locale(optional): string

  localeパラメータは、監査イベントのメッセージに使用される言語翻訳を指定するために使用されます。 詳細アクティビティ・メッセージの言語には影響しません。 値は、RFC 4647で定義されている標準言語タグの形式である必要があります。

  これを指定しない場合、デフォルトの言語設定ロケールが使用されます。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

batchIdで指定されたバッチ履歴。

本文()

ルート・スキーマ : バッチ履歴

型: object

タイトル: Batch History

このオブジェクトには、キャプチャによるバッチの進捗状況を詳細に示すメッセージのコレクションが含まれています。

履歴は、監査イベントおよび関連する詳細メッセージのセットです。 たとえば、バッチの存続期間中に複数のprocessing監査イベントが発生する場合があります。 バッチ処理が発生すると、詳細メッセージがログに書き込まれ、処理中の処理内容に関する詳細情報が提供されます。

Show Source

• batchAuditMessages(optional): array batchAuditMessages

  この配列には、すべてのバッチ監査イベント・メッセージが含まれます。 メッセージtimestampによって順序付け(降順)される時間です。

• detailMessages(optional): array detailMessages

  この配列には、バッチに関連付けられたすべてのロギング・メッセージが含まれます。 メッセージtimestampによって順序付け(降順)される時間です。

• documentAuditMessages(optional): array documentAuditMessages

  この配列には、このバッチに関連するすべての文書監査イベント・メッセージが含まれます。 メッセージ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"
        }
    }
}

ネストされたスキーマ : batchAuditMessages

型: array

この配列には、すべてのバッチ監査イベント・メッセージが含まれます。 メッセージtimestampによって順序付け(降順)される時間です。

Show Source

• Array of: object History Message
  タイトル: History Message

  このメッセージは、個別の監査イベントまたは関連するロギング・メッセージを表すCaptureで発生します。

  メッセージは常に個別の監査イベントに関連付けられます。 ただし、メッセージは実際の監査イベントになる可能性があります。 その他のメッセージは、そのイベントに関連する詳細を提供します。

  Captureで生成されるメッセージは、「バッチ」に関連付けられます。 そのバッチの「ドキュメント」に関連付けられている場合と関連付けられない場合があります。

{
    "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"
}

ネストされたスキーマ : detailMessages

型: array

この配列には、バッチに関連付けられたすべてのロギング・メッセージが含まれます。 メッセージtimestampによって順序付け(降順)される時間です。

Show Source

• Array of: object History Message
  タイトル: History Message

  このメッセージは、個別の監査イベントまたは関連するロギング・メッセージを表すCaptureで発生します。

  メッセージは常に個別の監査イベントに関連付けられます。 ただし、メッセージは実際の監査イベントになる可能性があります。 その他のメッセージは、そのイベントに関連する詳細を提供します。

  Captureで生成されるメッセージは、「バッチ」に関連付けられます。 そのバッチの「ドキュメント」に関連付けられている場合と関連付けられない場合があります。

{
    "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"
}

ネストされたスキーマ : documentAuditMessages

型: array

この配列には、このバッチに関連するすべての文書監査イベント・メッセージが含まれます。 メッセージtimestampによって順序付け(降順)される時間です。

Show Source

• Array of: object History Message
  タイトル: History Message

  このメッセージは、個別の監査イベントまたは関連するロギング・メッセージを表すCaptureで発生します。

  メッセージは常に個別の監査イベントに関連付けられます。 ただし、メッセージは実際の監査イベントになる可能性があります。 その他のメッセージは、そのイベントに関連する詳細を提供します。

  Captureで生成されるメッセージは、「バッチ」に関連付けられます。 そのバッチの「ドキュメント」に関連付けられている場合と関連付けられない場合があります。

{
    "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"
}

ネストされたスキーマ : 履歴メッセージ

型: object

タイトル: History Message

このメッセージは、個別の監査イベントまたは関連するロギング・メッセージを表すCaptureで発生します。

メッセージは常に個別の監査イベントに関連付けられます。 ただし、メッセージは実際の監査イベントになる可能性があります。 その他のメッセージは、そのイベントに関連する詳細を提供します。

Captureで生成されるメッセージは、「バッチ」に関連付けられます。 そのバッチの「ドキュメント」に関連付けられている場合と関連付けられない場合があります。

Show Source

• auditId(optional): string

  メッセージの監査識別子。 この識別子は、メッセージを相互に関連付けるために使用されます。 同じauditIdを持つメッセージは、指定された監査イベントの同じ出現の一部です。

• batchId(optional): string

  関連付けられたバッチ識別子。

• batchName(optional): string

  関連付けられたバッチ名。

• documentId(optional): string

  メッセージがドキュメントに関連する場合、関連するドキュメント識別子。

• documentTitle(optional): string

  メッセージがドキュメントに関連する場合、関連するドキュメント名。

  ドキュメントのタイトルが変更される場合があります。 これは、メッセージ発生時のドキュメントのタイトルになります。

• message(optional): string

  Captureによって生成されるメッセージ・コンテンツ。

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

  これは、メッセージの発生時期を識別します。 「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、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"
        }
    }
}

404レスポンス

Not Found

リクエストに、存在しないリソースURIが含まれています。 レスポンスは「エラーの詳細」オブジェクトになります。

500レスポンス

内部サーバー・エラー

サーバーで予期しない状態が発生し、リクエストを処理できませんでした。 レスポンスは「エラーの詳細」オブジェクトになります。

トップに戻る