Content Capture用のREST API

タスク・キューでの文書処理の完了

put

/capture/api/v1.1/steps/{stepId}/tasks/documents/complete

この操作は、外部システムによって使用され、指定された文書が処理済であることを識別します。タスクの処理は、成功または失敗の原因となり、リクエスト本文でそれを識別する必要があります。ただし、これは外部システムがドキュメントの処理を完了したことを示します。

リクエスト本文は、完了したドキュメント・タスク結果の配列です。

アレイでドキュメント・タスクの結果が完了しなかった場合、アレイ内の他の結果は影響を受けません。ただし、レスポンスは、ステータス・コード「422処理不可エンティティ」のエラーを示し、完了できなかった結果の配列がエラーとともに含まれます。

ノート: このリクエストで使用されるOAuthトークンは、stepIdで識別されるステップへの攻撃アクセス権を付与されたアカウントを表す必要があります。アカウントが「管理者の取得」または「ユーザーの取得」を表す場合、違いは発生しません。

リクエスト

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

application/json

パス・パラメータ

stepId: string

取得の処理ステップの一意の識別子。

ヘッダー・パラメータ

X-Requested-With: string

クロスサイト・リクエスト・フォージェリ(CSRF)攻撃を防ぐために使用されるヘッダー。サポートされている値はXMLHttpRequestのみです。

ルート・スキーマ : 文書タスク結果

型: array

タイトル: Document Task Results

これは、「文書タスク結果」オブジェクトの配列です。各オブジェクトは、完了する文書タスクを表します。

Show Source

Array of: object Document Task Result
タイトル: Document Task Result
「文書タスク結果」は、処理が完了したドキュメント・タスクです。正常に完了または失敗完了のいずれかです。

taskNumberは必須です。 documentは必須であり、stateToken属性の最小値に含める必要があります。また、ドキュメントで更新する必要のある他の属性を含めることもできます。処理結果がエラーの場合は、適切なエラー詳細を含める必要があります。

配列内の各タスクのdocumentパラメータはドキュメント・オブジェクトであり、基本的に、リクエスト本文および更新可能な属性を含むドキュメントを「パッチ」します。 merge-patchメディア・サブタイプは使用されません。これは、ドキュメント・オブジェクトに配列が含まれ、それによって配列のコンテンツ全体がリクエスト本文に含まれる必要があるためです。 merge-patchを管理するRFC 7386は、配列で要素を更新する重要な要素を提供しません。 merge-patchは使用されませんが、リクエスト本文に必要な変更のみが必要であるため、更新されるフィールドのみが存在する必要があります。ドキュメントの更新可能な属性は次のとおりです:
- title
- profile
- fields
- comment
titleまたはcommentの更新は単純な文字列変更です。ドキュメント・プロファイル( profile)を更新するには、その値を別のドキュメント・プロファイル・オブジェクトに設定する必要があります。オブジェクトには、id属性またはname属性のいずれか、または両方が含まれている必要があります。プロシージャ定義では名前が一意であるため、必要な属性は1つのみです。現在のドキュメント・プロファイルまたはその他の属性をクリアするには、ドキュメント・オブジェクトのその値をnullに設定する必要があります。最後に、設定または変更されるフィールドのみがfields配列に存在する必要があります。

配列内の各タスクのdocumentパラメータには、少なくともstateTokenが含まれている必要があります。これは、オブジェクトが更新されているものと同じになるようにするために必要です。 stateTokenは、最後にリクエストされた時点からすでに更新されている場合には異なります。これにより、同時更新が行われず、データの上書きが防止されます。

処理中にエラーが発生した場合は、error属性で処理中に発生したエラーが含まれている必要があります。

{
    "type":"array",
    "title":"Document Task Results",
    "description":"<p>This is an array of <i>Document Task Result</i> objects. Each object represent a document task to complete.</p>\n",
    "items":{
        "$ref":"#/definitions/DocumentTaskResult"
    }
}

ネストされたスキーマ : 文書タスク結果

型: object

タイトル: Document Task Result

「文書タスク結果」は、処理が完了したドキュメント・タスクです。正常に完了または失敗完了のいずれかです。

taskNumberは必須です。 documentは必須であり、stateToken属性の最小値に含める必要があります。また、ドキュメントで更新する必要のある他の属性を含めることもできます。処理結果がエラーの場合は、適切なエラー詳細を含める必要があります。

配列内の各タスクのdocumentパラメータはドキュメント・オブジェクトであり、基本的に、リクエスト本文および更新可能な属性を含むドキュメントを「パッチ」します。 merge-patchメディア・サブタイプは使用されません。これは、ドキュメント・オブジェクトに配列が含まれ、それによって配列のコンテンツ全体がリクエスト本文に含まれる必要があるためです。 merge-patchを管理するRFC 7386は、配列で要素を更新する重要な要素を提供しません。 merge-patchは使用されませんが、リクエスト本文に必要な変更のみが必要であるため、更新されるフィールドのみが存在する必要があります。ドキュメントの更新可能な属性は次のとおりです:

title
profile
fields
comment

titleまたはcommentの更新は単純な文字列変更です。ドキュメント・プロファイル( profile)を更新するには、その値を別のドキュメント・プロファイル・オブジェクトに設定する必要があります。オブジェクトには、id属性またはname属性のいずれか、または両方が含まれている必要があります。プロシージャ定義では名前が一意であるため、必要な属性は1つのみです。現在のドキュメント・プロファイルまたはその他の属性をクリアするには、ドキュメント・オブジェクトのその値をnullに設定する必要があります。最後に、設定または変更されるフィールドのみがfields配列に存在する必要があります。

配列内の各タスクのdocumentパラメータには、少なくともstateTokenが含まれている必要があります。これは、オブジェクトが更新されているものと同じになるようにするために必要です。 stateTokenは、最後にリクエストされた時点からすでに更新されている場合には異なります。これにより、同時更新が行われず、データの上書きが防止されます。

