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

インポートされる翻訳ファイルの詳細の取得

get

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

RELATION

サイト翻訳のインポートに使用された翻訳ファイルの詳細。

リリース19.2.1.での導入。

認可

この関係にアクセスするには、親リソースに対する読取りアクセス権が必要です。

成功したレスポンスの例

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

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/sites/_status/{id}/translationImportFile

レスポンス本文

{
  "id": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
  "name": "Marketing.docx",
  "description": "value",
  "type": "file",
  "version": "1",
  "size": "10987",
  "mimetype": "application/doc",
  "parentID": "self",
  "createdTime": "2019-09-20T14:09:57Z",
  "createdBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "John Smith",
    "loginName": "jsmith",
    "type": "user"
  },
  "modifiedTime": "2019-09-20T14:09:57Z",
  "modifiedBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "John Smith",
    "loginName": "jsmith",
    "type": "user"
  },
  "ownedBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "John Smith",
    "loginName": "jsmith",
    "type": "user"
  },
  "conversationID": "value",
  "isConversationInherited": false,
  "reservationDate": "2019-09-20T14:09:57Z",
  "reservedBy": {
    "id": "UC1279D4F6BCCD27849F348E5915CC72E971",
    "displayName": "John Smith",
    "loginName": "jsmith",
    "type": "user"
  }
}

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

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(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"
  }
}

404Not Found - Relationship Not Found

関係が存在しないため、関係を読み取ろうとしましたが失敗しました。 関係が存在しなくなった場合、または認証されたアイデンティティが関係の詳細の読取りを承認されていない場合に、関係の読取りが失敗する可能性があります。

エラー・コード

PAAS-005027

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

このリソースは、サイト・ジョブ・ステータスとドキュメント・ファイル・リソース間の関係を表します。 サイト・ジョブ・ステータスに関連付けられているドキュメント・ファイルがない場合、レスポンス・ステータス・コードは204 No Contentになります。 ドキュメント・ファイルが削除されたか、リソースを読み取る権限が認証されたユーザーにない場合、レスポンス・ステータス・コードは「404見つかりません」になり、レスポンス本文に「関係が見つかりません」エラーが返されます。

リクエスト

パス・パラメータ

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

問合せパラメータ

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

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

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

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

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

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

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

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

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

レスポンス

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

200レスポンス

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

    ドキュメントのファイルに関する情報。

    リリース19.4.3での導入。
ネストされたスキーマ : DocumentFile

ドキュメントのファイルに関する情報。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • SingularResource

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

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

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

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

ファイルを作成したユーザー。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • DocumentUser

    ファイルまたはフォルダのユーザーに関する情報。

    リリース19.4.3での導入。
ネストされたスキーマ : modifiedBy

ファイルを最後に変更したユーザー。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • DocumentUser

    ファイルまたはフォルダのユーザーに関する情報。

    リリース19.4.3での導入。
ネストされたスキーマ : ownedBy

ファイルを所有するユーザー。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • DocumentUser

    ファイルまたはフォルダのユーザーに関する情報。

    リリース19.4.3での導入。
ネストされたスキーマ : reservedBy

ファイルが予約されているユーザー。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • DocumentUser

    ファイルまたはフォルダのユーザーに関する情報。

    リリース19.4.3での導入。
ネストされたスキーマ : DocumentUser

ファイルまたはフォルダのユーザーに関する情報。

リリース19.4.3での導入。
すべてに一致
ソースを表示
  • SingularResource

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

  • DocumentUser-allOf[1]
ネストされたスキーマ : DocumentUser-allOf[1]
型: object
ソースを表示
レスポンスの例 ()
{
    "id":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
    "name":"Marketing.docx",
    "description":"value",
    "type":"file",
    "version":"1",
    "size":"10987",
    "mimetype":"application/doc",
    "parentID":"self",
    "createdTime":"2019-09-20T14:09:57Z",
    "createdBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"John Smith",
        "loginName":"jsmith",
        "type":"user"
    },
    "modifiedTime":"2019-09-20T14:09:57Z",
    "modifiedBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"John Smith",
        "loginName":"jsmith",
        "type":"user"
    },
    "ownedBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"John Smith",
        "loginName":"jsmith",
        "type":"user"
    },
    "conversationID":"value",
    "isConversationInherited":false,
    "reservationDate":"2019-09-20T14:09:57Z",
    "reservedBy":{
        "id":"UC1279D4F6BCCD27849F348E5915CC72E971",
        "displayName":"John Smith",
        "loginName":"jsmith",
        "type":"user"
    }
}

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"
    }
}
レスポンスの例 (関係が見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406レスポンス

受入れられない

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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