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

すべての文書添付のリスト

get

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

この操作では、docIdで指定されたドキュメントの添付(存在する場合)のコレクションが返されます。

qパラメータを使用して、このコレクションの結果をフィルタ処理できます。 orderByパラメータは、コレクションをソートするための手段を提供します。 totalResultsパラメータは、問合せに一致する結果の合計数を返します。 その他のパラメータlimitおよびoffsetは、結果のpagingに使用されます。

ドキュメントに添付がない場合、またはフィルタ条件に一致しない場合は、空のコレクションが返されます。

ノート: OAuthトークンが管理者の取得であるアカウントを表す場合、レスポンスには、プロシージャ、バッチまたはステップに関係なく、指定された問合せ引数に一致するすべての添付が含まれます。 OAuthトークンが「管理者の取得」であるアカウントを表していない場合、つまり単に「ユーザーの取得」である場合、アカウントの攻撃アクセス権が付与されているステップに現在含まれている場合、レスポンスにはドキュメントの添付が含まれます。

リクエスト

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

  • limitパラメータは、負でない整数を受け入れ、結果の添付コレクションのサイズを制御するために使用されます。

    デフォルト値: 50

  • offsetパラメータは、負でない整数を受け入れ、問合せのアタッチメント・コレクションの開始索引を制御するために使用されます。

    デフォルト値: 0

  • orderByパラメータは、添付コレクションの結果の順序(昇順/降順)を制御するために使用されます。 添付コレクションのデフォルトのソート順序はupdatedDateの降順であるため、このパラメータはオプションです。

    このパラメータは属性名を受け入れ、ユーザーが結果をソートするコロン(:)で区切ることができます(昇順/降順)。 ソート順が指定されていない場合は、昇順でソートされます。 ノート : ascは昇順、descは降順を表します。 複数のソート順をセミコロン(;)で区切ることができます。 たとえば、orderBy={attributeName1}:{asc/desc};{attributeName2}:{asc/desc}です。 また、複数のorderBy問合せパラメータが存在し、問合せ文字列パラメータ順序に適用されることもあります。

    添付のすべての属性は、orderByでサポートされますが、次の点が異なります:

    • stateToken
    • mediaType

    例:

    • ?orderBy=batch.id
    • ?orderBy=documentId;updatedDate:asc
    • ?orderBy=title&orderBy=createdDate:desc
    • ?orderBy=size:asc
    • ?orderBy=type.name;size:asc

  • qパラメータは、添付の属性値と一致する問合せ式条件を受け入れ、コレクションで結果をフィルタ処理するために使用されます。 パラメータの値は、{attribute name} {condition operator} {attribute value}という形式の単純な式にすることも、論理演算子でグループ化および結合する複数の式にすることもできます。

    次の条件演算子がサポートされています:

    • eq - 次と等しい
    • ne - 次と等しくない
    • lt - 次より小さい
    • gt - 次より大きい
    • le - 次以下
    • ge - 次以上

    文字列属性とともに使用できるのは条件演算子eqおよびneのみで、文字列属性は引用符で囲む必要があります(")。 同様に、ブール・データ型では、条件演算子eqおよびneのみを使用できます。 すべての条件演算子は、他の属性データ型とともに使用できます。

    日付/時間属性の値は、RFC 3339によって制御される「ISO-8601日時」形式の文字列として表される必要があります。 たとえば、"2021-04-12"または"2021-04-15T04:27:15-06:00"です。 値が文字列形式の場合でも、ltやgtなど、数値型の演算子がサポートされます。

    条件式は、andまたはorの論理演算子で結合できます。 また、カッコ()を使用してグループ化することもできます。 たとえば: (({expression})および({expression})。 これにより、より複雑なフィルタが生成されます。

    複数のq問合せパラメータがサポートされ、and論理演算子が示されます。

    次の例外を除いて、添付のすべての単純な属性がq式でサポートされます:

    • stateToken
    • mediaType

    batch.idやtype.nameなどの子リソース属性もサポートされています。

    例:

    • ?q=(step.id eq "06ed7cb1-6b1b-4828-b4ba-c8ab31a45903" and createdDate ge "2021-05-01")
    • ?q=(step.id eq "06ed7cb1-6b1b-4828-b4ba-c8ab31a45903")&q=(createdDate ge "2021-05-01")
    • ?q=(type.name eq "Example Attachment Type") and (size lt 50000)
    • ?q=(updatedDate ge "2021-05-26")
    • ?q=(batch.id eq "636") or (batch.id eq "637")

  • totalResultsパラメータはブール・フラグを受け入れます。 trueと指定した場合、返される結果には、問合せ内の添付の合計数が含まれます。

    デフォルト値: false
トップに戻る

レスポンス

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

200レスポンス

docIdで指定されたドキュメントのすべての添付のリスト。

本文()
ルート・スキーマ : 添付コレクション
型: object
タイトル: Attachment Collection

これは、「添付」オブジェクトの集合を表します。

Show Source

  • 現在のレスポンスのレコードの合計数。

  • 取得するページがさらにあるかどうかを示すインジケータ。

  • items

    「添付」オブジェクトの配列。

    これは、orderByで指定された順序、またはorderByが使用されていない場合はupdatedDateで降順にソートされます。

  • サーバーで使用される実際のページ・サイズ。 これは、クライアント・リクエストと同じでない場合があります。

  • 特異リソースが返される実際のインデックス。

  • クライアント・リクエストを満たす行の合計数(ページング・パラメータを除く)。

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

「添付」オブジェクトの配列。

これは、orderByで指定された順序、またはorderByが使用されていない場合はupdatedDateで降順にソートされます。

Show Source
  • Attachment
    タイトル: Attachment

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

ネストされたスキーマ : 添付ファイル
型: 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レスポンス

不正リクエスト

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

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/attachments'

これは、IDが'dcf65d45-4f53-4f82-998c-5e189de1b6a1'のドキュメントのすべての添付のリストを取得し、ドキュメントに添付がありません。

レスポンス本文

{
   "limit": 0,
   "count": 0,
   "hasMore": false,
   "offset": 0,
   "items": []
 }

例2:

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

これは、IDが'dcf65d45-4f53-4f82-998c-5e189de1b6a1'のドキュメントのすべての添付のリストを取得し、ドキュメントに添付があります。

レスポンス本文

{
   "limit": 1,
   "count": 1,
   "hasMore": false,
   "offset": 0,
   "items": [
               {
                 "id": "b22046ce-2c30-49b3-b734-25f62dea5403",
                 "documentId": "dcf65d45-4f53-4f82-998c-5e189de1b6a1",
                 "title": "InvoiceNote1.txt",
                 "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": "62a90ec2b7aa4915c04fd271dfb72a1",
                 "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/b22046ce-2c30-49b3-b734-25f62dea5403",
                             "method": "GET",
                             "mediaType": "application/json"
                            },
                            {
                              "rel": "urn:oce:capture:attachment-content",
                              "href": "http://server.example.com/documents/dcf65d45-4f53-4f82-998c-5e189de1b6a1/attachments/b22046ce-2c30-49b3-b734-25f62dea5403/content",
                              "method": "GET",
                              "mediaType": "text/plain"
                            }
                        ]
                    }
                ]
            }
        }
トップに戻る