Skip to main content

The Task service exposes all the operations available around TASK type components.

Task recovery

The examples below show how to retrieve tasks from an ID list.

GET {{core}}/rest/tasks/{ids} HTTP/1.1

-- URL parameters --
core : host
ids: identifier of the documents to be retrieved

-- Headers --
token: {{token}}
Content-Type: application/json

Task creation

The examples below show how to create a to-do list using the following operation.

GET {{core}}/rest/tasks/ HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host

-- Headers --
token: {{token}}
Content-Type: application/json

-- Body (json) --
[

"workflow": "Inform",
"assignee": "fadmin",
"category": "TASK",
"data": {
"classId": "GEC_Step3_CourrierLu",
"owner": "clm",
"ACL": "ACL_TASK"
},
"name": "3-Courrier lu",
"tags": [

"value": [
"Jean"
],
"name": "PrenomClient",
"readOnly": false
},

"value": [
"123456"
],
"name": "RefClient",
"readOnly": false
},

"value": [
"DUPONT"
],
"name": "NomClient",
"readOnly": false

],
"attachments": [

"componentIds": [
"c46de78c-92d4-45ef-b262-8395aa76a4a8"
],
"id": "Courrier",
"category": "DOCUMENT",
"order": 0

]

]

Task modification

This operation updates a task's tags and data (class identifier, task name, ACL, etc.).

info

This service operates on a cancel and replace basis, so all tag values must be supplied by the service at the time of update. It is therefore advisable to recover the job, make the changes and call the update service.

GET {{core}}/rest/tasks/{ids} HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host
ids: identifiers of tasks to be updated

-- Headers --
token: {{token}}
Content-Type: application/json

-- Body (json) --
[

"workflow": "Inform",
"assignee": "fadmin",
"category": "TASK",
"data": {
"classId": "GEC_Step3_CourrierLu",
"owner": "clm",
"ACL": "ACL_TASK"
},
"name": "3-Courrier lu",
"tags": [

"value": [
"Jean"
],
"name": "PrenomClient",
"readOnly": false
},

"value": [
"123456"
],
"name": "RefClient",
"readOnly": false
},

"value": [
"DUPONT"
],
"name": "NomClient",
"readOnly": false

],
"attachments": [

"componentIds": [
"c46de78c-92d4-45ef-b262-8395aa76a4a8"
],
"id": "Courrier",
"category": "DOCUMENT",
"order": 0

]

]

Job search

The search operations all work on the same model as described here.

Task deletion

The examples below show how to delete a to-do list from an ID list.

DELETE {{core}}/rest/tasks/{ids} HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host

-- Headers --
token: {{token}}
Content-Type: application/json

Application of an answer

Simple answer

The examples below show how to apply a simple answer to a list of tasks from a list of identifiers.

PUT {{core}}/rest/tasks/{ids}/answer HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host
ids: task identifiers on which to apply the response

-- Headers --
token: {{token}}
Content-Type: application/json

-- Body (json) --

"id": "Decline"

Answer with reason

The examples below show how to retrieve tasks from an ID list.

PUT {{core}}/rest/tasks/{ids}/answer HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host
ids: task identifiers on which to apply the response

-- Headers --
token: {{token}}
Content-Type: application/json

-- Body (json) --

"id": "Decline",
"type": "com.flower.docs.domain.taskclass.ReasonedAnswer",
"tags": [

"name": "Remark"
"value": [
"The receipt is not up to date."
]

]

Task assignment

The examples below show how to assign a task list to a user from an ID list.

PUT {{core}}/rest/tasks/{ids}/assignee/{username} HTTP/1.1

-- URL parameters --
core: FlowerDocs Core host
ids: task identifiers on which to apply the response
username: assigned user identifier

-- Headers --
token: {{token}}
Content-Type: application/json