機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

抽出ジョブのステータスの取得

get

/documents/api/1.2/files/{fileId}/_extract/{jobId}

抽出ジョブのステータスを返します

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• fileId: string

  フォルダに抽出されるZIPファイルのグローバル一意識別子(GUID)

• jobId: string

  抽出ジョブのグローバル一意識別子(GUID)。

問合せパラメータ

• includeIgnoredItemDetails: boolean

  trueにデフォルト設定されるオプションのブール値。 falseの場合、ignoredItems配列はレスポンスに含まれません

• includeSkippedItemDetails: boolean

  trueにデフォルト設定されるオプションのブール値。 falseの場合、skippedItems配列はレスポンスに含まれません

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ : FileStatusExtractZipResponse

タイプ: object

レスポンス本文には、zip抽出ジョブに関する情報が含まれます。

ソースを表示

• completed(optional): boolean
  ジョブが完了したかどうかを示すブール
• completedPercentage(optional): integer
  プロセスの完了数を取得し、0から100までの数値。
• filesCreated(optional): integer
  抽出ジョブによって作成されたファイルの数。
• filesIgnored(optional): integer
  抽出ジョブで無視されたファイルの数。
• filesNameAdjusted(optional): integer
  抽出ジョブによって名前が変更された抽出ファイル名の数。
• filesOverwritten(optional): integer
  抽出ジョブによって上書きされた既存のファイルの数。
• filesProcessed(optional): integer
  抽出ジョブで処理されたファイルの数。
• filesSkipped(optional): integer
  抽出ジョブによって抽出されないファイルの数。
• filesVersioned(optional): integer
  抽出ジョブによってバージョンが増加した既存のファイルの数。
• ignoredItems(optional): object ignoredItems
  抽出ジョブで無視されたzipファイル名の配列。
• message(optional): string
  抽出ジョブのステータスに関する簡単なメッセージ。
• progress(optional): string
  抽出ジョブの状態を示す単語。 次のような可能性があります:

  • SUCCEEDED -- ジョブは正常に完了しました
  • FAILED -- ジョブの失敗
  • PROCESSING -- ジョブは処理中です
  • PENDING -- ジョブは保留中です
  • ABORTED -- ジョブが中断されました

  .
• skippedItems(optional): object skippedItems
  抽出ジョブによってスキップされたzipファイル名の配列。

