機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. サイト
  4. ジョブ

サイト関連ジョブの進捗の取得

get

/sites/management/api/v1/sites/_status/{id}

SINGULAR

サイト関連ジョブのジョブ・ステータスを取得します。 サイト作成(リクエストとして処理されない)、サイト公開、翻訳ジョブの作成、翻訳のインポートなど、長時間実行されるサイト関連バックグラウンド・ジョブの進行状況は、このリソースを使用してモニターできます。

サイトで非同期操作を実行するリクエストは、サイト・ジョブ・ステータス・リソースを指すLocationヘッダーで応答します。

リリース19.2.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - Get the Status of a Running Create or Copy Job

進行状況パーセンテージを示す、処理中のサイト・ジョブのジョブ・ステータス。 レスポンスにリンクは含まれません。 サイトの作成とコピーの両方に対するジョブのaction値はcopyと同じです。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}?links=none

レスポンス本文

{
  "context": "F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
  "action": "copy",
  "startTime": "2019-05-31T09:14:29.000Z",
  "progress": "processing",
  "completed": false,
  "completedPercentage": 38,
  "intervalToPoll": 5000
}

200 OK - 失敗した作成またはコピー・ジョブのステータスの取得

失敗したサイト・ジョブのジョブ・ステータス。処理中に発生したエラーを示します。 レスポンスにリンクは含まれません。 サイトの作成とコピーの両方に対するジョブのaction値はcopyと同じです。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}?links=none

レスポンス本文

{
  "context": "F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
  "action": "copy",
  "startTime": "2019-05-31T09:14:25.000Z",
  "progress": "failed",
  "completed": false,
  "error": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title": "Site Already Exists",
    "status": 409,
    "detail": "Site with name 'AcmeProductLaunch' already exists.",
    "o:errorCode": "OCE-SITEMGMT-009004",
    "o:errorDetails": [
    ]
  }
}

200 OK - サイト翻訳の作成ジョブのステータスの取得

サイト翻訳ジョブを作成するためのジョブ・ステータス。 レスポンスにdownloadリンクを含めます。 これには、ジョブが完了した場合に翻訳zipファイルをダウンロードするためのリンクが含まれます。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}?links=download

レスポンス本文

{
  "action": "translate",
  "context": "671C087F29FD18701ABB0F48A252F2101578927448365",
  "startTime": "2020-01-13T14:57:28.000Z",
  "endTime": "2020-01-13T14:57:45.000Z",
  "progress": "succeeded",
  "completed": true,
  "completedPercentage": 100,
  "translationFile": {
    "links": [
        {
          "rel": "download",
          "href": "http://acmecorp.com/documents/api/1.2/files/D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015/data",
          "templated": false,
          "mediaType": "application/json",
          "method": "GET"
        }
    ],
    "id": "D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015",
    "name": "AcmeProductLaunch.zip",
    "type": "file",
    "version": "1",
    "size": "12646",
    "parentID": "TRANSLATIONJOBSF29E5445DC86366110B7BA737771948CD1C2E31858AE",
    "createdTime": "2020-01-13T14:57:44Z",
    "createdBy": {
      "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
      "displayName": "cecsadmina",
      "loginName": "swebcli.cecsadmina",
      "type": "user"
    },
    "modifiedTime": "2020-01-13T14:57:44Z",
    "modifiedBy": {
      "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
      "displayName": "cecsadmina",
      "loginName": "swebcli.cecsadmina",
      "type": "user"
    },
    "ownedBy": {
      "id": "docadmin",
      "displayName": "Oracle Documents Administrator",
      "loginName": "docadmin",
      "type": "user"
    }
  },
  "translationJob": {
    "id": "5F20EFDFCA31942378734091C014282C",
    "name": "AcmeProductLaunch",
    "type": "sites",
    "createdBy": "swebcli.cecsadmina",
    "createdDate": {
      "value": "2020-01-13T14:57:36.122Z",
      "timezone": "UTC"
    },
    "updatedBy": "swebcli.cecsadmina",
    "updatedDate": {
      "value": "2020-01-13T14:57:44.835Z",
      "timezone": "UTC"
    },
    "status": "READY",
    "fFolderGUID": "TRANSLATIONJOBSF29E5445DC86366110B7BA737771948CD1C2E31858AE",
    "fFileGUID": "D7954F8FE0DC1AFC8B68E594A9BCC17EC9210ED29015",
    "repositoryId": "F5D91F0689F54D6DBCD5B0F7814710A1",
    "assetPendingLanguages": [
        "fr",
        "de"
    ],
    "sitePendingLanguages": [
        "fr",
        "de"
    ],
    "siteGUID": "FBEF7E4A45AEE0E80BA511A3FFE257659D7CA3DF80FE",
    "siteId": "site-enterprise-auto-ownedby-admin",
    "roleName": "manager",
    "data": "jobName=AcmeProductLaunch|repositoryId=F5D91F0689F54D6DBCD5B0F7814710A1|sourceLanguage=en|targetLanguages=fr,de|siteGUID=FBEF7E4A45AEE0E80BA511A3FFE257659D7CA3DF80FE|exportType=siteAll|connectorId="
  }
}
リリース19.4.3で導入されました。

