ルート・スキーマ : バッチ監査詳細収集
型: object
タイトル: Batch Audit Detail Collection
これは、「バッチ監査詳細」オブジェクトのコレクションを表します。
{
"type":"object",
"title":"Batch Audit Detail Collection",
"description":"<p>This represents a collection of <i>Batch Audit Detail</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/BatchAuditDetail"
},
"description":"<p>The array of <i>Batch Audit Detail</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で降順にソートされます。
- Array of: object Batch Audit Detail
タイトル: Batch Audit Detail
取得の「バッチ監査詳細」は、特定のバッチに対して発生した一連のイベントです。 これらは、バッチの作成、バッチの処理、バッチの削除などのイベントです。
「バッチ監査詳細」には、関連する「文書監査詳細」オブジェクトも含まれており、このオブジェクトは、特定のバッチのドキュメントに対するイベントを表します。
{
"type":"array",
"items":{
"$ref":"#/definitions/BatchAuditDetail"
},
"description":"<p>The array of <i>Batch Audit Detail</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
タイトル: Batch Audit Detail
取得の「バッチ監査詳細」は、特定のバッチに対して発生した一連のイベントです。 これらは、バッチの作成、バッチの処理、バッチの削除などのイベントです。
「バッチ監査詳細」には、関連する「文書監査詳細」オブジェクトも含まれており、このオブジェクトは、特定のバッチのドキュメントに対するイベントを表します。
{
"type":"object",
"title":"Batch Audit Detail",
"description":"<p>A <i>Batch Audit Detail</i> in Capture is a set of events that occurred for a given batch. These are events such as the batch was\ncreated, the batching is being processed, the batch was deleted, etc.</p>\n\n<p>A <i>Batch Audit Detail</i> also encompasses associated <i>Document Audit Detail</i> objects, which represents events for documents\nthe a given batch.</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"
},
"runtime":{
"type":"object",
"description":"<p>If the batch is presently part of the Capture system, this object will contain its current runtime information. However, if the batch has\nbeen committed, or has otherwise been deleted from the Capture system, there will be no runtime information.</p>\n",
"properties":{
"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"
},
"procedure":{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/Procedure"
}
],
"description":"<p>If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.</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"
}
}
},
"events":{
"type":"array",
"items":{
"$ref":"#/definitions/AuditEvent"
},
"description":"<p>This array contains all individual events that pertain to this batch, in <code>eventDate</code> ascending order.</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"
},
"lastEventDate":{
"type":"string",
"format":"date-time",
"description":"<p>This identifies the date/time of the last event that occurred in this batch. 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"
}
}
}
ネストされたスキーマ : events
型: array
この配列には、このバッチに関連するすべての個別イベントがeventDateの昇順で格納されます。
{
"type":"array",
"items":{
"$ref":"#/definitions/AuditEvent"
},
"description":"<p>This array contains all individual events that pertain to this batch, in <code>eventDate</code> ascending order.</p>\n"
}
ネストされたスキーマ: links
型: array
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 これには、リソースへの少なくともcanonical関連リンクが含まれます。
- 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"
}
ネストされたスキーマ: runtime
型: object
バッチが現在キャプチャ・システムの一部である場合、このオブジェクトには現在のランタイム情報が含まれます。 ただし、バッチがコミットされている場合、または取得システムから削除されている場合は、ランタイム情報はありません。
{
"type":"object",
"description":"<p>If the batch is presently part of the Capture system, this object will contain its current runtime information. However, if the batch has\nbeen committed, or has otherwise been deleted from the Capture system, there will be no runtime information.</p>\n",
"properties":{
"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"
},
"procedure":{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/Procedure"
}
],
"description":"<p>If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.</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"
}
}
}
ネストされたスキーマ : 監査イベント
型: object
タイトル: Audit Event
これは、トラッキングされたキャプチャ内で発生した特定のアクションを表します。
{
"type":"object",
"title":"Audit Event",
"description":"<p>This represents a given action that occurred within Capture that has been tracked.</p>\n",
"properties":{
"correlationId":{
"type":"string",
"description":"<p>A correlation identifier of the event. It is important to note that this value <b>is not</b> unique.</p>\n<p>An event may cause other events to occur. This identifier is used express a causal relationships between events,\nparticulally between batches and documents.</p>\n"
},
"type":{
"type":"number",
"format":"int32",
"description":"<p>The unique identifer of the kind of event.</p>\n"
},
"action":{
"type":"string",
"description":"<p>A simple description of the event, generally a <i>verb</i>, such as <code>CREATED</code>, <code>UPDATED</code>, <code>PROCESSED</code>, etc.</p>\n"
},
"message":{
"type":"string",
"description":"<p>The simple message the describes the event.</p>\n"
},
"detail":{
"type":"string",
"description":"<p>Detail information about the the event.</p>\n"
},
"locale":{
"type":"string",
"description":"<p>The <em>locale</em> that was used to produce the <code>message</code>. The value will be in the form of standard language tags as defined\nby <a href=\"https://datatracker.ietf.org/doc/html/rfc4647\">RFC 4647</a>.</p>\n"
},
"messageKey":{
"type":"string",
"description":"<p>The unique key that correlates to the message pattern used to generate the detail <code>message</code>.</p>\n"
},
"messageProperties":{
"type":"array",
"items":{
"$ref":"#/definitions/AnyObject"
},
"description":"<p>An array of individual property keys and values that are attributes of the event, and used to produce the message. The order of the array\nis determined by the order of the argument indexes in the message pattern.</p>\n<p>The specific keys and values are dependent on the <code>type</code> of event. Also, the event type could allow for more complex object\ndefinition than just simple key/value pairs. Some examples are:</p>\n<p>Document Committed Events</p>\n<pre>\n[\n { \"documentId\": \"58be0662-a758-491a-9eed-cc6f56124acf\" },\n { \"documentTitle\": \"Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]\" },\n { \"repositoryName\": \"Plumbing Invoice Type\" },\n { \"assetType\": \"Plumbing Invoice Type\" }\n]\n</pre>\n<p>Email Events</p>\n<pre>\n[\n { \"emailFromName\": \"Joe Smith\" },\n { \"emailFromAddress\": \"joe.smith@someplace.com\" },\n { \"emailSubject\": \"Sales Invoice\" }\n]\n</pre>\n"
},
"eventBy":{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/User"
}
],
"description":"<p>The user that trigged/caused the event.</p>\n<p>This is only present if the event was triggered by a user of Capture. It is not present when events are triggered by Capture.</p>\n"
},
"eventDate":{
"type":"string",
"format":"date-time",
"description":"<p>This identifies when the event occurred. 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"
}
}
}
ネストされたスキーマ : eventBy
型: object
イベントをトリグ/一時停止したユーザー。
これは、イベントが取得のユーザーによってトリガーされた場合にのみ存在します。 イベントがキャプチャによってトリガーされる場合には表示されません。
すべてに一致
Show Source
- object 「ユーザー情報」
タイトル: User Information
このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。
モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。 たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。 これは、そのユーザーが最後に更新されたことを示します。
{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/User"
}
],
"description":"<p>The user that trigged/caused the event.</p>\n<p>This is only present if the event was triggered by a user of Capture. It is not present when events are triggered by Capture.</p>\n"
}
ネストされたスキーマ : messageProperties
型: array
イベントの属性であり、メッセージの生成に使用される個々のプロパティ・キーと値の配列。 配列の順序は、メッセージ・パターンの引数索引の順序によって決まります。
特定のキーおよび値は、イベントのtypeに依存します。 また、イベント・タイプでは、単純なキー/バリューのペアのみより複雑なオブジェクト定義が可能です。 次に例を示します。
コミット済イベントのドキュメント
[
{ "documentId": "58be0662-a758-491a-9eed-cc6f56124acf" },
{ "documentTitle": "Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]" },
{ "repositoryName": "Plumbing Invoice Type" },
{ "assetType": "Plumbing Invoice Type" }
]
電子メール・イベント
[
{ "emailFromName": "Joe Smith" },
{ "emailFromAddress": "joe.smith@someplace.com" },
{ "emailSubject": "Sales Invoice" }
]
- Array of: object Any Object
タイトル: Any Object
これは任意の種類のオブジェクトを表します。 オブジェクトに定義されたスキーマがある場合とない場合があります。
これは、Content Capture REST APIの一部で使用され、異なる可能性があるか、設計時に認識されません。
{
"type":"array",
"items":{
"$ref":"#/definitions/AnyObject"
},
"description":"<p>An array of individual property keys and values that are attributes of the event, and used to produce the message. The order of the array\nis determined by the order of the argument indexes in the message pattern.</p>\n<p>The specific keys and values are dependent on the <code>type</code> of event. Also, the event type could allow for more complex object\ndefinition than just simple key/value pairs. Some examples are:</p>\n<p>Document Committed Events</p>\n<pre>\n[\n { \"documentId\": \"58be0662-a758-491a-9eed-cc6f56124acf\" },\n { \"documentTitle\": \"Sales Invoice [58be0662-a758-491a-9eed-cc6f56124acf]\" },\n { \"repositoryName\": \"Plumbing Invoice Type\" },\n { \"assetType\": \"Plumbing Invoice Type\" }\n]\n</pre>\n<p>Email Events</p>\n<pre>\n[\n { \"emailFromName\": \"Joe Smith\" },\n { \"emailFromAddress\": \"joe.smith@someplace.com\" },\n { \"emailSubject\": \"Sales Invoice\" }\n]\n</pre>\n"
}
ネストされたスキーマ : ユーザー情報
型: object
タイトル: User Information
このオブジェクトには、取得の指定ユーザーに関する情報が含まれます。
モデルは、このオブジェクトを使用して、ユーザーと他のオブジェクトの関係を示します。 たとえば、APIのモデルでは、ユーザー・オブジェクトである属性updatedByを定義できます。 これは、そのユーザーが最後に更新されたことを示します。
{
"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"
]
}
ネストされたスキーマ : 任意オブジェクト
型: object
タイトル: Any Object
これは任意の種類のオブジェクトを表します。 オブジェクトに定義されたスキーマがある場合とない場合があります。
これは、Content Capture REST APIの一部で使用され、異なる可能性があるか、設計時に認識されません。
ネストされたスキーマ : 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 - 添付コンテンツの取得に使用されるリンクを表します
{
"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"
}
}
}
ネストされたスキーマ : 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"
}
ネストされたスキーマ : lock
型: object
batchがlockedの場合(ユーザーがバッチを作成/編集する場合、またはキャプチャが現在バッチを処理している場合)、このオブジェクトにはロックに関する情報が含まれます。 バッチのstateは、このオブジェクトが存在するかどうかを決定します。
{
"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"
},
"procedure":{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/Procedure"
}
],
"description":"<p>If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.</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"
}
}
}
ネストされたスキーマ : 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"
}
ネストされたスキーマ : 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"
}
ネストされたスキーマ : procedure
型: object
取得が現在バッチを処理している場合、このオブジェクトにはバッチ処理を制御するプロシージャが含まれます。
すべてに一致
Show Source
{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/Procedure"
}
],
"description":"<p>If Capture is currently processing the batch, this object will contain the procedure that is controlling the batch processing.</p>\n"
}
ネストされたスキーマ : step
型: object
取得が現在バッチを処理している場合、このオブジェクトには、バッチが進行中の現在の処理ステップが含まれます。
すべてに一致
Show Source
{
"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
タイトル: Capture Procedure
取得プロシージャでは、フローのメタデータおよび進捗ステップを定義します。
{
"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
タイトル: Procedure Step
Show Source
{
"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"
}
}
}