処理中にエラーが発生した場合は、error属性で処理中に発生したエラーが含まれている必要があります。

Show Source

document: object document

これは完了する「ドキュメント」です。更新する必要がある文書の属性を含めることができます。少なくとも、ドキュメントstateTokenを含める必要があります。
error(optional): object error

処理中に発生したエラーを説明する「エラーの詳細」です。
taskNumber: integer(int64)

ドキュメントおよびステップ・タスク・キューに固有の増分番号です。これは、ステップ・タスク・キューから取得したDocumentTaskのContent Captureで指定された数である必要があります。

{
    "type":"object",
    "title":"Document Task Result",
    "description":"<p>A <i>Document Task Result</i> is a document task that has completed processing. It can either be a successful completion or a failure completion.</p>\n\n<p>The <code>taskNumber</code> is required. The <code>document</code> is required and must contain, at a mimimum the <code>stateToken</code> 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.</p>\n\n<p>The <code>document</code> parameter of each task in the array is a document object and essentially\n<i>patches</i> the document with the attributes that are both present in the request body and updatable.\nA <i>merge-patch</i> 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.\n<a href=\"https://datatracker.ietf.org/doc/html/rfc7386\">RFC 7386</a>, which governs the <i>merge-patch</i>,\nprovides no sematics in which to update elements an array. Even though a <i>merge-patch</i> 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:</p>\n<ul>\n  <li><code>title</code></li>\n  <li><code>profile</code></li>\n  <li><code>fields</code></li>\n  <li><code>comment</code></li>\n</ul>\n<p>An update to either the <code>title</code> or <code>comment</code> is a simple string change. An update to the\ndocment profile (<code>profile</code>) requires setting its value to a different document profile object. The\nobject must contain either the <code>id</code> attribute or the <code>name</code> 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 <code>null</code>. Lastly,\nonly those fields that are being set or changed, need to exist in the <code>fields</code> array.</p>\n\n<p>The <code>document</code> parameter of each task in the array must contain, at a minimum, its <code>stateToken</code>.\nThis is necessary to ensure the object is still the same that is being updated. The <code>stateToken</code> 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.</p>\n\n<p>If there was a failure during processing, the <code>error</code> attribute must contain the error that occurred in processing.</p>\n",
    "properties":{
        "taskNumber":{
            "type":"integer",
            "format":"int64",
            "description":"<p> 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 <code>DocumentTask</code> obtained from the step task queue.</p>\n"
        },
        "document":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Document"
                }
            ],
            "description":"<p>This is the <i>Document</i> to be completed. It can contain attributes of the document that should be updated.\nAt a minimum, it must contain the document's <code>stateToken</code>.</p>\n"
        },
        "error":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/ErrorDetail"
                }
            ],
            "description":"<p>The is an <a href=\"./ErrorMessages.html\">Error Detail</a> that describes any error that occurred during processing.</p>\n"
        }
    },
    "required":[
        "taskNumber",
        "document"
    ]
}

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

型: object

これは完了する「ドキュメント」です。更新する必要がある文書の属性を含めることができます。少なくとも、ドキュメントstateTokenを含める必要があります。

すべてに一致

Show Source

object 「ドキュメント」

タイトル: Document

取得の「ドキュメント」は、カスタム・メタデータ・フィールドと組み合されたファイルです。メタデータ・フィールドは、キャプチャ・プロシージャで定義され、キャプチャ内で管理される情報の所有者として機能します。 「ドキュメント」には、添付を含めることもできます。 「添付」は、「ドキュメント」を拡張することを目的としており、多数のベア・リング・タイプの添付があります。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Document"
        }
    ],
    "description":"<p>This is the <i>Document</i> to be completed. It can contain attributes of the document that should be updated.\nAt a minimum, it must contain the document's <code>stateToken</code>.</p>\n"
}

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

型: object

処理中に発生したエラーを説明する「エラーの詳細」です。

すべてに一致

Show Source

object 「エラーの詳細」

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ErrorDetail"
        }
    ],
    "description":"<p>The is an <a href=\"./ErrorMessages.html\">Error Detail</a> that describes any error that occurred during processing.</p>\n"
}

ネストされたスキーマ : ドキュメント

型: object

タイトル: Document

取得の「ドキュメント」は、カスタム・メタデータ・フィールドと組み合されたファイルです。メタデータ・フィールドは、キャプチャ・プロシージャで定義され、キャプチャ内で管理される情報の所有者として機能します。 「ドキュメント」には、添付を含めることもできます。 「添付」は、「ドキュメント」を拡張することを目的としており、多数のベア・リング・タイプの添付があります。

Show Source

batch(optional): object batch

このドキュメントを含む取得バッチ。
comment(optional): string

このドキュメントの全般的な使用コメント。
createdBy(optional): object createdBy

ドキュメントを作成したユーザー。
createdDate(optional): string(date-time)

これは、文書が作成された時期を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
fields(optional): array fields

これは、このドキュメントで使用できるすべてのフィールド値の配列です。
id(optional): string

取得内の文書の一意の識別子。
links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。
mediaType(optional): string

ドキュメントのメディア・タイプを表します。これは、インターネットで送信されるファイル・フォーマットおよびフォーマット・コンテンツの2部分識別子です。
profile(optional): object profile

この文書に割り当てられている文書プロファイル。
size(optional): integer(int64)

ドキュメントのサイズ(バイト単位)。
sourceName(optional): string

インポート時の文書のファイル名。
stateToken(optional): string

ドキュメントの特定の状態を表す生成された文字列値。

一般に、ドキュメントの変更を続行できるようにするために使用されます。本質的に言っているのだ... 「現在のstateTokenがこの値と一致する場合は、このドキュメントを変更」。値が一致しない場合、変更は許可されず、操作によってエラーが発生します。
step(optional): object step

現在の処理ステップ(存在する場合)は、この文書を実行中です。
title(optional): string

