All API-methods
In this section, we present all API-methods:
API-method | Use Case | Description | Parameters, body |
---|---|---|---|
post/identity/login | As a user I want to login, so I can use the API-methods | Login, responds X-AUTH-Qollabor | username, password; authentication not needed of course |
get/repository/list | As a user I want a list of available cases, so I can start an case instance | Retrieve a list of deployed models | |
post/cases | As a user I want to start a case instance of a specific definition, so we can start working on it | Start a case instance | The case model, Input parameter (a CFI) |
post/cases/ {caseinstanceID}/ caseteam | A a case manager, I want to set a specific team, so only these people can work on it and see it | Sets a new caseteam. You can also update and delete team members, using put and delete | caseteam |
get/cases/user | As a user, I want to see the cases • if I am in team, • if a task in it assigned to me, • if no team is set and I fulfill user role according to case model | Get a list of current user cases | case model definition, state |
get/cases/ {caseinstanceID} | As a user, I want to have a overview of whole case instance | Get a case instance | case model definition, state |
get/cases/ {caseinstanceID}/ planitems | As a user, I want a list of tasks in a case instance and their “state” | Get the planitems for a case instance | plan item type, state |
get/cases/ {caseinstanceID}/ discretionaryItems | As a user, I want a list of tasks that are at my discretion | Get the currently applicable discretionary items | |
post/cases/ {caseinstanceID}/ discretionaryitems/ plan | As a user, I want to plan a task that is at my discretion | Plan a discretionary item | name, planitemID, parentID |
get/cases/ {caseinstanceID}/ planitems/ {planitemID} | As a task assignee, I want to see all info on a task | Get one planitem for a case instance. | |
get/tasks/{taskID} | As a task assignee, I want to see all info on a task | Get one task. | |
put/task/{taskId}/ {action} | As a case worker, I want to claim (revoke, delegate, assign) a planned task | Perform a task action (claim, assign) | assignee |
post/task/{taskId}/ {transition} | As a case worker, I want to complete (suspend, terminate) a task that is assigned to me | Apply a transition on a task (complete, suspend) | |
get/cases/{case instanceID}/ casefile | As a case worker I want to see the information (items) in the casefile | Get the case file | case file item, notBefore_lastModified_date |
post/cases/{case instanceID}/ casefile/create/ {path} | As a user, I want outside the context of a task, to update the case file | Creates a case file item. There are also methods to update, replace or delete a CFI | JSON of the case file item |
post/cases/{case instanceID}/ planitem/ {planitemID}/ {transition} | As a case manager, I want to change the status of a Case instance | Apply a transition to a plan item | none |
get/users | As a case worker, I want to have an overview of the case team | Get a list of users | |
post/users | Use Case | As a sys admin, I want to control users of Qollabor | a json structure |
get/tasks | As a user, I want an overview of all tasks in any case instance I am assigned to | get a list of task (for one user in X-AUTH) | caseinstance, casedefinition, assignee, state, owner |
get/tasks/ user/count | As a case manager, I want some stats | get number of tasks (for one user in X-AUTH) | |
get/cases/stats | As a case manager, I want some stats | get number of tasks (for one user in X-AUTH) | definition, state |