機械翻訳について

移動先

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

一括ダウンロード・ジョブのステータスの取得

get

/documents/api/1.2/folders/{folderId}/_download/{jobId}

一括ダウンロード・ジョブのステータスを返します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• folderId: string

  フォルダのグローバル一意識別子(GUID)。 参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

• jobId: string

  一括ダウンロード・ジョブのグローバル一意識別子(GUID)。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ : FolderStatusBulkZipResponse

タイプ: object

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

ソースを表示

• completed(optional): boolean
  ジョブが完了したかどうかを示すブール
• completedPercentage(optional): integer
  プロセスの完了数を取得し、0から100までの数値。
• details(optional): object BulkZipFileDetails
  zipファイルに関する情報。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• items(optional): object BulkZipItemsDetails
  zipファイルにコピーされない、グローバルな一意識別子ファイルのオプションの配列。
• links(optional): object BulkZipLinkDetails
  完了したジョブのリンク。
• progress(optional): string
  ジョブの状態。 次のいずれかになります: SUCCEEDED,FAILED,PROCESSING,PENDING,ABORTED,BLOCKED.

{
    "description":"The response body includes information about the bulk zip job.",
    "type":"object",
    "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."
        },
        "details":{
            "$ref":"#/definitions/BulkZipFileDetails"
        },
        "items":{
            "$ref":"#/definitions/BulkZipItemsDetails"
        },
        "links":{
            "$ref":"#/definitions/BulkZipLinkDetails"
        },
        "progress":{
            "type":"string",
            "description":"The state of the job. This can be one of the following: SUCCEEDED,FAILED,PROCESSING,PENDING,ABORTED,BLOCKED."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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

タイプ: object

zipファイルに関する情報。

ソースを表示

• filename(optional): string
  zipがダウンロードされたときに推奨されるファイル名。
• filesize(optional): integer
  ダウンロードするzipのファイル・サイズ。

{
    "description":"Information about the zip file.",
    "properties":{
        "filename":{
            "type":"string",
            "description":"The suggested filename when the zip is downloaded."
        },
        "filesize":{
            "type":"integer",
            "description":"The file size of zip to be downloaded."
        }
    }
}

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

タイプ: object

zipファイルにコピーされない、グローバルな一意識別子ファイルのオプションの配列。

ソースを表示

• error(optional): string
  現在は、Item not availableの状態です。
• id(optional): string
  zipにコピーされていないファイルのグローバル一意識別子。

{
    "description":"Optional array of files globally unique identifiers that are not copied to the zip file.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The globally unique identifier of the file not copied to the zip."
        },
        "error":{
            "type":"string",
            "description":"Currently states <code>Item not available</code>."
        }
    }
}

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

タイプ: object

完了したジョブのリンク。

ソースを表示

• href(optional): string
  zipファイルをダウンロードするためのURL。
• mediaType(optional): string
  ダウンロードの形式。これはapplication/zipになります
• method(optional): string
  URLにアクセスするメソッド。これはGETになります
• rel(optional): string
  リレーション、これはenclosureになります

{
    "description":"Links for a completed job.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The URL to download the zip file."
        },
        "rel":{
            "type":"string",
            "description":"The relation, this will be <code>enclosure</code>"
        },
        "method":{
            "type":"string",
            "description":"The method to access the URL, this will be <code>GET</code>"
        },
        "mediaType":{
            "type":"string",
            "description":"The format of the download, this will be <code>application/zip</code>"
        }
    }
}

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

{
    "completed":true,
    "completedPercentage":100,
    "details":{
        "filename":"OCE-20210303.zip",
        "filesize":27811
    },
    "errorCode":0,
    "links":{
        "href":"OCEHost/documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/43C4798AB49E496B53A27D99F3CE768F1614800841210/package",
        "rel":"enclosure",
        "method":"GET",
        "mediaType":"application/zip"
    },
    "progress":"SUCCEEDED",
    "type":"folder"
}

400レスポンス

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

403レスポンス

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

トップに戻る

例

次の例では、完了したジョブのステータスをリクエストします。

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "true",
    "completedPercentage": "100",
    "details": {
        "filename": "OCE-20210305.zip",
        "filesize": "774987"
    },
    "errorCode": "0",
    "links": [
        {
            "href": "[OCEHost]/documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028/package",
            "rel": "enclosure",
            "method": "GET",
            "mediaType": "application/zip"
        }
    ],
    "progress": "SUCCEEDED",
    "type": "folder"
}

例2

次の例では、完了したジョブのステータスをリクエストしますが、複数のファイルはzipにコピーされません:

GET .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/945B2A631ED396410B04ADC5E814EC8B1614898571312

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "true",
    "completedPercentage": "100",
    "details": {
        "filename": "OCE-20210304.zip",
        "filesize": "8024"
    },
    "errorCode": "0",
    "items": [
        {
            "id": "DC034C1C970D99900684230D1480C189B284D1C79D21",
            "error": "Item not available."
        },
        {
            "id": "D4B22A83BED696112AC9748463A9AA0BDDE61F516AC1",
            "error": "Item not available."
        }
    ],
    "links": [
        {
            "href": "[OCEHost]/documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/945B2A631ED396410B04ADC5E814EC8B1614898571312/package",
            "rel": "enclosure",
            "method": "GET",
            "mediaType": "application/zip"
        }
    ],
    "progress": "SUCCEEDED",
    "type": "folder"
}

例3

次の例では、処理中ジョブのステータスをリクエストします:

GET .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/BF18AE4AC6F86C9247AD2E2CED0092021614899361960

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "completed": "false",
    "completedPercentage": "45",
    "details": {
        "filename": "OCE-20210304.zip",
        "filesize": "0"
    },
    "errorCode": "0",
    "progress": "PROCESSING",
    "type": "folder"
}

例4

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

GET .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/BF18AE4AC6F86C9247AD2E2CED0092021614899361960

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csBulkdownloadUnableToGetStatusJob",
    "errorMessage": "There is no bulkdownload job for the specified job Id.",
    "errorType": "folder",
    "title": "There is no bulkdownload job for the specified job Id.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る