ドキュメントのtitle。これは通常、ドキュメントのインポート時に使用されるファイル名です。
updatedBy(optional): object updatedBy

ドキュメントを更新した最後のユーザー。
updatedDate(optional): string(date-time)

文書が最後に更新された日時を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。

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

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

型: object

このドキュメントを含む取得バッチ。

すべてに一致

Show Source

object 「バッチの取得」

タイトル: Capture Batch

プロシージャの作業単位を表す、キャプチャ内のドキュメントのコレクション。

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

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

型: object

ドキュメントを作成したユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

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

型: array

これは、このドキュメントで使用できるすべてのフィールド値の配列です。

Show Source

Array of: object Field Value

タイトル: Field Value

フィールド値は、基本フィールド定義と実際の値を組み合せた取得メタデータ・フィールドです。

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

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。

Show Source

Array of: object HATEOAS Link
タイトル: HATEOAS Link
これは、HATEOASリンクおよび関連メタデータです。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Internet Assigned Numbers Authority (IANA)は、HATEOASリンクで使用するために「リンク関係」のレジストリを保持します。これらは有名な関係で、特定の意味を持つ。応募者がキャプチャでいる場合は、それらが使用されます。たとえば、canonicalは既知の関係で、Captureではそれを使用します。

どのような登録関係でも適切な意味が提供されていないため、キャプチャでは、特定のケースで独自のリンク関係が定義されます。 Webリンク(RFC 8288)のRFCで定義されているように、関係はURIである必要があります。次のリンク関係は、Captureによって定義されます:
- urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
- urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
- urn:oce:capture:attachment-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"
}

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

型: object

この文書に割り当てられている文書プロファイル。

すべてに一致

Show Source

object 「ドキュメント・プロファイル」

タイトル: Document Profile

「ドキュメント・プロファイル」は、キャプチャ・プロシージャで定義されたカスタム・メタデータ・フィールドのコレクションをドキュメントに関連付けます。また、添付タイプを関連付けることもできます。

これらは、ドキュメントを分類して処理するために取得で使用されます。ドキュメント・プロファイルでは、プロシージャからドキュメントへのカスタム・メタデータ・フィールドおよび添付タイプが関連付けられますが、これらのフィールドまたは添付のみにメタデータが制限されることはありません。取得クライアント内での表示/管理に使用されます。

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

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

型: object

現在の処理ステップ(存在する場合)は、この文書を実行中です。

すべてに一致

Show Source

object 「プロシージャ・ステップ」

タイトル: Procedure Step

プロシージャ・フロー内のステップ。

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

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

型: object

ドキュメントを更新した最後のユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

ネストされたスキーマ : バッチの取得

型: object

タイトル: Capture Batch

プロシージャの作業単位を表す、キャプチャ内のドキュメントのコレクション。

Show Source

createdBy(optional): object createdBy

バッチを作成したユーザー。
createdDate(optional): string(date-time)

これは、バッチが作成された時期を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
error(optional): string

バッチの現在のエラー・メッセージ(存在する場合)。

バッチがERROR stateにある場合、バッチ処理に失敗した理由を示すエラー・メッセージが表示されます。このメッセージは、バッチ処理が再エンターされるまで残ります。
id(optional): string

バッチの一意識別子。
links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。
lock(optional): object lock

batchがlockedの場合(ユーザーがバッチを作成/編集する場合、またはキャプチャが現在バッチを処理している場合)、このオブジェクトにはロックに関する情報が含まれます。バッチのstateは、このオブジェクトが存在するかどうかを決定します。
name(optional): string

バッチに指定された名前。

取得でバッチを作成する場合、名前は定義済のプレフィクスと連番になります。たとえば、inv_4781です
notes(optional): string

バッチに関連付けられたユーザー指定の一般ノート。
priority(optional): integer(int32)

最小値: 0

最大値: 10

デフォルト値: 0

ユーザーがバッチの優先度を指定しました。

この値は、ユーザーの注意のためにバッチを優先するために使用されます。クライアントで表示するバッチをフィルタおよびソートするために使用されます。
procedure(optional): object procedure

このバッチに関連付けられた取得プロシージャ。
state(optional): string
デフォルト値: READY
バッチの現在の状態。
- READY - バッチの標準保存状態。クライアントによってロックできます。
- LOCKED - バッチは、ドキュメントの追加/削除やメタデータ・フィールド値の設定など、編集のためにクライアントによってロックされます。
- ERROR - 処理中にエラーが発生しました。処理エラーを修正するために、編集のためにクライアントによってロックできます。
- PROCESSING - 取得は現在バッチを処理しています。バッチは、取得プロシージャで定義されたジョブのいずれかにあります。
status(optional): string

バッチに割り当てられた現在のステータス。

ステータス値はプロシージャで定義され、バッチ作成時および処理ジョブ間の遷移時に割り当てることができます。
updatedBy(optional): object updatedBy

バッチを更新した最後のユーザー。これはキャプチャ・システムです。
updatedDate(optional): string(date-time)

これにより、バッチの最終更新日時が識別されます。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、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"
        }
    }
}

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

型: object

バッチを作成したユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。

Show Source

Array of: object HATEOAS Link
タイトル: HATEOAS Link
これは、HATEOASリンクおよび関連メタデータです。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Internet Assigned Numbers Authority (IANA)は、HATEOASリンクで使用するために「リンク関係」のレジストリを保持します。これらは有名な関係で、特定の意味を持つ。応募者がキャプチャでいる場合は、それらが使用されます。たとえば、canonicalは既知の関係で、Captureではそれを使用します。

どのような登録関係でも適切な意味が提供されていないため、キャプチャでは、特定のケースで独自のリンク関係が定義されます。 Webリンク(RFC 8288)のRFCで定義されているように、関係はURIである必要があります。次のリンク関係は、Captureによって定義されます:
- urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
- urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
- urn:oce:capture:attachment-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"
}

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

