機械翻訳について
  1. Content Capture用のREST API
  2. タスク
  3. ドキュメント

ドキュメントの取得

get

/capture/api/v1.1/documents/{docId}

この操作では、docIdパラメータで指定されたドキュメントが返されます。

この操作は、インラインの子リソース/コレクションを含むexpandパラメータをサポートします。 batchの子リソースがサポートされています。 そのリソースが展開されていない場合は、idおよびnameのサマリー情報のみが含まれます。 attachmentsのコレクション・リソースも拡張パラメータでサポートされ、ドキュメントのすべての添付をインライン化します。

ノート: OAuthトークンが管理者の取得であるアカウントを表す場合、レスポンスは指定されたドキュメント(存在する場合)を返します。 OAuthトークンが「管理者の取得」であるアカウントを表していない場合(つまり、これは単なる「ユーザーの取得」の場合)、レスポンスは、ドキュメントが存在し、そのドキュメントが現在、アカウントが攻撃アクセス権を付与されているステップにある場合にのみ、そのドキュメントを返します。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ

  • expandパラメータは、レスポンスとともに子リソース/コレクションをインラインで取得するオプションを提供します。 属性名のカンマ区切りリストまたはallを受け入れます。 展開がall (小文字でall)として指定されている場合、リクエストされたドキュメントのすべての子リソース/コレクションが展開されます。

    拡張パラメータに未定義の子リソースが含まれている場合、リクエスト操作ではエラーが発生します。 使用可能な子リソース/コレクションは次のとおりです:

    • batch
    • attachments

    例 : ?expand=batch
    このドキュメントのbatch子リソースを展開します。

    例 : ?expand=attachments
    このドキュメントのattachmentsのコレクション(ある場合)を展開します。

トップに戻る

レスポンス

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

200レスポンス

docIdで指定されたドキュメント。

本文()
ルート・スキーマ : ドキュメント
型: object
タイトル: Document

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

Show Source
ネストされたスキーマ : batch
型: object

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

すべてに一致
Show Source
  • 「バッチの取得」
    タイトル: Capture Batch

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

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

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

すべてに一致
Show Source
  • 「ユーザー情報」
    タイトル: User Information

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

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

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

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

Show Source
  • Field Value
    タイトル: Field Value

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

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

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

すべてに一致
Show Source
  • 「ドキュメント・プロファイル」
    タイトル: Document Profile

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

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

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

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

すべてに一致
Show Source
ネストされたスキーマ : updatedBy
型: object

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

すべてに一致
Show Source
  • 「ユーザー情報」
    タイトル: User Information

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

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

ネストされたスキーマ : バッチの取得
型: object
タイトル: Capture Batch

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

Show Source
  • createdBy

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

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

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

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

  • バッチの一意識別子。

  • links
  • lock

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

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

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

  • バッチに関連付けられたユーザー指定の一般ノート。

  • 最小値: 0
    最大値: 10
    デフォルト値: 0

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

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

  • procedure

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

  • デフォルト値: READY

    バッチの現在の状態。

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

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

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

  • updatedBy

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

  • これにより、バッチの最終更新日時が識別されます。 「ISO-8601日時」形式(yyyy-MM-dd'T'HH:mm:ss.SSSZ) UTCの日付/時間は、RFC 3339によって管理されます。

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

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

すべてに一致
Show Source
  • 「ユーザー情報」
    タイトル: User Information

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

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

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

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

Show Source
  • lockedBy

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

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

  • step

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

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

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

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

すべてに一致
Show Source
ネストされたスキーマ : updatedBy
型: object

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

すべてに一致
Show Source
  • 「ユーザー情報」
    タイトル: User Information

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

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

ネストされたスキーマ : ユーザー情報
型: object
タイトル: User Information

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

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

Show Source
ネストされたスキーマ : lockedBy
型: object

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

すべてに一致
Show Source
  • 「ユーザー情報」
    タイトル: User Information

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

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

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

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

すべてに一致
Show Source
ネストされたスキーマ : プロシージャ・ステップ
型: object
タイトル: Procedure Step

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

Show Source

  • プロシージャ内のステップの一意の識別子。

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

  • ステップのタイプ。 次に例を示します: 外部プロセッサ, TIFF換算プロセッサ, アセット参照プロセッサ, etc.

ネストされたスキーマ : プロシージャの取得
型: object
タイトル: Capture Procedure

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

Show Source
ネストされたスキーマ : フィールド値
型: object
タイトル: Field Value

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

Show Source
  • デフォルト値: 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で定義されている言語コード。

  • フィールドの名前。

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

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

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

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

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

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

Show Source

400レスポンス

不正リクエスト

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

404レスポンス

Not Found

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

500レスポンス

内部サーバー・エラー

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

トップに戻る

例

例1:

次の例は、ドキュメントを取得する方法を示しています。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1'

これはIDの文書を取得: dcf65d45-4f53-4f82-998c-5e189de1b6a1。

レスポンス本文

