Attributes | Elements | Operations | ||
Home Frames |
|
|
|
|
Attributes
Attribute | Type | Required | Modifiable | Since | Description |
---|---|---|---|---|---|
href | anyURI | No | always | 1.5 | Contains the URI to the entity. |
type | string | No | always | 1.5 | Contains the type of the entity. |
name | string | Yes | always | 1.5 | The name of the entity. |
id | string | No | none | 1.5 | The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused. |
createdTime | dateTime | Yes | none | 1.5 | The creation date/time of the request itself. |
timeoutDate | dateTime | Yes | none | 1.5 | The date/time at which this request times out. Requests time out if is not acted upon within a configured interval. When a request times out, it is automatically resumed, aborted or failed. |
timeoutAction | string | Yes | none | 1.5 | Action that is automatically taken when a request times out. One of: resume (The task will be resumed.), abort (The task will be aborted. Transient objects are cleaned up. Task status is set to ABORTED.), fail (The task will be failed. Transient object status and task status are set to ERROR.) |
status | string | Yes | none | 1.5 | Status of the blocking task. |
Elements
Element | Type | Occurrence | Modifiable | Since | Description |
---|---|---|---|---|---|
VCloudExtension | VCloudExtensionType | 0..* | always | 1.5 | An optional extension element that can contain an arbitrary number of elements and attributes. |
Link | LinkType | 0..* | none | 1.5 | Optional link to an entity or operation associated with this object. |
Description | string | 0..1 | always | 1.5 | Optional description. |
Tasks | TasksInProgressType | 0..1 | none | 1.5 | A list of queued, running, or recently completed tasks associated with this entity. |
Organization | ReferenceType | 1 | none | 1.5 | The organization in which the blocking task runs. |
User | ReferenceType | 0..1 | none | 1.5 | The user who triggered the blocking task. |
TaskOwner | ReferenceType | 0..1 | none | 1.5 | The owner of the blocking task. |
Operations
CRUD | Operation | Description | Since |
---|---|---|---|
create | POST /admin/extension/blockingTask/{id}/action/updateProgress | This operation updates:
|
1.5 |
read | GET /admin/extension/blockingTask/{id} | Gets the representation of a task extension request. | 1.5 |
action | POST /admin/extension/blockingTask/{id}/action/abort | This operation:
|
1.5 |
action | POST /admin/extension/blockingTask/{id}/action/fail | This operation:
|
1.5 |
action | POST /admin/extension/blockingTask/{id}/action/resume | Resumes request and continues with executing underlying operation. | 1.5 |
Top of page | Attributes | Elements | Operations | |
Home Frames |
|
|
|
|