型: object

batchがlockedの場合(ユーザーがバッチを作成/編集する場合、またはキャプチャが現在バッチを処理している場合)、このオブジェクトにはロックに関する情報が含まれます。バッチのstateは、このオブジェクトが存在するかどうかを決定します。

Show Source

lockedBy(optional): object lockedBy

取得クライアント・インスタンス内でbatchがlockedの場合、この属性にはバッチをlockedするユーザーが含まれます。
lockedDate(optional): string(date-time)

これは、バッチがいつロックされたかを識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
step(optional): object step

取得が現在バッチを処理している場合、このオブジェクトには、バッチが進行中の現在の処理ステップが含まれます。
workstation(optional): string

取得クライアント・インスタンス内のbatchがlockedの場合、この属性には、キャプチャ・クライアント・インスタンスがバッチをlockedするコンピュータ名が含まれます。

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

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

型: object

このバッチに関連付けられた取得プロシージャ。

すべてに一致

Show Source

object 「プロシージャの取得」

タイトル: Capture Procedure

取得プロシージャでは、フローのメタデータおよび進捗ステップを定義します。

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

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

型: object

バッチを更新した最後のユーザー。これはキャプチャ・システムです。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

ネストされたスキーマ : ユーザー情報

型: object

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

Show Source

name: string

ユーザー名。

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

ネストされたスキーマ : HATEOASリンク

型: object

タイトル: HATEOAS Link

これは、HATEOASリンクおよび関連メタデータです。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Internet Assigned Numbers Authority (IANA)は、HATEOASリンクで使用するために「リンク関係」のレジストリを保持します。これらは有名な関係で、特定の意味を持つ。応募者がキャプチャでいる場合は、それらが使用されます。たとえば、canonicalは既知の関係で、Captureではそれを使用します。

どのような登録関係でも適切な意味が提供されていないため、キャプチャでは、特定のケースで独自のリンク関係が定義されます。 Webリンク(RFC 8288)のRFCで定義されているように、関係はURIである必要があります。次のリンク関係は、Captureによって定義されます:

urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
urn:oce:capture:attachment-content - 添付コンテンツの取得に使用されるリンクを表します

Show Source

href(optional): string

ターゲット・リソースのURI URI RFC 3986またはURIテンプレートRFC 6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

デフォルト値: application/json

RFC 2046で定義されたメディア・タイプで、リンク・ターゲットを記述します。プロパティが存在しない場合、application/jsonとみなすことができます。
method(optional): string
デフォルト値: GET
リンクのターゲットをリクエストするためのHTTPメソッド。

有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
プロパティが存在しない場合、GETとみなすことができます。
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。使用できない場合は、このプロパティは存在しません。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

デフォルト値: false

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

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

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

型: object

取得クライアント・インスタンス内でbatchがlockedの場合、この属性にはバッチをlockedするユーザーが含まれます。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

型: object

取得が現在バッチを処理している場合、このオブジェクトには、バッチが進行中の現在の処理ステップが含まれます。

すべてに一致

Show Source

object 「プロシージャ・ステップ」

タイトル: Procedure 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"
}

ネストされたスキーマ : プロシージャ・ステップ

型: object

タイトル: Procedure Step

プロシージャ・フロー内のステップ。

Show Source

id(optional): string

プロシージャ内のステップの一意の識別子。
name(optional): string

作成時にステップに指定された名前。たとえば、処理ジョブまたはコミット・プロファイルの名前。
type(optional): string

ステップのタイプ。次に例を示します: 外部プロセッサ, TIFF換算プロセッサ, アセット参照プロセッサ, 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"
        }
    }
}

ネストされたスキーマ : プロシージャの取得

型: object

タイトル: Capture Procedure

取得プロシージャでは、フローのメタデータおよび進捗ステップを定義します。

Show Source

id(optional): string

取得でのプロシージャの一意の識別子。
name(optional): string

作成時にプロシージャに指定された名前

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

ネストされたスキーマ : フィールド値

型: object

タイトル: Field Value

フィールド値は、基本フィールド定義と実際の値を組み合せた取得メタデータ・フィールドです。

Show Source

dataType(optional): string
デフォルト値: ALPHA_NUMERIC
フィールドのデータ型。 Captureでは、次の6つのデータ型がサポートされています:
- NUMERIC - 整数ベースの数値
- ALPHA_NUMERIC - 一般的なテキストまたは文字列値
- DATE - RFC 3339で管理される「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')の日付/時間値
- FLOAT - 浮動小数点数値
- ITEM_REFERENCE - Oracle Content Managementのコンテンツ・アイテムへの「人差し指」
- ASSET_REFERENCE - Oracle Content Managementのデジタル・アセットへの「人差し指」
- CATEGORY_REFERENCE - Oracle Content Managementのタクソノミ・カテゴリに対する「人差し指」
- LANGUAGE - RFC 4647で定義されている言語コード。
name(optional): string

フィールドの名前。
value(optional): string

指定されたキャプチャ・ドキュメントに関連する、このメタデータ・フィールドの実際の値。

フィールドには最初の値は含まれません。これらは設定する必要があります。これは、メタデータ・フィールド定義のデフォルト値、取得クライアントで指定されたユーザー、または取得処理ジョブによって実行されます。

取得のフィールドには、null値の概念がありません。フィールドに値があるか、値がありません。 「空白」は、値がないことを意味します。

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

ネストされたスキーマ : ドキュメント・プロファイル

型: object

タイトル: Document Profile

「ドキュメント・プロファイル」は、キャプチャ・プロシージャで定義されたカスタム・メタデータ・フィールドのコレクションをドキュメントに関連付けます。また、添付タイプを関連付けることもできます。

これらは、ドキュメントを分類して処理するために取得で使用されます。ドキュメント・プロファイルでは、プロシージャからドキュメントへのカスタム・メタデータ・フィールドおよび添付タイプが関連付けられますが、これらのフィールドまたは添付のみにメタデータが制限されることはありません。取得クライアント内での表示/管理に使用されます。