{
    "id": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
    "title": "Invoice20210810124042797000.tiff",
              "batch": {
                    "id": "864",
                    "name": "ep_53"
                },
                "step": {
                    "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                    "name": "Find Invoice Date",
                    "type": "External Processor"
                },
                "profile": {
                    "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                    "name": "Invoice Profile"
                },
                "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
                "mediaType": "image/tiff",
                "sourceName": "Invoice20210810124042797000.TIF",
                "size": 32709,
                "fields": [
                    {
                        "name": "Invoice Date",
                        "dataType": "DATE",
                        "value": ""
                    },
                    {
                        "name": "Invoice Number",
                        "dataType": "NUMERIC",
                        "value": ""
                    },
                    {
                        "name": "Company Name",
                        "dataType": "ALPHA_NUMERIC",
                        "value": ""
                    },
                    {
                        "name": "Invoice Total",
                        "dataType": "FLOAT",
                        "value": ""
                    }
                ],
                "createdBy": {
                    "name": "ssvrint.mtadmin"
                },
                "createdDate": "2021-08-18T05:01:37.181Z",
                "updatedBy": {
                    "name": "ssvrint.mtadmin"
                },
                "updatedDate": "2021-08-18T05:01:48.916Z",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1",
                        "method": "GET",
                        "mediaType": "application/json"
                    },
                    {
                        "rel": "urn:oce:capture:document-content",
                        "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/content",
                        "method": "GET",
                        "mediaType": "image/tiff"
                    },
                    {
                        "rel": "urn:oce:capture:document-complete",
                        "href": "http://server.example.com/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete",
                        "method": "PUT",
                        "mediaType": "image/tiff"
                    }
                ]
              }

例2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1?expand=attachments'

これはIDの文書を取得: dcf65d45-4f53-4f82-998c-5e189de1b6a1、ドキュメントの添付を展開します。

レスポンス本文

{
        "id": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
        "title": "Invoice20210810124042797000.tiff",
              "batch": {
                    "id": "864",
                    "name": "ep_53"
                },
                "step": {
                    "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
                    "name": "Find Invoice Date",
                    "type": "External Processor"
                },
                "profile": {
                    "id": "4933f335-0861-4e6a-84ca-86ccae6b7ed8",
                    "name": "Invoice Profile"
                },
                "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
                "mediaType": "image/tiff",
                "sourceName": "Invoice20210810124042797000.TIF",
                "size": 32709,
                "attachments": [
                    {
                        "id": "cef7aea9-d867-41bd-9c11-2e4fc86d0d90",
                        "documentId": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
                        "title": "InvoiceNote1.txt",
                        "batch": {
                            "id": "864",
                            "name": "ep_53"
                        },
                        "type": {
                            "id": "1d3340ca-3fcb-43f7-9304-89cfedb1ac69",
                            "name": "Invoice Notes"
                        },
                        "stateToken": "627ceceb37e4d5e5b94f0d31aaef0616",
                        "mediaType": "text/plain",
                        "sourceName": "notes.txt",
                        "size": 4875,
                        "createdBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "createdDate": "2021-01-19T20:05:14.215Z",
                        "updatedBy": {
                            "name": "ssvrint.mtadmin"
                        },
                        "updatedDate": "2021-01-19T20:05:14.215Z",
                        "links": [
                            {
                                "rel": "canonical",
                                "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/cef7aea9-d867-41bd-9c11-2e4fc86d0d90",
                                "method": "GET",
                                "mediaType": "application/json"
                            },
                            {
                                "rel": "urn:oce:capture:attachment-content",
                                "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/cef7aea9-d867-41bd-9c11-2e4fc86d0d90/content",
                                "method": "GET",
                                "mediaType": "text/plain"
                            }
                        ]
                    }
                ],
                "fields": [
                    {
                        "name": "Invoice Date",
                        "dataType": "DATE",
                        "value": ""
                    },
                    {
                        "name": "Invoice Number",
                        "dataType": "NUMERIC",
                        "value": ""
                    },
                    {
                        "name": "Company Name",
                        "dataType": "ALPHA_NUMERIC",
                        "value": ""
                    },
                    {
                        "name": "Invoice Total",
                        "dataType": "FLOAT",
                        "value": ""
                    }
                ],
                "createdBy": {
                    "name": "ssvrint.mtadmin"
                },
                "createdDate": "2021-08-18T05:01:37.181Z",
                "updatedBy": {
                    "name": "ssvrint.mtadmin"
                },
                "updatedDate": "2021-08-18T05:01:48.916Z",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1",
                        "method": "GET",
                        "mediaType": "application/json"
                    },
                    {
                        "rel": "urn:oce:capture:document-content",
                        "href": "http://server.example.com/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/content",
                        "method": "GET",
                        "mediaType": "image/tiff"
                    },
                    {
                        "rel": "urn:oce:capture:document-complete",
                        "href": "http://server.example.com/capture/api/v1/steps/a82321c2-f288-4545-8795-e3c0f035f7ba/tasks/documents/complete",
                        "method": "PUT",
                        "mediaType": "image/tiff"
                    }
                 }

例3:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1?expand=batch'

これは、サポートされていない子属性を展開しようとするとエラー・レスポンスを示しています。 attachments子属性のみがサポートされています。 これにより、batch子属性の拡張が試行されます。

レスポンス本文

{
     "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
     "title": "Bad Request",
     "status": 400,
     "detail": "The attribute 'batch' is not a valid expansion attribute."
  }

例4:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/documents/5f2be40c-588d-49ac-8d82-c98338d47834'

これは、存在しないドキュメントを取得しようとした際のエラー・レスポンスを示しています。

レスポンス本文

{
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title": "Not Found",
    "status": 404,
    "detail": "The document with ID '5f2be40c-588d-49ac-8d82-c98338d47834' does not exist."
  }
トップに戻る