Content Capture用のREST API

リクエストの送信

Content CaptureのREST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。

URLの構造

次のURL構造を使用して、Content Capture RESTリソースにアクセスします:

https://subdomain.domain.com[:port]/capture/api/version/resourcePath

説明:

subdomain.domain.com[:port] - Oracle Content Managementが実行されているホストおよびポート。
version - REST APIのバージョン。例: v1。
resource-path - リソースを定義する相対パス。リソースの完全なリストについては、「目次」の下のすべてのRest Endpointsを参照してください。

サポートされるメソッド

次の表に示すように、標準HTTPメソッド・リクエストを使用して、基本的なCRUD操作(作成、読取り、更新および削除)を実行できます:

HTTPメソッド	説明
`GET`	ドキュメントまたは添付に関する情報を取得するか、コンテンツをダウンロードします。
`POST`	ドキュメントへの添付を作成します。
`PUT`	ドキュメントまたは添付を更新または編集します。
`DELETE`	ドキュメントまたは添付を削除します。

メディア・タイプ

メディア・タイプapplication/jsonは、Content CaptureのREST APIでサポートされています。

リクエストでは、メディア・タイプapplication/jsonを使用する必要があります。ドキュメントを更新する簡単な例を次に示します。

Request:

PUT.../documents/42b81066-2c66-472a-b655-67cf99dc784a

リクエスト本文:

{       "title": "A New Document Title",
        "profile": { "name": "A Different Profile" },  
        "stateToken": "d15e87f9db5c63a350f8a5307770f942"
}

JSONレスポンス:

{
    "id": "42b81066-2c66-472a-b655-67cf99dc784a",
    "title": "Invoice1.tiff",
    "batch": {
            "id": "2",
            "name": "inv_253"
  },
  "step": {
          "id": "06ed7cb1-6b1b-4828-b4ba-c8ab31a45903",
          "name": "Merging TIFF Files",
          "type": "TIFF Conversion Processor"
  },
  "profile": {
             "id": "0a8a547f-a382-4935-819d-c1864afef9b4",
             "name": "A Different Profile"
  },
  "stateToken": "7fca978ada4788b88b82d3acc463108c",
  "mediaType": "image/tiff",
  "sourceName": "Invoice1.tiff",
  "size": 305418,
  "fields": [{
            "name": "Company Code",
            "dataType": "ALPHA_NUMERIC",
            "value": ""
  },
{
          "name": "Total Tax",
          "dataType": "FLOAT",
          "value": ""
  },
{
          "name": "Company Code",
          "dataType": "FLOAT",
          "value": ""
  }],
  "createdBy": {
               name: "ssvrint.mtadmin"
  },
  "createdDate": "2021-01-19T20:05:14.126Z",
  "updatedBy": {
               name: "ssvrint.mtadmin"
  },
  "updatedDate": "2021-01-19T20:05:14.126Z",
  "links": [{
            "rel": "canonical",
            "href": "http://server.example.com/documents/42b81066-2c66-472a-b655-67cf99dc784a",
            "method": "GET",
            "mediaType": "application/json"
  },
{
            "rel": "urn:oce:capture:document-content",
            "href": "http://server.example.com/documents/42b81066-2c66-472a-b655-67cf99dc784a/content",
            "method": "GET",
            "mediaType": "image/tiff"
  }]
}

共通リクエスト・ヘッダー

次の表に、一般的なリクエスト・ヘッダーをいくつか示します。

ヘッダー	説明	例
Accept	レスポンス本文に適したメディア・タイプ。	`application/json`
Authorization	ユーザーを認証する方法。「認可」を参照してください。	`Authorization: Basic abcvZTphYmMxMjM=` `Authorization: Bearer eyJhbGciOiJ...9yoQ`
Content-Length	リクエスト本文のサイズ(バイト単位)。	`540`
Content-Type	リクエスト本文のメディア・タイプ。このヘッダーは`POST`および`PUT`リクエストには必須です。操作でそれ以外が指定されている場合を除き、リクエスト本文のメディア・タイプは`application/json`です。	`application/json`
Accept-Language	返されるエラー・メッセージに使用される言語を設定します。これによって有効なレスポンスのテキストの言語が変更されることはありません。	`fr`