Show Source

id(optional): string

ドキュメント・プロファイルの一意識別子。
name(optional): string

文書プロファイルに指定された名前。

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

ネストされたスキーマ : エラーの詳細

型: object

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読可能な複数行の可能性があり、その問題を詳細に説明します。
instance(optional): string(URI)

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array Error Details

タイトル: Error Details
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title: string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type: string(URI)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなど、問題の人間が読めるサマリーを提供します。

{
    "type":"object",
    "title":"Error Detail",
    "description":"<p>This represents an error in the system, and is the response object returned.</p>\n",
    "properties":{
        "type":{
            "type":"string",
            "format":"URI",
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <b>should</b> provide a human-readable summary of the problem, for example, as a HTML page.</p>\n"
        },
        "title":{
            "type":"string",
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>\n"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Corresponding HTTP status code for the error.</p>\n"
        },
        "detail":{
            "type":"string",
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line, description the problem in more details.</p>\n"
        },
        "instance":{
            "type":"string",
            "format":"URI",
            "description":"<p>URI to the link that provides more detail about the error.</p>\n"
        },
        "o:errorCode":{
            "type":"string",
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>\n"
        },
        "o:errorPath":{
            "type":"string",
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>\n"
        },
        "o:errorDetails":{
            "type":"array",
            "title":"Error Details",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    },
    "required":[
        "type",
        "title"
    ]
}

ネストされたスキーマ : エラーの詳細

型: array

タイトル: Error Details

Show Source

Array of: object Error Detail

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

{
    "type":"array",
    "title":"Error Details",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

トップに戻る

レスポンス

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

application/json

204レスポンス

内容なし

400レスポンス

不正リクエスト

情報が欠落しているか無効であるため(入力フィールドでの検証エラー、必須値の欠落など)、リクエストを処理できませんでした。レスポンスは「エラーの詳細」オブジェクトになります。

403レスポンス

禁止

リクエストは有効で、認識されましたが、サーバーはアクションを拒否しています。これは、リソースに必要な権限がないアカウント、または禁止されたアクション(たとえば、1つのみが許可されている重複アイテムの作成)を試みていることが原因である可能性があります。レスポンスは「エラーの詳細」オブジェクトになります。

404レスポンス

Not Found

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

422レスポンス

処理できないエンティティ

リクエストの形式は良好でしたが、サーバーは含まれているリソース/手順を処理できませんでした。

レスポンスは、「文書タスク・エラー」オブジェクトの配列です。完了できなかった文書タスクごとに配列にエントリがあります。 「文書タスク・エラー」オブジェクトのtaskNumberによる昇順になります。配列内の各「文書タスク・エラー」には、基礎となる原因の詳細を提供する「エラーの詳細」オブジェクトが含まれます。

ルート・スキーマ : 文書タスク・エラー

型: array

タイトル: Document Task Errors

これは、「文書タスク・エラー」オブジェクトの配列です。各オブジェクトは、完了できなかったドキュメントを識別します。

Show Source

Array of: object Document Task Error

タイトル: Document Task Error

「文書タスク・エラー」は、なんらかの理由で完了できなかったドキュメントで、エラーによって識別されます。

「ドキュメント」オブジェクトは、完全な操作のリクエスト本文の部分と同じオブジェクトです。 「エラーの詳細」オブジェクトには、ドキュメント・タスクの完了に失敗した理由を識別する情報が含まれます。

{
    "type":"array",
    "title":"Document Task Errors",
    "description":"<p>This is an array of <i>Document Task Error</i> objects. Each object identifies a document that failed to complete.</p>\n",
    "items":{
        "$ref":"#/definitions/DocumentTaskError"
    }
}

ネストされたスキーマ : 文書タスク・エラー

型: object

タイトル: Document Task Error

「文書タスク・エラー」は、なんらかの理由で完了できなかったドキュメントで、エラーによって識別されます。

「ドキュメント」オブジェクトは、完全な操作のリクエスト本文の部分と同じオブジェクトです。 「エラーの詳細」オブジェクトには、ドキュメント・タスクの完了に失敗した理由を識別する情報が含まれます。

Show Source

document: object document

これは、このタスクの完全な操作のリクエスト本文に含まれていた「ドキュメント」オブジェクトです。
error: object error

このタスクの完全な操作が失敗した理由を説明する「エラーの詳細」です。
taskNumber: integer(int64)

完了できなかったタスク番号。これは、ステップ・タスク・キューから取得したDocumentTaskのContent Captureで指定された数である必要があります。

{
    "type":"object",
    "title":"Document Task Error",
    "description":"<p>A <i>Document Task Error</i> is a document that failed to be completed for some reason, which is identified by the error.</p>\n<p>The <i>Document</i> object is the same object that part of the request body for the complete operation. The <i>Error Detail</i>\nobject will contain information that identifies why the document task failed to complete.</p>\n",
    "properties":{
        "taskNumber":{
            "type":"integer",
            "format":"int64",
            "description":"<p>That task number that failed to be completed. This needs to be the same number that that provided by Content Capture in\nthe <code>DocumentTask</code> obtained from the step task queue.</p>\n"
        },
        "document":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/Document"
                }
            ],
            "description":"<p>This is the <i>Document</i> object that was in the request body of the complete operation for this task.</p>\n"
        },
        "error":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/ErrorDetail"
                }
            ],
            "description":"<p>The is the <a href=\"./ErrorMessages.html\">Error Detail</a> that describes the reason the complete operation failed for this task.</p>\n"
        }
    },
    "required":[
        "taskNumber",
        "document",
        "error"
    ]
}

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

型: object

これは、このタスクの完全な操作のリクエスト本文に含まれていた「ドキュメント」オブジェクトです。

すべてに一致

Show Source

object 「ドキュメント」

タイトル: Document

