Get Clone Operation Status

Returns the status of an asynchronous operation.

For common headers and authentication methods, see Access to the API. For sample scenarios, see API usage examples.

Request

GET

https://api.wiki.yandex.net/v1/operations/clone/{task_id}

Path parameters

Name

Description

task_id

Type: string

Asynchronous operation ID. Pass the operation.id field value from the response to the method that started the operation. You can also request the status at the address in the status_url field of that response.

Example: ``

Responses

200 OK

Body

application/json

{
  "status": "scheduled",
  "progress": {
    "percentage": 0.5,
    "details": "example"
  },
  "result": {
    "page": {
      "id": 0,
      "slug": "example"
    }
  }
}

Name	Description
status	All of 1 type Status Type: Status An enumeration. Enum: `scheduled`, `in_progress`, `success`, `failed` Asynchronous operation state. Example: `scheduled`
progress	All of 1 type Progress Type: Progress Example `{ "percentage": 0.5, "details": "example" }` Operation progress information. Populated in the in_progress state. Example `{ "percentage": 0.5, "details": "example" }`
result	All of 1 type PageCloneResponse Type: PageCloneResponse Example `{ "page": { "id": 0, "slug": "example" } }` The result of a completed operation. Populated in the success and failed states. Example `{ "page": { "id": 0, "slug": "example" } }`

Status

An enumeration.

Type: string

Enum: scheduled, in_progress, success, failed

Progress

Name

Description

details

Type: string

Text description of the operation progress.

Example: example

percentage

Type: number

Fraction of work completed. For example, 0.5 corresponds to 50%.

Example

{
  "percentage": 0.5,
  "details": "example"
}

PageSchema

Name

Description

Type: integer

Page ID. In /v1/pages/{idx} methods, the value of idx is the value of this field.

slug

Type: string

Page address relative to the Wiki root, such as team/project. Use this value as the slug parameter when retrieving a page by address.

Example: example

Example

{
  "id": 0,
  "slug": "example"
}

PageCloneResponse

Name	Description
page	All of 1 type PageSchema Type: PageSchema Example `{ "id": 0, "slug": "example" }` The cloned page Example `{ "id": 0, "slug": "example" }`

Example

{
  "page": {
    "id": 0,
    "slug": "example"
  }
}

Was the article helpful?

Overview

Get Clone Inline Grid Operation Status