Hi, I'm interested in this topic and would like to take the opportunity to describe my use case.
If we manage to move to OpenProject, we'll need to integrate it with a resource planning / scheduling tool that centralizes all the "people" management — i.e. leave management, assignments to projects (which would be managed in OpenProject, or in other tools), assignments to maintenance, to training, and so on.
In other words, we're talking about a separate tool that would, at a minimum, need to know what is planned in OpenProject (who is assigned to what, over which period), and — ideally — be able to return to OpenProject the actual availability of a resource for a given project.
So, to pick up on the original question: is there an endpoint to read the items managed by the Resource Manager module? And if such an endpoint exists (or is planned), could it also be used to write availability / workload data back into OpenProject?
Follow-up (first step, since I'm not yet familiar with the tool)
To get started, I asked an AI assistant to look into this. Here is what it found. Please treat it as unverified, and correct me where I'm wrong.
The Resource management module was introduced with OpenProject 17.7, as an Enterprise add-on.
In the official API documentation I could not find any dedicated endpoint for it. The documented APIs are API v3, SCIM, MCP and BCF. That doesn't prove nothing exists (the UI must rely on some routes), but nothing documented or guaranteed stable seems to be available.
What can already be used: API v3 for work packages, projects and users (so "who is assigned to what, over which period" can be read from assignee, dates and estimated work), and webhooks to notify an external tool when something changes.
Possibly useful: 17.7 also introduced per-user work schedule and availability factor. I haven't checked whether these are exposed through the API v3 user resource.
My open questions to the team and the community:
Is there (or is there a plan for) a documented endpoint to read resource planner items, requests and allocations?
Can availability / workload data be written back through the API, or is it read-only by design?
Has anyone already integrated OpenProject with an external resource planning tool, and how?
Replies (2)
Hi, I'm interested in this topic and would like to take the opportunity to describe my use case.
If we manage to move to OpenProject, we'll need to integrate it with a resource planning / scheduling tool that centralizes all the "people" management — i.e. leave management, assignments to projects (which would be managed in OpenProject, or in other tools), assignments to maintenance, to training, and so on.
In other words, we're talking about a separate tool that would, at a minimum, need to know what is planned in OpenProject (who is assigned to what, over which period), and — ideally — be able to return to OpenProject the actual availability of a resource for a given project.
So, to pick up on the original question: is there an endpoint to read the items managed by the Resource Manager module? And if such an endpoint exists (or is planned), could it also be used to write availability / workload data back into OpenProject?
Follow-up (first step, since I'm not yet familiar with the tool)
To get started, I asked an AI assistant to look into this. Here is what it found. Please treat it as unverified, and correct me where I'm wrong.
The Resource management module was introduced with OpenProject 17.7, as an Enterprise add-on.
In the official API documentation I could not find any dedicated endpoint for it. The documented APIs are API v3, SCIM, MCP and BCF. That doesn't prove nothing exists (the UI must rely on some routes), but nothing documented or guaranteed stable seems to be available.
What can already be used: API v3 for work packages, projects and users (so "who is assigned to what, over which period" can be read from assignee, dates and estimated work), and webhooks to notify an external tool when something changes.
Possibly useful: 17.7 also introduced per-user work schedule and availability factor. I haven't checked whether these are exposed through the API v3 user resource.
My open questions to the team and the community:
Is there (or is there a plan for) a documented endpoint to read resource planner items, requests and allocations?
Can availability / workload data be written back through the API, or is it read-only by design?
Has anyone already integrated OpenProject with an external resource planning tool, and how?
Thanks!
References consulted
Resource management use case: https://www.openproject.org/docs/use-cases/resource-management/
OpenProject 17.7.0 release notes (introduces the Resource management module, work schedule and availability factor): https://github.com/opf/openproject/releases/tag/v17.7.0
API overview (API v3, SCIM, MCP, BCF, .well-known): https://www.openproject.org/docs/api/
API v3 introduction (authentication, OpenAPI spec at
/api/v3/spec.json): https://www.openproject.org/de/docs/api/introduction/API root resource: https://www.openproject.org/docs/api/endpoints/root/
API and webhooks (admin guide): https://www.openproject.org/docs/system-admin-guide/api-and-webhooks