取得の「ドキュメント」は、カスタム・メタデータ・フィールドと組み合されたファイルです。メタデータ・フィールドは、キャプチャ・プロシージャで定義され、キャプチャ内で管理される情報の所有者として機能します。 「ドキュメント」には、添付を含めることもできます。 「添付」は、「ドキュメント」を拡張することを目的としており、多数のベア・リング・タイプの添付があります。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Document"
        }
    ],
    "description":"<p>This is the <i>Document</i> object that was in the request body of the complete operation for this task.</p>\n"
}

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

型: object

このタスクの完全な操作が失敗した理由を説明する「エラーの詳細」です。

すべてに一致

Show Source

object 「エラーの詳細」

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ErrorDetail"
        }
    ],
    "description":"<p>The is the <a href=\"./ErrorMessages.html\">Error Detail</a> that describes the reason the complete operation failed for this task.</p>\n"
}

ネストされたスキーマ : ドキュメント

型: object

タイトル: Document

Show Source

batch(optional): object batch

このドキュメントを含む取得バッチ。
comment(optional): string

このドキュメントの全般的な使用コメント。
createdBy(optional): object createdBy

ドキュメントを作成したユーザー。
createdDate(optional): string(date-time)

これは、文書が作成された時期を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
fields(optional): array fields

これは、このドキュメントで使用できるすべてのフィールド値の配列です。
id(optional): string

取得内の文書の一意の識別子。
links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。
mediaType(optional): string

ドキュメントのメディア・タイプを表します。これは、インターネットで送信されるファイル・フォーマットおよびフォーマット・コンテンツの2部分識別子です。
profile(optional): object profile

この文書に割り当てられている文書プロファイル。
size(optional): integer(int64)

ドキュメントのサイズ(バイト単位)。
sourceName(optional): string

インポート時の文書のファイル名。
stateToken(optional): string

ドキュメントの特定の状態を表す生成された文字列値。

一般に、ドキュメントの変更を続行できるようにするために使用されます。本質的に言っているのだ... 「現在のstateTokenがこの値と一致する場合は、このドキュメントを変更」。値が一致しない場合、変更は許可されず、操作によってエラーが発生します。
step(optional): object step

現在の処理ステップ(存在する場合)は、この文書を実行中です。
title(optional): string

ドキュメントのtitle。これは通常、ドキュメントのインポート時に使用されるファイル名です。
updatedBy(optional): object updatedBy

ドキュメントを更新した最後のユーザー。
updatedDate(optional): string(date-time)

文書が最後に更新された日時を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。

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

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

型: object

このドキュメントを含む取得バッチ。

すべてに一致

Show Source

object 「バッチの取得」

タイトル: Capture Batch

プロシージャの作業単位を表す、キャプチャ内のドキュメントのコレクション。

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

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

型: object

ドキュメントを作成したユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

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

型: array

これは、このドキュメントで使用できるすべてのフィールド値の配列です。

Show Source

Array of: object Field Value

タイトル: Field Value

フィールド値は、基本フィールド定義と実際の値を組み合せた取得メタデータ・フィールドです。

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

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。

Show Source

Array of: object HATEOAS Link
タイトル: HATEOAS Link
これは、HATEOASリンクおよび関連メタデータです。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Internet Assigned Numbers Authority (IANA)は、HATEOASリンクで使用するために「リンク関係」のレジストリを保持します。これらは有名な関係で、特定の意味を持つ。応募者がキャプチャでいる場合は、それらが使用されます。たとえば、canonicalは既知の関係で、Captureではそれを使用します。

どのような登録関係でも適切な意味が提供されていないため、キャプチャでは、特定のケースで独自のリンク関係が定義されます。 Webリンク(RFC 8288)のRFCで定義されているように、関係はURIである必要があります。次のリンク関係は、Captureによって定義されます:
- urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
- urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
- urn:oce:capture:attachment-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"
}

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

型: object

この文書に割り当てられている文書プロファイル。

すべてに一致

Show Source

object 「ドキュメント・プロファイル」

タイトル: Document Profile

「ドキュメント・プロファイル」は、キャプチャ・プロシージャで定義されたカスタム・メタデータ・フィールドのコレクションをドキュメントに関連付けます。また、添付タイプを関連付けることもできます。

これらは、ドキュメントを分類して処理するために取得で使用されます。ドキュメント・プロファイルでは、プロシージャからドキュメントへのカスタム・メタデータ・フィールドおよび添付タイプが関連付けられますが、これらのフィールドまたは添付のみにメタデータが制限されることはありません。取得クライアント内での表示/管理に使用されます。

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

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

型: object

現在の処理ステップ(存在する場合)は、この文書を実行中です。

すべてに一致

Show Source

object 「プロシージャ・ステップ」

タイトル: Procedure Step

プロシージャ・フロー内のステップ。

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

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

型: object

ドキュメントを更新した最後のユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

ネストされたスキーマ : バッチの取得

型: object

タイトル: Capture Batch

プロシージャの作業単位を表す、キャプチャ内のドキュメントのコレクション。

Show Source

createdBy(optional): object createdBy

バッチを作成したユーザー。
createdDate(optional): string(date-time)

これは、バッチが作成された時期を識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
error(optional): string

バッチの現在のエラー・メッセージ(存在する場合)。

バッチがERROR stateにある場合、バッチ処理に失敗した理由を示すエラー・メッセージが表示されます。このメッセージは、バッチ処理が再エンターされるまで残ります。
id(optional): string

バッチの一意識別子。
links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。
lock(optional): object lock

batchがlockedの場合(ユーザーがバッチを作成/編集する場合、またはキャプチャが現在バッチを処理している場合)、このオブジェクトにはロックに関する情報が含まれます。バッチのstateは、このオブジェクトが存在するかどうかを決定します。
name(optional): string

バッチに指定された名前。

取得でバッチを作成する場合、名前は定義済のプレフィクスと連番になります。たとえば、inv_4781です
notes(optional): string

