機械翻訳について

移動先

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

指定された一括ダウンロード・ジョブのステータスを取得します。

get

/content/management/api/v1.1/items/_download/{jobId}

一括ダウンロード・ジョブ・ステータスを読み取ります。

リクエスト

パス・パラメータ

• jobId: string
  一括ダウンロード・ジョブID。

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : BulkDownloadJobStatus

型: object

BulkDownloadJobStatus

ソースを表示

• body(optional): object JobStatusBody
• completed(optional): boolean
  元のリクエストが完了しているかどうか
• completedPercentage(optional): integer(int32)
  プロセスの完了数を取得し、0から100までの数値。
• details(optional): object JobFileDetailsBean
• links(optional): array links
• progress(optional): string
  許容値: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  元のリクエストの現在の進行状況。 これはレスポンス取得の必須プロパティです。

{
    "type":"object",
    "properties":{
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "body":{
            "$ref":"#/definitions/JobStatusBody"
        },
        "details":{
            "$ref":"#/definitions/JobFileDetailsBean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"BulkDownloadJobStatus"
}

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

型: object

ソースを表示

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SkippedItem"
            }
        }
    }
}

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

型: object

ソースを表示

• filename(optional): string
  ダウンロードの準備ができたら、zipファイルの推奨ファイル名。
• filesize(optional): integer(int64)
  ダウンロードの準備が整ったときのzipファイルのバイト単位のファイル・サイズ。

{
    "type":"object",
    "properties":{
        "filename":{
            "type":"string",
            "description":"The suggested filename of the zip file when it is ready for download."
        },
        "filesize":{
            "type":"integer",
            "format":"int64",
            "description":"The file size in bytes of the zip file when it is ready for download."
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースを表示

• Array of: object SkippedItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SkippedItem"
    }
}

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

型: object

ソースを表示

• error(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "error":{
            "type":"string"
        }
    }
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る