rest api

[pirtwo]

Hi @rsoika , I have some questions about using rest API to be sure I am doing things in a correct way. I want to build custom user interface on top of imixs-microservice. The simple scenario is like this:

1. showing startable processes
2. showing tasks assigned to current user
3. showing events attached to task to user as available actions
4. showing all tasks (for admin)
5. showing all ongoing processes
6. showing all completed processes

I am calling /api/model to get the list of processes to show for user as an option to create a new instance of process. For creating new instance I need modelversion, processid, activityid. So I can get modelversion from this call but how can I get the other two required parameters?

Regards

[rsoika]

HI @pirtwo , introducing the new Open-BPMN API the Imixs Rest API missed some of the methods you are searching for.
So normally you would start a new Task with giving the version and inital TaskID.
But with the latest release you can also ask for all so called "Start Tasks"

/model/{version}/groups/{group}/start

which will return usually the Start Task for given process (group) in your model (connected to start event)

The other use cases are covered by the Rest API:

• /workflow/tasklist/owner/{owner} - shows all tasks assigned to a user (where 'null' opens the task list for the current user)
• /workitem/events/{uniqueid} - shows all events available for a given process instance
• /workflow/tasklist/group/{processgroup} - all tasks assigned to a given group

You can also use the search API to search specific data from your application/workflow logic.

For example search all completed workitems in 2024

/api/documents/search/type:"workitemarchive" AND $lasteventdate:[20240101 TO 20241231]

Find details here: https://www.imixs.org/doc/engine/queries.html

In general a good practice is to assign you workitems to logical application specific categories. For example you can define departments in your application like a 'Sale Department' or the 'Marketing Department'. Create these departments by a small org-unit model.

Now you can assign your workitem to a department by using the item $uniqueidref. This is one of the workflow engine internal items. You can later search all workitems assigned to a specify department by using the departments $uniqueid

/workflow/tasklist/ref/{uniqueid}

or you can search again with the search API

/api/documents/search/type:"workitem" AND $uniqueidref:xxxxxxx-xxxxxxxxxx-xxxx

Feel free to ask if you have further question.

===
Ralph

[pirtwo]

Thank you @rsoika for your detailed answer. I wonder is the /model/{version}/groups/{group}/start endpoint is available now or it will be available in feature releases? I am asking because it doesn't exists in latest docker imixs-microservice image.

[rsoika]

It should be included already in the latest Docker Image imixs/imixs-microservice:latest
We are currently in a release phase. But the docker image provides this feature already.

[rsoika]

You can also try

docker compose pull

to force the pull of the latest image

[pirtwo]

I will do that and report back the result in here. Thanks