バッチに関連付けられたユーザー指定の一般ノート。
priority(optional): integer(int32)

最小値: 0

最大値: 10

デフォルト値: 0

ユーザーがバッチの優先度を指定しました。

この値は、ユーザーの注意のためにバッチを優先するために使用されます。クライアントで表示するバッチをフィルタおよびソートするために使用されます。
procedure(optional): object procedure

このバッチに関連付けられた取得プロシージャ。
state(optional): string
デフォルト値: READY
バッチの現在の状態。
- READY - バッチの標準保存状態。クライアントによってロックできます。
- LOCKED - バッチは、ドキュメントの追加/削除やメタデータ・フィールド値の設定など、編集のためにクライアントによってロックされます。
- ERROR - 処理中にエラーが発生しました。処理エラーを修正するために、編集のためにクライアントによってロックできます。
- PROCESSING - 取得は現在バッチを処理しています。バッチは、取得プロシージャで定義されたジョブのいずれかにあります。
status(optional): string

バッチに割り当てられた現在のステータス。

ステータス値はプロシージャで定義され、バッチ作成時および処理ジョブ間の遷移時に割り当てることができます。
updatedBy(optional): object updatedBy

バッチを更新した最後のユーザー。これはキャプチャ・システムです。
updatedDate(optional): string(date-time)

これにより、バッチの最終更新日時が識別されます。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、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"
        }
    }
}

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

型: object

バッチを作成したユーザー。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。これには、リソースへの少なくともcanonical関連リンクが含まれます。

Show Source

Array of: object HATEOAS Link
タイトル: HATEOAS Link
これは、HATEOASリンクおよび関連メタデータです。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Internet Assigned Numbers Authority (IANA)は、HATEOASリンクで使用するために「リンク関係」のレジストリを保持します。これらは有名な関係で、特定の意味を持つ。応募者がキャプチャでいる場合は、それらが使用されます。たとえば、canonicalは既知の関係で、Captureではそれを使用します。

どのような登録関係でも適切な意味が提供されていないため、キャプチャでは、特定のケースで独自のリンク関係が定義されます。 Webリンク(RFC 8288)のRFCで定義されているように、関係はURIである必要があります。次のリンク関係は、Captureによって定義されます:
- urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
- urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
- urn:oce:capture:attachment-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"
}

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

型: object

Show Source

lockedBy(optional): object lockedBy

取得クライアント・インスタンス内でbatchがlockedの場合、この属性にはバッチをlockedするユーザーが含まれます。
lockedDate(optional): string(date-time)

これは、バッチがいつロックされたかを識別します。「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。
step(optional): object step

取得が現在バッチを処理している場合、このオブジェクトには、バッチが進行中の現在の処理ステップが含まれます。
workstation(optional): string

取得クライアント・インスタンス内のbatchがlockedの場合、この属性には、キャプチャ・クライアント・インスタンスがバッチをlockedするコンピュータ名が含まれます。

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

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

型: object

このバッチに関連付けられた取得プロシージャ。

すべてに一致

Show Source

object 「プロシージャの取得」

タイトル: Capture Procedure

取得プロシージャでは、フローのメタデータおよび進捗ステップを定義します。

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

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

型: object

バッチを更新した最後のユーザー。これはキャプチャ・システムです。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

ネストされたスキーマ : ユーザー情報

型: object

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

Show Source

name: string

ユーザー名。

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

ネストされたスキーマ : HATEOASリンク

型: object

タイトル: HATEOAS Link

urn:oce:capture:document-content - 文書コンテンツの取得に使用されるリンクを表します
urn:oce:capture:document-complete - 「ステップ」タスク・キュー内のドキュメントの処理を完了するために使用されるリンクを表します
urn:oce:capture:attachment-content - 添付コンテンツの取得に使用されるリンクを表します

Show Source

href(optional): string

ターゲット・リソースのURI URI RFC 3986またはURIテンプレートRFC 6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

デフォルト値: application/json

RFC 2046で定義されたメディア・タイプで、リンク・ターゲットを記述します。プロパティが存在しない場合、application/jsonとみなすことができます。
method(optional): string
デフォルト値: GET
リンクのターゲットをリクエストするためのHTTPメソッド。

有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
プロパティが存在しない場合、GETとみなすことができます。
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。使用できない場合は、このプロパティは存在しません。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

デフォルト値: false

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

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

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

型: object

取得クライアント・インスタンス内でbatchがlockedの場合、この属性にはバッチをlockedするユーザーが含まれます。

すべてに一致

Show Source

object 「ユーザー情報」

タイトル: User Information

このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。

モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。これは、そのユーザーが最後に更新されたことを示します。

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

型: object

取得が現在バッチを処理している場合、このオブジェクトには、バッチが進行中の現在の処理ステップが含まれます。

すべてに一致

Show Source

object 「プロシージャ・ステップ」

タイトル: Procedure 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"
}

ネストされたスキーマ : プロシージャ・ステップ

型: object

タイトル: Procedure Step

プロシージャ・フロー内のステップ。

Show Source

id(optional): string

プロシージャ内のステップの一意の識別子。
name(optional): string

作成時にステップに指定された名前。たとえば、処理ジョブまたはコミット・プロファイルの名前。
type(optional): string

ステップのタイプ。次に例を示します: 外部プロセッサ, TIFF換算プロセッサ, アセット参照プロセッサ, 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"
        }
    }
}

ネストされたスキーマ : プロシージャの取得

型: object

タイトル: Capture Procedure

取得プロシージャでは、フローのメタデータおよび進捗ステップを定義します。

Show Source

id(optional): string

取得でのプロシージャの一意の識別子。
name(optional): string

作成時にプロシージャに指定された名前

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

ネストされたスキーマ : フィールド値

型: object

タイトル: Field Value

フィールド値は、基本フィールド定義と実際の値を組み合せた取得メタデータ・フィールドです。

