Content Capture用のREST API

すべてのバッチをリスト

get

/capture/api/v1.1/batches

この操作は、キャプチャでバッチのコレクションを返します。

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

この操作では、expandパラメータもサポートされ、子リソース/コレクションをインラインに含めるために使用されます。

documentsのコレクション・リソースは、拡張パラメータでサポートされ、batch.のすべてのドキュメントがインライン化されます

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

ノート: OAuthトークンが管理者の取得であるアカウントを表す場合、レスポンスには、プロシージャに関係なく、指定された問合せ引数に一致するすべてのバッチが含まれます。 OAuthトークンが「管理者の取得」であるアカウントを表していない場合(これは「キャプチャ・ユーザー」のみ)、レスポンスにはクライアント・プロファイルまたは、アカウントに明示的なアクセス権が付与されている「インポート・ジョブ」から開始されたバッチのみが含まれます。

リクエスト

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

application/json

問合せパラメータ

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

拡張パラメータに未定義の子リソースが含まれている場合、リクエスト操作ではエラーが発生します。使用可能な子リソース/コレクションは次のとおりです:
- documents
例 : ?expand=documents
このバッチのdocumentsのコレクション(ある場合)を展開します。
limit(optional): integer(int32)

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

デフォルト値: 50
offset(optional): integer(int32)

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

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

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

orderByでは、バッチのすべての属性がサポートされます。例外は次のとおりです:
- state
- notes
- error
- links
procedure.nameやlock.lockedDateなどのprocedureおよびlock子リソースの属性もサポートされています。ただし、属性lock.step.typeはサポートされていません。

例:
- ?orderBy=id
- ?orderBy=id;updatedDate:asc
- ?orderBy=name&orderBy=createdDate:desc
- ?orderBy=priority:desc
- ?orderBy=priority:desc;status:asc
q(optional): string
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式では、バッチのすべての単純な属性がサポートされます:
- notes
- error
procedure.idやlock.lockedDateなどのprocedureおよびlock子リソースの属性もサポートされています。また、linksなどの配列属性はサポートされず、documentsなどの子コレクションもサポートされません。

例:
- ?q=(id eq "636") or (id eq "637")
- ?q=(status eq "Assigned Total" and createdDate ge "2021-05-01")
- ?q=(priority gt 2)&q=(createdDate ge "2021-05-01")
- ?q=(lock.lockedDate ge "2021-05-26")
totalResults(optional): boolean

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

デフォルト値: false

トップに戻る

レスポンス

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

application/json

200レスポンス

すべてのバッチのリスト。

ルート・スキーマ : バッチ収集

型: object

タイトル: Batch Collection

これは、「バッチ」オブジェクトのコレクションを表します。

Show Source

count: integer(int32)

現在のレスポンスのレコードの合計数。
hasMore: boolean

取得するページがさらにあるかどうかを示すインジケータ。
items(optional): array items

「バッチ」オブジェクトの配列。

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

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

特異リソースが返される実際のインデックス。
totalResults(optional): integer(int32)

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

{
    "type":"object",
    "title":"Batch Collection",
    "description":"<p>This represents a collection of <i>Batch</i> objects.</p> \n",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of rows that satisfy the client request (excluding the paging parameters).</p>\n"
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The actual page size used by the server. This may not be the same as what client requests.</p>\n"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The total number of records in the current response.</p>\n"
        },
        "hasMore":{
            "type":"boolean",
            "description":"<p>An indicator of whether there are more pages to fetch.</p>\n"
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The actual index from which the singular resources are returned.</p>\n"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Batch"
            },
            "description":"<p>The array of <i>Batch</i> objects.</p>\n<p>This will in the order specified by <b>orderBy</b>, or the default sort order of descending by <code>updatedDate</code> if <b>orderBy</b> was not used.\n"
        }
    },
    "required":[
        "limit",
        "count",
        "hasMore",
        "offset"
    ]
}

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

型: array

「バッチ」オブジェクトの配列。

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

Show Source

Array of: object Capture Batch

タイトル: Capture Batch

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

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Batch"
    },
    "description":"<p>The array of <i>Batch</i> objects.</p>\n<p>This will in the order specified by <b>orderBy</b>, or the default sort order of descending by <code>updatedDate</code> if <b>orderBy</b> was not used.\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"
        }
    }
}

400レスポンス

不正リクエスト

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

500レスポンス

内部サーバー・エラー

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

トップに戻る