anchor.diff:  
   include::../../../{snippets}/CommonSummaryResourceFields/response-fields.adoc[]
   
  +== Tasks-Resource
  +
  +=== Get a list of all tasks
  +
  +A `GET` request is used to retrieve a task summary.
  +
  +==== Example Request
  +
  +include::../../../{snippets}/GetAllTasksDocTest/http-request.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/GetAllTasksDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +include::../../../{snippets}/GetAllTasksDocTest/response-fields.adoc[]
  +
  +=== Filter and sort options
  +
  +The list generated in the response can be filtered using following parameters in the uri: +
  +name | priority | state | classification.key | workbasket-id | {workbasket-key , domain} | +
  +owner | por.company | por.system | por.instance | por.type | por.value +
  +
  +It can also be sorted by using this set of parameters: +
  +sortBy = { classification.key | por.type | por.value | state | name| due | planned | priority } | order={ desc | asc }
  +
  +=== Get a single task
  +
  +A `GET` request is used to retrieve a task.
  +
  +==== Example Request
  +
  +include::../../../{snippets}/GetSpecificTaskDocTest/http-request.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/GetSpecificTaskDocTest/http-response.adoc[]
  +
  +[[task]]
  +==== Response Structure
  +
  +include::../../../{snippets}/GetSpecificTaskDocTest/response-fields.adoc[]
  +
  +=== Update a task
  +
  +A `PUT` request is used to update a task.
  +
  +==== Example Request
  +
  +include::../../../{snippets}/UpdateTaskDocTest/http-request.adoc[]
  +
  +==== Request Structure
  +
  +include::../../../{snippets}/UpdateTaskDocTest/request-fields.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/UpdateTaskDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +include::../../../{snippets}/UpdateTaskDocTest/response-fields.adoc[]
  +
  +=== Claim a task
  +
  +A `POST` request is used to claim a task
  +
  +==== Example Request
  +
  +Note the empty request-body in the example.
  +
  +include::../../../{snippets}/ClaimTaskDocTest/http-request.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/ClaimTaskDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +The response-body is essentially the same as for getting a single task. +
  +Therefore for the response fields you can refer to the <<task, single task>>.
  +
  +=== Complete a task
  +
  +A `POST` request is used to complete a task
  +
  +==== Example Request
  +
  +Note the empty request-body in the example.
  +
  +include::../../../{snippets}/CompleteTaskDocTest/http-request.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/CompleteTaskDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +The response-body is essentially the same as for getting a single task. +
  +Therefore for the response fields you can refer to the <<task, single task>>.
  +
  +=== Create a new task
  +
  +A `POST` request is used to create a new task.
  +
  +==== Example Request
  +
  +This minimal example shows only the required fields to create a new task. The <<create-task-request-structure, request structure>> shows all possible fields for creating a task.
  +
  +include::../../../{snippets}/CreateTaskDocTest/http-request.adoc[]
  +
  +[[create-task-request-structure, request structure]]
  +==== Request Structure
  +
  +include::../../../{snippets}/CreateTaskDocTest/request-fields.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/CreateTaskDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +The response-body is essentially the same as for getting a single task. +
  +Therefore for the response fields you can refer to the <<task, single task>>.
  +
  +=== Delete a task
  +
  +A `DELETE` request is used to delete a task.
  +
  +==== Example request
  +
  +include::../../../{snippets}/DeleteTaskDocTest/http-request.adoc[]
  +
  +==== Example response
  +
  +include::../../../{snippets}/DeleteTaskDocTest/http-response.adoc[]
  +
  +=== Transfer a task to another workbasket
  +
  +A `POST` request is used to transfer a task from one to another workbasket.
  +
  +==== Example Request
  +
  +include::../../../{snippets}/TransferTaskDocTest/http-request.adoc[]
  +
  +==== Example Response
  +
  +include::../../../{snippets}/TransferTaskDocTest/http-response.adoc[]
  +
  +==== Response Structure
  +
  +The response-body is essentially the same as for getting a single task. +
  +Therefore for the response fields you can refer to the <<task, single task>>.
  +
   == Classifications-Resource
   
   This resource provides the entry point with classifications.
  
positive.code: ==== Example Response
  
  include::../../../{snippets}/DeleteClassificationDocTest/http-response.adoc[]
  
  == Workbaskets-Resource
  
  
negative.code: The access items hold information about the permissions to the workbaskets.
  
  include::../../../{snippets}/AccessItemsDocTest/response-fields.adoc[]
  
  [[paged-request]]
  == Example for a paged request (using the AbstractPagingController)
  
  Summary Resources can be requested in a paged format.
  
  === Example request
  
  include::../../../{snippets}/CommonSummaryResourceFields/http-request.adoc[]
  
  === Example response
  
  include::../../../{snippets}/CommonSummaryResourceFields/response-body.adoc[]
  
  