Show Source

dataType(optional): string
デフォルト値: ALPHA_NUMERIC
フィールドのデータ型。 Captureでは、次の6つのデータ型がサポートされています:
- NUMERIC - 整数ベースの数値
- ALPHA_NUMERIC - 一般的なテキストまたは文字列値
- DATE - RFC 3339で管理される「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')の日付/時間値
- FLOAT - 浮動小数点数値
- ITEM_REFERENCE - Oracle Content Managementのコンテンツ・アイテムへの「人差し指」
- ASSET_REFERENCE - Oracle Content Managementのデジタル・アセットへの「人差し指」
- CATEGORY_REFERENCE - Oracle Content Managementのタクソノミ・カテゴリに対する「人差し指」
- LANGUAGE - RFC 4647で定義されている言語コード。
name(optional): string

フィールドの名前。
value(optional): string

指定されたキャプチャ・ドキュメントに関連する、このメタデータ・フィールドの実際の値。

フィールドには最初の値は含まれません。これらは設定する必要があります。これは、メタデータ・フィールド定義のデフォルト値、取得クライアントで指定されたユーザー、または取得処理ジョブによって実行されます。

取得のフィールドには、null値の概念がありません。フィールドに値があるか、値がありません。 「空白」は、値がないことを意味します。

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

ネストされたスキーマ : ドキュメント・プロファイル

型: object

タイトル: Document Profile

Show Source

id(optional): string

ドキュメント・プロファイルの一意識別子。
name(optional): string

文書プロファイルに指定された名前。

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

ネストされたスキーマ : エラーの詳細

型: object

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読可能な複数行の可能性があり、その問題を詳細に説明します。
instance(optional): string(URI)

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array Error Details

タイトル: Error Details
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title: string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type: string(URI)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなど、問題の人間が読めるサマリーを提供します。

{
    "type":"object",
    "title":"Error Detail",
    "description":"<p>This represents an error in the system, and is the response object returned.</p>\n",
    "properties":{
        "type":{
            "type":"string",
            "format":"URI",
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <b>should</b> provide a human-readable summary of the problem, for example, as a HTML page.</p>\n"
        },
        "title":{
            "type":"string",
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>\n"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Corresponding HTTP status code for the error.</p>\n"
        },
        "detail":{
            "type":"string",
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line, description the problem in more details.</p>\n"
        },
        "instance":{
            "type":"string",
            "format":"URI",
            "description":"<p>URI to the link that provides more detail about the error.</p>\n"
        },
        "o:errorCode":{
            "type":"string",
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>\n"
        },
        "o:errorPath":{
            "type":"string",
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>\n"
        },
        "o:errorDetails":{
            "type":"array",
            "title":"Error Details",
            "items":{
                "$ref":"#/definitions/ErrorDetail"
            }
        }
    },
    "required":[
        "type",
        "title"
    ]
}

ネストされたスキーマ : エラーの詳細

型: array

タイトル: Error Details

Show Source

Array of: object Error Detail

タイトル: Error Detail

これはシステムのエラーを表し、返されるレスポンス・オブジェクトです。

{
    "type":"array",
    "title":"Error Details",
    "items":{
        "$ref":"#/definitions/ErrorDetail"
    }
}

500レスポンス

内部サーバー・エラー

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

トップに戻る

例

例1:

次の例は、タスク・キュー内のドキュメント処理を完了する方法を示しています。

curl -X PUT -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete'

これは、属性値の設定時にドキュメント処理を完了する方法を示しています。この操作が正常に完了してもレスポンス本文はありません。

リクエスト本文

[
   {
     "taskNumber": 177,
     "document": {
                    "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
                     "fields": [
                            {
                              "name": "Invoice Date",
                              "dataType": "DATE",
                              "value": "2021-09-15"
                            }
                        ]
                    }
                }
            ]

例2:

これは、属性値の設定中に複数の文書処理を完了する方法を示しています。この操作が正常に完了してもレスポンス本文はありません。

curl -X PUT -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete'

リクエスト本文

[
     {
         "taskNumber": 177,
          "document": {
                    "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
                     "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": "2021-09-06"
                            }
                        ]
                    }
                },
                {
                    "taskNumber": 178,
                    "document": {
                        "stateToken": "d732c7864c45b405900d086dc54efd09",
                        "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": "2021-09-08"
                            }
                        ]
                    }
                }
            ]

例3:

これは、エラーとしてドキュメント処理を完了する方法を示しています。この操作が正常に完了してもレスポンス本文はありません。

curl -X PUT -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete'

リクエスト本文

[
     {
         "taskNumber": 177,
         "document": {
                   "stateToken": "340f804ff4118f2f419bc3ca87ef1213"
                    },
                    "error": {
                        "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
                        "title": "Bad Request",
                        "status": 400,
                        "detail": "The metadata field named 'Invoice Total' is not of the required 'FLOAT' data type."
                    }
                }
            ]

例4:

これは、誤った状態トークン値でドキュメントを完了しようとしています。

curl -X PUT -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete'

リクエスト本文

[
       {
          "taskNumber": 177,
           "document": {
                      "stateToken": "2f439d75eb148384a034732e8ec77f59",
                       "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": "2021-09-15"
                            }
                        ]
                    }
                }
            ]

レスポンス本文

[
      {
         "taskNumber": 177,
          "document": {
                    "stateToken": "2f439d75eb148384a034732e8ec77f59",
                     "fields": [
                            {
                                "name": "Invoice Date",
                                "dataType": "DATE",
                                "value": "2021-09-15"
                            }
                        ]
                    },
                    "error": {
                        "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13",
                        "title": "Precondition Failed",
                        "status": 412,
                        "detail": "The state tokens do not match [provided: 2f439d75eb148384a034732e8ec77f59, current: 340f804ff4118f2f419bc3ca87ef1213]"
                    }
                }
            ]

トップに戻る