plan wait
post
/V0/nosql/admin/plan#wait
Waits for the specified plan to complete. If the optional timeout is specified, it waits for the time specified, otherwise waits indefinitely.
Use last
to reference the most recently created plan.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "wait" ]
Example:
{
"command":"wait",
"arguments":[
{
"id":"Id of the plan to wait"
},
{
"last":"true|false Whether to wait for the last plan"
},
{
"seconds":"Timeout in seconds for waiting"
}
]
}
Response
Supported Media Types
- application/json
200 Response
Operation ended successfully
Root Schema : commonResponse
Type:
Show Source
object
-
description(required): string
-
operation(required): string
-
returnCode(required): string
-
returnValue(required): object
returnValue
Example:
{
"operation":"operation executed",
"returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
"description":"error description when returnCode != 5000",
"returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
}
Nested Schema : returnValue
Type:
object