Webservice: Workflow

Interaction with the Workflow engine [Commercial editions only]

Index Method Request(s) Response Description
1 complete sid
taskId
transition
 completes a task taking a given transition
2 getTasksAssignedToMe sid
 tasks retrieves the tasks assigned to the current user
3 addNote sid
taskId
note
 history adds a new note
4 claim sid
taskId
 claims a task
5 unclaim sid
taskId
 turns a task back to pool
6 reassign sid
taskId
userId
 reassigns a task to another user
7 getWorkflows sid
 workflows lists the available workflows
8 getTasksICanOwn sid
 tasks retrieves the tasks that can be owned by the current user
9 getHistories sid
instanceId
event
 histories gets the histories of a workflow instance
10 appendDocuments sid
taskId
docIds
 appends new documents to the workflow
11 startWorkflow sid
workflow
tag
color
docIds
 instanceId launches a new workflow instance

Method #1: complete

completes a task taking a given transition

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task
     transition
String Y name of the transition

Method #2: getTasksAssignedToMe

retrieves the tasks assigned to the current user

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     tasks
WSWorkflowTask Y Y
          id
String Y task identifier
          name
String Y name of the task
          instanceId
String Y identifier of the workflow instance
          workflowName
String Y
          tag
String Y tag of the workflow instance
          lastNote
String Y
          assignee
String Y
          candidates
String Y Y possible candidates for this task
          appendedDocs
Long Y Y documents appended to the current workflow instance
          transitions
String Y Y
          startDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          dueDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          endDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

Method #3: addNote

adds a new note

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task
     note
String Y text of the note

Response

Name Type Required Multiple Description
     history
WSWorkflowHistory Y
          id
Long Y
          docId
Long document identifier
          folderId
Long Y
          userId
Long Y
          path
String Y
          date
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          username
String Y
          event
String Y
          comment
String Y
          version
String Y
          sessionId
String Y
          filename
String Y
          templateId
Long Y
          instanceId
String Y
          taskname
String Y
          taskDisplay
String Y
          transition
String Y
          taskId
String Y
          templateVersion
Integer Y

Method #4: claim

claims a task

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task

Method #5: unclaim

turns a task back to pool

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task

Method #6: reassign

reassigns a task to another user

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task
     userId
Long Y identifier of the user

Method #7: getWorkflows

lists the available workflows

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     workflows
String Y Y

Method #8: getTasksICanOwn

retrieves the tasks that can be owned by the current user

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     tasks
WSWorkflowTask Y Y
          id
String Y task identifier
          name
String Y name of the task
          instanceId
String Y identifier of the workflow instance
          workflowName
String Y
          tag
String Y tag of the workflow instance
          lastNote
String Y
          assignee
String Y
          candidates
String Y Y possible candidates for this task
          appendedDocs
Long Y Y documents appended to the current workflow instance
          transitions
String Y Y
          startDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          dueDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          endDate
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

Method #9: getHistories

gets the histories of a workflow instance

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     instanceId
String Y identifier of the workflow instance
     event
String optional filter on a specific event type

Response

Name Type Required Multiple Description
     histories
WSWorkflowHistory Y Y
          id
Long Y
          docId
Long document identifier
          folderId
Long Y
          userId
Long Y
          path
String Y
          date
String Y format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          username
String Y
          event
String Y
          comment
String Y
          version
String Y
          sessionId
String Y
          filename
String Y
          templateId
Long Y
          instanceId
String Y
          taskname
String Y
          taskDisplay
String Y
          transition
String Y
          taskId
String Y
          templateVersion
Integer Y

Method #10: appendDocuments

appends new documents to the workflow

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     taskId
String Y identifier of the task
     docIds
Long Y Y identifiers of the documents to append

Method #11: startWorkflow

launches a new workflow instance

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     workflow
String Y name of the workflow
     tag
String a tag you can assign to the new instance
     color
String a color you can assign to the new instance
     docIds
Long Y the documents to be appended to the workflow

Response

Name Type Required Multiple Description
     instanceId
String Y