機械翻訳について
  1. Content Capture用のREST API
  2. タスク
  3. 添付ファイル

添付の作成

post

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

この操作は、特定のドキュメントの添付を作成するために使用できます。

操作のリクエスト本文には、少なくともcontentパラメータが必要です。 添付を構成する属性は、content (添付のタイトルなど)から取得できます。 ただし、必要に応じて、attachmentパラメータを使用して属性を設定できます。 また、添付が特定の添付タイプの場合は、これが必要です。

attachmentパラメータは添付オブジェクトで、基本的に、構成および添付を構成するデフォルト属性を「パッチ」します。 設定する必要がある属性のみがオブジェクトに必要です。 設定できる属性は、次のとおりです:

  • title
  • type
  • comment

titleとcommentはどちらも単純な文字列です。 添付タイプ(type)を設定するには、添付タイプ・オブジェクトを指定する必要があります。 オブジェクトには、id属性またはname属性のいずれか、または両方が含まれている必要があります。 プロシージャ定義では名前が一意であるため、必要な属性は1つのみです。

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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
ヘッダー・パラメータ

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

フォーム・パラメータ

  • これは添付オブジェクトです。 mulitpartのContent-Typeを使用する必要があり、文字列値に使用されるアプリケーション・エンコーディングを識別する必要があります。 これはapplication/jsonである必要があります。

  • これは、処理の結果としてイメージなどの実際の添付コンテンツです。

    マルチパートのContent-Typeは、ファイルのタイプを識別する必要があります。 また、Content-Dispositionにはfilenameが含まれている必要があります。

トップに戻る

レスポンス

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

201レスポンス

新規添付

本文()
ルート・スキーマ: Attachment
型: object
タイトル: Attachment

Captureの「添付」は、「ドキュメント」の補助コンテンツを含むファイルです。 基本的に、その構造は「ドキュメント」の構造と非常に似ていますが、メタデータ・フィールドはありません。

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

この添付親文書を含む取得バッチ。

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

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

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

添付を作成したユーザー。

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

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

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

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

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

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

この添付に割り当てられている添付タイプ。

すべてに一致
Show Source
  • 「添付タイプ」
    タイトル: Attachment Type

    添付タイプを使用すると、文書の添付のプロセスを分類し、フィルタできます。

ネストされたスキーマ : 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
タイトル: Attachment Type

添付タイプを使用すると、文書の添付のプロセスを分類し、フィルタできます。

Show Source

400レスポンス

不正リクエスト

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

403レスポンス

禁止

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

404レスポンス

Not Found

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

409レスポンス

競合

このレスポンスは、リクエストがターゲット・リソースの現在の状態と競合することを示します。 レスポンスは「エラーの詳細」オブジェクトになります。

通常、これは、指定されたドキュメントが現在処理ステップにない場合に発生します。

500レスポンス

内部サーバー・エラー

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

トップに戻る

例

例1:

次の例は、添付を作成する方法を示しています。

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

これにより、IDが'dcf65d45-4f53-4f82-998c-5e189de1b6a1'のドキュメントに新しい添付が作成されます。 この操作のリクエスト本文は、multipart/form-dataのコンテンツ・タイプです。 この例では、RAW HTTP PUTを示しています。

リクエスト本文

PUT /capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1 HTTP/1.1
Host: server.example.com:443
X-Requested-With: XmlHttpRequest
Authorization: Basic c3N2cmludC5tdGFkbWluOndlbGNvbWUx
Content-Length: 4867
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="content"; filename="/C:/Invoices/notes/Invoice5Notes.txt"
Content-Type: text/plain

...

----WebKitFormBoundary7MA4YWxkTrZu0gW

レスポンス本文

{
    "id": "da259c38-1f44-4392-af75-e31ae0b5ab67",
    "documentId": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
    "title": "Invoice5Notes.txt",
    "batch": {
        "id": "864",
        "name": "ep_53"
    },
    "step": {
        "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
        "name": "Find Invoice Date",
        "type": "External Processor"
    },
    "stateToken": "53b2abf178702fd5e6f81dcfdb1a3b25",
    "mediaType": "text/plain",
    "sourceName": "Invoice5Notes.txt",
    "size": 4815,
    "createdBy": {
        "name": "ssvrint.mtadmin"
    },
    "createdDate": "2021-09-19T20:05:14.215Z",
    "updatedBy": {
        "name": "ssvrint.mtadmin"
    },
    "updatedDate": "2021-09-19T20:05:14.215Z",
    "links": [
        {
            "rel": "canonical",
            "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/da259c38-1f44-4392-af75-e31ae0b5ab67",
            "method": "GET",
            "mediaType": "application/json"
        },
        {
            "rel": "urn:oce:capture:attachment-content",
            "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/da259c38-1f44-4392-af75-e31ae0b5ab67/content",
            "method": "GET",
            "mediaType": "text/plain"
        }
    ]
}

例2:

次の例は、添付を作成する方法を示しています。

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

これにより、ドキュメントのIDが'dcf65d45-4f53-4f82-998c-5e189de1b6a1'の新しい添付が作成され、添付の titleおよびtypeが指定されます。 この操作のリクエスト本文は、multipart/form-dataのコンテンツ・タイプです。 この例では、RAW HTTP PUTを示しています。

リクエスト本文

PUT /capture/api/v1/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1 HTTP/1.1
Host: server.example.com:443
X-Requested-With: XmlHttpRequest
Authorization: Basic c3N2cmludC5tdGFkbWluOndlbGNvbWUx
Content-Length: 5148
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachment"
Content-Type: application/json

{
    "title": "Notes Title",
    "stateToken": "340f804ff4118f2f419bc3ca87ef1213",
    "type": {
        "id": "1d3340ca-3fcb-43f7-9304-89cfedb1ac69",
        "name": "Invoice Notes"
    }
}

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="content"; filename="/C:/Invoices/notes/Invoice5Notes.txt"
Content-Type: text/plain

...

----WebKitFormBoundary7MA4YWxkTrZu0gW

レスポンス本文

{
    "id": "27d68830-ee2d-4b75-9b75-e2feeeb11909",
    "documentId": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
    "title": "Notes Title",
    "batch": {
        "id": "864",
        "name": "ep_53"
    },
    "step": {
        "id": "a82321c2-f288-4545-8795-e3c0f035f7ba",
        "name": "Find Invoice Date",
        "type": "External Processor"
    },
    "type": {
        "id": "1d3340ca-3fcb-43f7-9304-89cfedb1ac69",
        "name": "Invoice Notes"
    },
    "stateToken": "23421e50c982fad3d8375737a1c46eee",
    "mediaType": "text/plain",
    "sourceName": "notes5.txt",
    "size": 4815,
    "createdBy": {
        "name": "ssvrint.mtadmin"
    },
    "createdDate": "2021-09-19T20:05:14.215Z",
    "updatedBy": {
        "name": "ssvrint.mtadmin"
    },
    "updatedDate": "2021-09-19T20:05:14.215Z",
    "links": [
        {
            "rel": "canonical",
            "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/27d68830-ee2d-4b75-9b75-e2feeeb11909",
            "method": "GET",
            "mediaType": "application/json"
        },
        {
            "rel": "urn:oce:capture:attachment-content",
            "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/27d68830-ee2d-4b75-9b75-e2feeeb11909/content",
            "method": "GET",
            "mediaType": "text/plain"
        }
    ]
}
トップに戻る