Task



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/tasks

Summary


Resources Methods
https://localhost:8443/api/rest/tasks

GET  Retrieves a list of current tasks the user is authorized to view.

https://localhost:8443/api/rest/tasks/{task-identifier}

GET  Retrieves a task.

DELETE  Terminates a task.

Resources


https://localhost:8443/api/rest/tasks


Methods

GET


Retrieves a list of current tasks the user is authorized to view.
Users with Provisioner or Administrator roles can retrieve all tasks on the DMA.
Users without these roles can only retrieve tasks that they created.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-task-list+xml
Information successfully retrieved
304
Task information has not changed since the last search.

Note: The API client must provide the "plcm-task-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-task-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the task on the server.

https://localhost:8443/api/rest/tasks/{task-identifier}


Template Parameters

Name Type Description
task-identifier xs:string The task identifier

Methods

GET


Retrieves a task.
The user must be the task creator or have Administrator or Provisioner roles.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-task+xml
Information successfully retrieved
304
Task information has not changed since the last search.

Note: The API client must provide the "plcm-task" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-task" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the task on the server.
403 application/vnd.plcm.plcm-error+xml
Permission denied. The user must be the task creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
No such task

DELETE


Terminates a task.
The user must be the task creator or have Administrator or Provisioner roles.
[tags: DMA]

Response

Status Representation Description
204 Task successfully terminated
403 application/vnd.plcm.plcm-error+xml
Permission denied. The user must be the task creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
No such task