200 OK - インポート・サイト翻訳ジョブのステータスの取得

サイト翻訳をインポートするためのジョブ・ステータス。 レスポンスには、インポートされたアセットおよびサイト・コンテンツ翻訳の詳細と、検証レポートが含まれます。 validateのオプションを指定してジョブを作成した場合、検証レポートのみが表示され、翻訳はインポートされません。 レスポンスにリンクは含まれません。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}?links=none

レスポンス本文

{
  "action": "importTranslations",
  "context": "428C8427D3B4DF8CC8913C43DA8C985D1578932712857",
  "startTime": "2020-01-13T16:25:12.000Z",
  "endTime": "2020-01-13T16:25:33.000Z",
  "progress": "succeeded",
  "completed": true,
  "completedPercentage": 100,
  "valid": true,
  "sourceLanguage": "en",
  "targetLanguages": [
      "fr",
      "de"
  ],
  "importedAssetTranslations": [
      {
        "id": "COREA4145ED68B284FAB9DDCB81AB11721F0",
        "name": "AcmeAssets"
      }
  ],
  "importedSiteTranslations": [
      {
        "fileName": "10.json",
        "page": {
          "id": 10,
          "name": "Home",
          "pageUrl": "index.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
              100,
              201,
              200
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "100.json",
        "page": {
          "id": 100,
          "name": "Developing Templates",
          "parentId": 10,
          "pageUrl": "developing-templates.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
              110,
              120,
              130,
              140,
              150
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "110.json",
        "page": {
          "id": 110,
          "name": "Themes",
          "parentId": 100,
          "pageUrl": "developing-templates/themes.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "120.json",
        "page": {
          "id": 120,
          "name": "Pages",
          "parentId": 100,
          "pageUrl": "developing-templates/pages.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "130.json",
        "page": {
          "id": 130,
          "name": "Navigation",
          "parentId": 100,
          "pageUrl": "developing-templates/navigation.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "140.json",
        "page": {
          "id": 140,
          "name": "Page Content",
          "parentId": 100,
          "pageUrl": "developing-templates/page-content.html",
          "hideInNavigation": false,
          "linkUrl": "",
          "linkTarget": "",
          "children": [
          ],
          "overrideUrl": false,
          "isDetailPage": false
        }
      },
      {
        "fileName": "siteinfo.json"
      },
      {
        "fileName": "structure.json"
      }
  ],
  "assetValidation": {
    "valid": true,
    "languagesNotReturned": [
        "de"
    ],
    "languagesReturnedComplete": [
        "fr"
    ],
    "languagesReturnedIncomplete": [
    ],
    "translationsMissed": [
    ],
    "translationsCorrupted": [
    ],
    "translationsInvalidEncoding": [
    ],
    "itemsToBeImported": [
    ],
    "nonTranslatableItems": [
    ],
    "deletedMasterItems": [
    ]
  },
  "siteValidation": {
    "valid": true,
    "languagesNotReturned": [
        "de"
    ],
    "languagesReturnedComplete": [
        "fr"
    ],
    "languagesReturnedIncomplete": [
    ],
    "translationsMissed": [
    ],
    "translationsCorrupted": [
    ],
    "translationsInvalidEncoding": [
    ],
    "deletedPages": [
    ],
    "itemsToBeImported": [
    ]
  },
  "validationOnly": false
}
リリース20.1.1で導入されました。

200 OK - サイトのリフレッシュ・ジョブのステータスの取得

サイトをリフレッシュするジョブ・ステータス。 expand問合せパラメータを含めることで、レスポンスにすべてのページを含めます。 レスポンスにリンクは含まれません。

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}?links=none&expand=pages

レスポンス本文

{
  "action": "refresh",
  "context": "refresh:355988",
  "progress": "processing",
  "completed": false,
  "pageCount": 5,
  "pendingCount": 1,
  "processingCount": 3,
  "completedCount": 1,
  "failedCount": 0,
  "pages": {
    "limit": 50,
    "count": 5,
    "hasMore": false,
    "offset": 0,
    "items": [
        {
          "pageUrl": "http://oracle.cec.com/site/home.html",
          "status": "complete"
        },
        {
          "pageUrl": "http://oracle.cec.com/site/about.html",
          "status": "processing"
        },
        {
          "pageUrl": "http://oracle.cec.com/site/menu.html",
          "status": "processing"
        },
        {
          "pageUrl": "http://oracle.cec.com/site/menu/details.html",
          "status": "processing"
        },
        {
          "pageUrl": "http://oracle.cec.com/site/privacy-policy.html",
          "status": "pending"
        }
    ]
  }
}
リリース20.2.2で導入されました。

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

404Not Found - Site Job Not Found

サイト・ジョブが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションにジョブへのアクセス権がありません。

エラー・コード

OCE-SITEMGMT-009024

解決 - 識別子のチェック

サイト・ジョブ識別子が有効であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
jobStatus存在しないか、認証されたユーザーが参照できないサイト・ジョブ・ステータス。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteJobNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Job Not Found",
  "status": "404",
  "detail": "Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
  "o:errorCode": "OCE-SITEMGMT-009024",
  "jobStatus": {
    "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423"
  }
}

リクエスト

パス・パラメータ

  • レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。 非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。

問合せパラメータ

  • レスポンスに含めないフィールド名のカンマ区切り文字列。

  • レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

  • 展開するフィールド名のカンマ区切りの文字列。 値allを使用して、すべての関係を展開します。

    expand問合せパラメータには次のフィールド名を指定できます:

    フィールド名説明
    site完了したサイト作成ジョブで作成されたサイト。
    translationFile翻訳ファイルの詳細。
    translationJob翻訳ジョブの詳細。
    pagesサイト・リフレッシュ・ジョブに含まれるすべてのページのリスト。
    translationImportFileインポートするサイト翻訳を含むファイル。
    theme完了したコピー・ジョブのコピーされたテーマ。
    component完了したコピー・ジョブのコピーされたコンポーネント。

  • 拡張のエラーの処理方法を指定します。 指定しない場合は、デフォルトで関連フィールドにエラーの詳細が含まれます。

    有効な値は次のとおりです。

    • ignore - エラーを無視して関係を展開しません。 関連リンクはレスポンスに含まれません
    • include - 展開された関係のかわりにエラー詳細を含めます。 関連リンクが返されます
    • fail - リクエストの拡張の失敗エラー・レスポンスでの失敗

  • レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。

  • レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

    次のリンクは、このリソースにより提供されます:

    リンク関係説明
    parent親リソースが読取り可能な場所を示します。 このリンクはupリンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
    selfリソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
    canonicalリクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
    pages子コレクションのページについて説明します。
    describedByリソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

  • レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。 表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

    次の表現は、return問合せパラメータでサポートされています:

    表現説明
    representationフル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
    defaultデフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
    basic基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
    minimal最小リソース表現。必須プロパティとリンクなしが含まれます。
トップに戻る

レスポンス

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

200レスポンス

OK
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
  • SiteJobStatus
    識別子: action

    サイト・ジョブのバックグラウンド・ジョブの詳細。

ネストされたスキーマ : SiteJobStatus
識別子: action

サイト・ジョブのバックグラウンド・ジョブの詳細。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • SiteJobStatus-allOf[1]
ネストされたスキーマ : SingularResource
型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示
  • links
ネストされたスキーマ : SiteJobStatus-allOf[1]
型: object
ソースを表示

  • 「サイト・ジョブ・ステータス」のタイプ。 有効な値は次のとおりです: 、translate, copy, publish, importTranslations, hardDelete, copyTheme, copyComponent, refresh, publishTheme。

  • 非同期ジョブが完了したかどうか。

  • プロセスの完了数を取得し、0から100までの数値。 非同期ジョブが開始していない場合、完了率は提供されません。 すべてのバックグラウンド非同期ジョブが詳細なプロセスをサポートしているわけではないため、完了率はステップなしでゼロから100にジャンプできます。

  • レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。 非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。

  • 非同期ジョブの実行が終了した時間、または非同期ジョブが失敗した時間。 非同期ジョブが終了していないか失敗した(または開始していない)場合、このプロパティは存在しません。 特定のバックグラウンド・ジョブは停止時間を記録しないことがあるため、ジョブが完了した場合、停止時間がない可能性があります。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  • error

    ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。 このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。

  • クライアントがステータスを再度チェックするまでに待機する必要がある時間のヒントとして、1ミリ秒数。 この値がない場合、ポーリング間隔は提案されず、クライアントは必要に応じてポーリングできることを意味します。

  • 現在の処理ステータスに関する、人間が読み取り可能なメッセージ。 このメッセージは、エンド・ユーザーに進行状況を通知するために使用されます。 非同期リクエストまたはジョブは、判読可能なステータス・メッセージを提供しない場合があります。

  • 非同期ジョブの現在の進行状況。 これらの値は、非同期ジョブが終了したことを示します: succeeded、failed、aborted。 blockedの値は、非同期ジョブには人による承認の待機など、アクションが必要であることを意味します。 非同期ジョブが処理中であることを示す値は次のとおりです: pending、processing、paused。

    有効な値は次のとおりです。

    • pending - リクエストは実行を待機しています
    • processing - リクエストは実行中です
    • succeeded - リクエストは正常に完了しました
    • failed - リクエストに失敗しました
    処理リクエストが完了する前に失敗しました。
    • aborted - リクエストは中断されました
    処理リクエストが完了する前に中止されました。
    • paused - リクエストは実行中でしたが、現在は一時停止しています
    • blocked - リクエストはブロックされています
    リクエストには、人の承認を待機するなどのアクションが必要です。

  • 非同期ジョブ・リクエストのHTTPステータス・コード。 このステータスは、非同期ジョブ・ステータスの問合せ時に取得するステータスではなく、非同期ジョブが完了したときのステータス・レスポンスです。 この値は非同期ジョブの終了後のみ使用可能です。

  • result

    クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。 結果はこのオプション・プロパティで取得されます。 このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。 このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。 レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。 非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。

  • 非同期ジョブの実行が開始された時間。 非同期ジョブが開始していない場合、このプロパティは表示されません。 特定のバックグラウンド・ジョブは開始時間を記録しないことがあるため、ジョブが開始した場合、開始時間がない可能性があります。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

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

ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。 このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。

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

クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。 結果はこのオプション・プロパティで取得されます。 このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。 このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。 レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。 非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。

すべてに一致
ソースを表示
  • HttpResponse

    非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

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

非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

ソースを表示
ネストされたスキーマ: headers
型: array

HTTPレスポンス・ヘッダー。

ソースを表示
ネストされたスキーマ: status
型: object

HTTPステータス・コードのレスポンス値および理由。

ソースを表示

  • 例外に対応するHTTPステータス・コード。 リソースを含む例外には404のHTTPステータスが存在します。

  • 短い、判読可能なステータス・コードのサマリーです。

ネストされたスキーマ: items
型: object
ソースを表示
レスポンスの例(実行中の作成またはコピー・ジョブのステータスの取得)
{
    "context":"F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
    "action":"copy",
    "startTime":"2019-05-31T09:14:29.000Z",
    "progress":"processing",
    "completed":false,
    "completedPercentage":38,
    "intervalToPoll":5000
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : SiteJobNotFoundExceptionDetail
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

  • SiteJobNotFoundExceptionDetail-allOf[1]
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : SiteJobNotFoundExceptionDetail-allOf[1]
型: object
ソースを表示

  • 存在しないか、認証されたユーザーが参照できないサイト・ジョブ・ステータス。

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

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

レスポンスの例(サイト・ジョブが見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Job Not Found",
    "status":"404",
    "detail":"Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
    "o:errorCode":"OCE-SITEMGMT-009024",
    "jobStatus":{
        "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423"
    }
}

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る