{
    "description":"The response body includes information about the zip extract job.",
    "properties":{
        "completed":{
            "type":"boolean",
            "description":"A boolean indicating if the job in complete"
        },
        "completedPercentage":{
            "type":"integer",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "progress":{
            "type":"string",
            "description":"A word indicating the state of the extraction job. Possibilities include: <ul><li><code>SUCCEEDED</code> -- Job Completed Successfully</li><li><code>FAILED</code> -- Job Failed</li><li><code>PROCESSING</code> -- Job is processing</li><li><code>PENDING</code> -- Job is pending</li><li><code>ABORTED</code> -- Job aborted</li></ul>."
        },
        "message":{
            "type":"string",
            "description":"A brief message about the status of the extraction job."
        },
        "filesProcessed":{
            "type":"integer",
            "description":"The number of files processed by the extraction job."
        },
        "filesIgnored":{
            "type":"integer",
            "description":"The number of files ignored by the extraction job."
        },
        "filesCreated":{
            "type":"integer",
            "description":"The number of files created by the extraction job."
        },
        "filesNameAdjusted":{
            "type":"integer",
            "description":"The number of extracted file names that were renamed by the extraction job."
        },
        "filesVersioned":{
            "type":"integer",
            "description":"The number of existing files that had the version increased by the extraction job."
        },
        "filesOverwritten":{
            "type":"integer",
            "description":"The number of existing files that were over written by the extraction job."
        },
        "filesSkipped":{
            "type":"integer",
            "description":"The number of files not extracted by the extraction job."
        },
        "skippedItems":{
            "type":"object",
            "description":"An array of zip filenames that were skipped by the extraction job.",
            "allOf":{
                "$ref":"#/definitions/FilesSkippedIgnoredByExtractZip"
            }
        },
        "ignoredItems":{
            "type":"object",
            "description":"An array of zip filenames that were ignored by the extraction job.",
            "allOf":{
                "$ref":"#/definitions/FilesSkippedIgnoredByExtractZip"
            }
        }
    }
}

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

タイプ: object

抽出ジョブで無視されたzipファイル名の配列。

すべてに一致

ソースを表示

• object FilesSkippedIgnoredByExtractZip
  抽出ジョブによってファイルが抽出されなかった理由に関する情報

{
    "type":"object",
    "description":"An array of zip filenames that were ignored by the extraction job.",
    "allOf":{
        "$ref":"#/definitions/FilesSkippedIgnoredByExtractZip"
    }
}

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

タイプ: object

抽出ジョブによってスキップされたzipファイル名の配列。

すべてに一致

ソースを表示

• object FilesSkippedIgnoredByExtractZip
  抽出ジョブによってファイルが抽出されなかった理由に関する情報

{
    "type":"object",
    "description":"An array of zip filenames that were skipped by the extraction job.",
    "allOf":{
        "$ref":"#/definitions/FilesSkippedIgnoredByExtractZip"
    }
}

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

タイプ: object

抽出ジョブによってファイルが抽出されなかった理由に関する情報

ソースを表示

• error(optional): string
  このアイテムのステータスに関する簡単なエラー・メッセージ。
• id(optional): string
  抽出されなかったzip内のファイル名。
• type(optional): string
  抽出されなかったオブジェクト・タイプfileまたはdirectory。

{
    "description":"Information about why a file was not extracted by the extraction job",
    "properties":{
        "id":{
            "type":"string",
            "description":"The filename in the zip that was not extracted."
        },
        "type":{
            "type":"string",
            "description":"The object type, <code>file</code> or <code>directory</code> that was not extracted."
        },
        "error":{
            "type":"string",
            "description":"A brief error message about the status of this item."
        }
    }
}

レスポンスの例(application/json)

{
    "completed":"true",
    "completedPercentage":"100",
    "errorCode":"0",
    "filesCreated":"3",
    "filesIgnored":"0",
    "filesNameAdjusted":"0",
    "filesOverwritten":"0",
    "filesProcessed":"3",
    "filesSkipped":"0",
    "filesVersioned":"0",
    "message":"Zip processing completed",
    "progress":"SUCCEEDED",
    "type":"file"
}

400レスポンス

返されたエラーの説明に従い、リクエストは無効です。

403レスポンス

ユーザーに読取り権限がない場合は禁止されています。

トップに戻る

例

次の例では、完了した抽出ジョブのステータスを取得します。

GET .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-E83150A29A911D33321FE8A9A6C5814F1643066913096

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "true",
    "completedPercentage": "100",
    "errorCode": "0",
    "filesCreated": "0",
    "filesIgnored": "0",
    "filesNameAdjusted": "0",
    "filesOverwritten": "0",
    "filesProcessed": "3",
    "filesSkipped": "0",
    "filesVersioned": "0",
    "message": "Zip processing completed",
    "progress": "SUCCEEDED",
    "type": "file"
}

例2

次の例では、完了した抽出ジョブのステータスを取得しますが、ファイルはフォルダにすでに存在するため、スキップされました。

GET .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-930F35D291CEA348255D1974A84CB3571643127919210

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "true",
    "completedPercentage": "100",
    "errorCode": "0",
    "filesCreated": "0",
    "filesIgnored": "0",
    "filesNameAdjusted": "0",
    "filesOverwritten": "0",
    "filesProcessed": "0",
    "filesSkipped": "3",
    "filesVersioned": "0",
    "message": "Zip processing completed",
    "progress": "SUCCEEDED",
    "skippedItems": [
        {
            "id": "exif-xmp.jpg",
            "type": "file",
            "error": "Entry skipped - existing file with same name in folder"
        },
        {
            "id": "Mugs.jpg",
            "type": "file",
            "error": "Entry skipped - existing file with same name in folder"
        },
        {
            "id": "Mugs.png",
            "type": "file",
            "error": "Entry skipped - existing file with same name in folder"
        }
    ],
    "type": "file"
}

例3

次の例では、進行中の抽出ジョブのステータスを取得します。

GET .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-930F35D291CEA348255D1974A84CB3571643127919210

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "false",
    "completedPercentage": "25",
    "errorCode": "0",
    "filesCreated": "0",
    "filesIgnored": "1",
    "filesNameAdjusted": "0",
    "filesOverwritten": "0",
    "filesProcessed": "0",
    "filesSkipped": "0",
    "filesVersioned": "0",
    "message": "Processing entry 6image/./exif-xmp.jpg",
    "progress": "PROCESSING",
    "type": "file"
}

例4

次の例では、別のユーザーが所有するジョブのステータスをリクエストします。 返されるエラーは、データの露出を防ぐために詳細ではありません。

GET .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-930F35D291CEA348255D1974A84CB3571643127919210

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csCloudBulkExtractionRequestJobNotValid",
    "errorMessage": "Extraction job ID not valid.",
    "errorType": "file",
    "title": "Extraction job ID not valid.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る