Resource Planning
71 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1
List budget cost categories#
/resource-planning/budget-categoriesTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
include_inactivePflicht | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a budget cost category#
/resource-planning/budget-categoriesTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
codePflicht | string | – |
labelPflicht | string | – |
cost_group | string | Werte: |
sort_order | number | |
color | object | – |
is_active | boolean |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"…","label":"…"}'Update a budget cost category#
/resource-planning/budget-categories/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
code | string | – |
label | string | – |
cost_group | string | Werte: |
sort_order | number | |
color | object | – |
is_active | boolean |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"…","label":"…","cost_group":"RC"}'Deactivate a budget cost category#
/resource-planning/budget-categories/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Seed the default RC/NRC cost category set#
/resource-planning/budget-categories/seed-defaultsTokenAntworten
- 200OK
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories/seed-defaults" \
-H "Authorization: Bearer $XISUITE_TOKEN"List plan or task resource budget entries#
/resource-planning/budget-entriesTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
from | Query | string | – |
to | Query | string | – |
plan_id | Query | string | – |
task_id | Query | string | – |
space_id | Query | string | – |
entry_type | Query | string | Werte: |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-entries" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a plan or task resource budget entry#
/resource-planning/budget-entriesTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
plan_id | object | – |
task_id | object | – |
entry_typePflicht | string | Werte: |
namePflicht | string | – |
category | object | – |
quantity | number | |
unit_cost | number | |
currencyPflicht | string | Werte: |
effective_datePflicht | string (date) | – |
notes | object | – |
cost_category_id | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
aggregation | string | Werte: |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-entries" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"entry_type":"planned","name":"…","currency":"USD","effective_date":"…"}'Update a resource budget entry#
/resource-planning/budget-entries/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
entry_type | string | Werte: |
name | string | – |
category | object | – |
quantity | number | |
unit_cost | number | |
currency | string | Werte: |
effective_date | string (date) | – |
notes | object | – |
cost_category_id | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
aggregation | string | Werte: |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-entries/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"entry_type":"planned","name":"…","category":{}}'Delete a resource budget entry#
/resource-planning/budget-entries/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-entries/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Assign part of an overall budget to a task#
/resource-planning/budget-splitsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
overall_budget_idPflicht | string (uuid) | – |
task_idPflicht | string (uuid) | – |
amountPflicht | number | – |
note | object | – |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-splits" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"overall_budget_id":"…","task_id":"…","amount":0}'Update a budget split#
/resource-planning/budget-splits/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Budget split ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
amount | number | – |
note | object | – |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-splits/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"amount":0,"note":{}}'Delete a budget split#
/resource-planning/budget-splits/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Budget split ID |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-splits/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"People planned per month on the Ressource Tree timeline#
/resource-planning/budget-timeline/peopleTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
depth | Query | number | – |
space_id | Query | string (uuid) | – |
from | Query | string | – |
to | Query | string | – |
tz | Query | string | – |
task_idsPflicht | Query | string[] | Comma-separated root task ids of the Ressource Tree selection |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-timeline/people" \
-H "Authorization: Bearer $XISUITE_TOKEN"List employee capacity records for the organization#
/resource-planning/capacityTokenAntworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity" \
-H "Authorization: Bearer $XISUITE_TOKEN"List effective-dated capacity and cost periods#
/resource-planning/capacity-periodsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
from | Query | string | – |
to | Query | string | – |
user_id | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity-periods" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create an effective-dated capacity period#
/resource-planning/capacity-periodsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
user_idPflicht | string | – |
effective_fromPflicht | string (date) | – |
effective_to | object (date) | – |
weekly_capacity_hoursPflicht | number | – |
cost_rate | object | – |
currency | string | Werte: |
is_active | boolean |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity-periods" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_id":"…","effective_from":"…","weekly_capacity_hours":0}'Update an effective-dated capacity period#
/resource-planning/capacity-periods/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
user_id | string | – |
effective_from | string (date) | – |
effective_to | object (date) | – |
weekly_capacity_hours | number | – |
cost_rate | object | – |
currency | string | Werte: |
is_active | boolean |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity-periods/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_id":"…","effective_from":"…","effective_to":"…"}'Delete an effective-dated capacity period#
/resource-planning/capacity-periods/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity-periods/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Upsert employee capacity for a specific user#
/resource-planning/capacity/{userId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
userIdPflicht | Pfad | string | Target user ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
weekly_capacity_hoursPflicht | number | Weekly capacity hours for the employee |
cost_rate | object | Cost rate per hour (optional) |
currency | string | Currency code (ISO 4217); required when cost_rate is set Werte: |
is_active | boolean | Whether this capacity record is active |
Antworten
- 200OK
curl -X PUT "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity/{userId}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"weekly_capacity_hours":0}'Bulk update or reset employee capacity#
/resource-planning/capacity/bulkTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
actionPflicht | string | Werte: |
user_idsPflicht | string[] | – |
changes | BulkCapacityChangesDto | Required for 'update', must be omitted for 'reset' |
Antworten
- 200OK
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity/bulk" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"action":"update","user_ids":[]}'List holiday scheme days#
/resource-planning/holiday-scheme-daysTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
scheme_idPflicht | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-days" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a holiday scheme day#
/resource-planning/holiday-scheme-daysTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
scheme_idPflicht | string | – |
namePflicht | string | – |
description | object | – |
recurrencePflicht | string | Werte: |
month | number | – |
day | number | – |
holiday_date | string (date) | – |
duration_days | number |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-days" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"scheme_id":"…","name":"…","recurrence":"fixed_annual"}'Update a holiday scheme day#
/resource-planning/holiday-scheme-days/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
scheme_id | string | – |
name | string | – |
description | object | – |
recurrence | string | Werte: |
month | number | – |
day | number | – |
holiday_date | string (date) | – |
duration_days | number |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-days/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"scheme_id":"…","name":"…","description":{}}'Delete a holiday scheme day#
/resource-planning/holiday-scheme-days/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-days/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List holiday scheme member assignments#
/resource-planning/holiday-scheme-membersTokenAntworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-members" \
-H "Authorization: Bearer $XISUITE_TOKEN"Assign a user to a holiday scheme#
/resource-planning/holiday-scheme-membersTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
scheme_idPflicht | string | – |
user_idPflicht | string | – |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-members" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"scheme_id":"…","user_id":"…"}'Remove a holiday scheme member assignment#
/resource-planning/holiday-scheme-members/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-members/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List holiday schemes#
/resource-planning/holiday-schemesTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
include_inactivePflicht | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a holiday scheme#
/resource-planning/holiday-schemesTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
namePflicht | string | – |
description | object | – |
is_default | boolean | |
is_active | boolean |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'Update a holiday scheme#
/resource-planning/holiday-schemes/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
name | string | – |
description | object | – |
is_default | boolean | |
is_active | boolean |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","description":{},"is_default":true}'Deactivate a holiday scheme#
/resource-planning/holiday-schemes/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Update an overall budget#
/resource-planning/overall-budgets/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Overall budget ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
name | string | – |
amount | number | – |
currency | string | Werte: |
source | string | Werte: |
financial_year | object | |
responsible_user_id | object (uuid) | – |
cost_category_id | object (uuid) | – |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/overall-budgets/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","amount":0,"currency":"USD"}'Delete an overall budget#
/resource-planning/overall-budgets/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Overall budget ID |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/overall-budgets/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Update a plan resource allocation#
/resource-planning/plan-allocations/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Plan allocation ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
planned_hours | number | Planned hours for this allocation |
planned_budget | number | Planned budget for this allocation |
allocation_mode | string | Werte: |
weekly_hours | object | – |
capacity_percent | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
role | object | Role label for this allocation |
notes | object | Notes for this allocation |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/plan-allocations/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"planned_hours":0,"planned_budget":0,"allocation_mode":"total_hours"}'Delete a plan resource allocation#
/resource-planning/plan-allocations/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Plan allocation ID |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/plan-allocations/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List resource allocations for a plan#
/resource-planning/plans/{planId}/allocationsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
planIdPflicht | Pfad | string | Plan ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/plans/{planId}/allocations" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a resource allocation for a plan#
/resource-planning/plans/{planId}/allocationsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
planIdPflicht | Pfad | string | Plan ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
user_idPflicht | string | User to allocate to this plan |
planned_hours | number | Planned hours for this allocation |
planned_budget | number | Planned budget for this allocation |
allocation_mode | string | Werte: |
weekly_hours | object | – |
capacity_percent | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
role | object | Role label for this allocation |
notes | object | Notes for this allocation |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/plans/{planId}/allocations" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_id":"…"}'Get resource summary for a plan#
/resource-planning/plans/{planId}/summaryTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
planIdPflicht | Pfad | string | Plan ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/plans/{planId}/summary" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get resource summary for a portfolio (rolled up across plans)#
/resource-planning/portfolios/{portfolioId}/summaryTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
portfolioIdPflicht | Pfad | string | Portfolio ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/portfolios/{portfolioId}/summary" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get planned-versus-actual resource reporting#
/resource-planning/reportsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
from | Query | string (date) | Inclusive UTC start date |
to | Query | string (date) | Inclusive UTC end date |
bucket | Query | string | Werte: |
group_by | Query | string | Werte: |
group_id | Query | string (uuid) | Selected group filter |
portfolio_id | Query | string (uuid) | Restrict the report to the plans of this portfolio |
space_id | Query | string (uuid) | Restrict the report to one space (403 when Resource Planning is not available there) |
include_archived | Query | boolean | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/reports" \
-H "Authorization: Bearer $XISUITE_TOKEN"Export the resource planning report as CSV or PDF#
/resource-planning/reports/exportTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
from | Query | string (date) | Inclusive UTC start date |
to | Query | string (date) | Inclusive UTC end date |
bucket | Query | string | Werte: |
group_by | Query | string | Werte: |
group_id | Query | string (uuid) | Selected group filter |
portfolio_id | Query | string (uuid) | Restrict the report to the plans of this portfolio |
space_id | Query | string (uuid) | Restrict the report to one space (403 when Resource Planning is not available there) |
include_archived | Query | boolean | – |
format | Query | string | Werte: |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/reports/export" \
-H "Authorization: Bearer $XISUITE_TOKEN"List the planning roster for the organization#
/resource-planning/rosterTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
search | Query | string | Matches name or email |
page | Query | number | – |
limit | Query | number | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/roster" \
-H "Authorization: Bearer $XISUITE_TOKEN"Remove an employee from the planning roster#
/resource-planning/roster/{userId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
userIdPflicht | Pfad | string | Target user ID |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/roster/{userId}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Add a user group's members to the planning roster#
/resource-planning/roster/groupsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
group_idPflicht | string (uuid) | – |
Antworten
- 200OK
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/roster/groups" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"group_id":"…"}'Add employees to the planning roster#
/resource-planning/roster/usersTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
user_idsPflicht | string (uuid)[] | – |
Antworten
- 200OK
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/roster/users" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_ids":[]}'Per-user-per-day/week capacity and dated assignments#
/resource-planning/scheduleTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
fromPflicht | Query | string (date) | Inclusive UTC start date |
toPflicht | Query | string (date) | Inclusive UTC end date |
granularity | Query | string | Werte: |
unit_ids | Query | string[] | Comma-separated organization_unit ids |
user_ids | Query | string[] | Comma-separated user ids |
portfolio_id | Query | string (uuid) | Restrict to people working on this portfolio. Resolved to the portfolio's non-archived plans, then to everyone allocated to those plans or their tasks. |
space_id | Query | string (uuid) | Restrict to one space: only people with a plan or task allocation there, and only those assignments. 403 when Resource Planning is not available in that space. |
plan_ids | Query | string[] | Comma-separated plan ids. Combined with portfolio_id it narrows further (intersection), it does not widen. |
roles | Query | string[] | Comma-separated role labels (free-text, not a lookup table) |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/schedule" \
-H "Authorization: Bearer $XISUITE_TOKEN"Distinct role labels in use across plan/task allocations#
/resource-planning/schedule/rolesTokenAntworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/schedule/roles" \
-H "Authorization: Bearer $XISUITE_TOKEN"List a space's overall budgets#
/resource-planning/spaces/{spaceId}/overall-budgetsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
spaceIdPflicht | Pfad | string | Space ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/spaces/{spaceId}/overall-budgets" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create an overall budget in a space#
/resource-planning/spaces/{spaceId}/overall-budgetsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
spaceIdPflicht | Pfad | string | Space ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
namePflicht | string | – |
amountPflicht | number | – |
currencyPflicht | string | Werte: |
source | string | Werte: |
financial_year | object | |
responsible_user_id | object (uuid) | – |
cost_category_id | object (uuid) | – |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/spaces/{spaceId}/overall-budgets" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","amount":0,"currency":"USD"}'Update a task resource allocation#
/resource-planning/task-allocations/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Task allocation ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
planned_hours | number | Planned hours for this allocation |
allocation_mode | string | Werte: |
weekly_hours | object | – |
capacity_percent | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
role | object | Role label for this allocation |
notes | object | Notes for this allocation |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/task-allocations/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"planned_hours":0,"allocation_mode":"total_hours","weekly_hours":{}}'Delete a task resource allocation#
/resource-planning/task-allocations/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | Task allocation ID |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/task-allocations/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List resource allocations for a task#
/resource-planning/tasks/{taskId}/allocationsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
taskIdPflicht | Pfad | string | Task ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/allocations" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a resource allocation for a task#
/resource-planning/tasks/{taskId}/allocationsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
taskIdPflicht | Pfad | string | Task ID |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
user_idPflicht | string | User to allocate to this task |
planned_hours | number | Planned hours for this allocation (total_hours mode only) |
allocation_mode | string | Werte: |
weekly_hours | object | – |
capacity_percent | object | – |
start_date | object (date) | – |
end_date | object (date) | – |
role | object | Role label for this allocation |
notes | object | Notes for this allocation |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/allocations" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_id":"…"}'Get the month timeline (bars, planned budget and hours per month) for a task tree#
/resource-planning/tasks/{taskId}/budget-timelineTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
taskIdPflicht | Pfad | string | – |
depth | Query | number | – |
space_id | Query | string (uuid) | – |
from | Query | string | – |
to | Query | string | – |
tz | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/budget-timeline" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get the budget rollup tree for a task#
/resource-planning/tasks/{taskId}/budget-treeTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
taskIdPflicht | Pfad | string | – |
depth | Query | number | – |
direction | Query | string | Werte: |
space_id | Query | string (uuid) | – |
include_dependencies | Query | boolean | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/budget-tree" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get resource rollup for a task (own + cumulative via descendants)#
/resource-planning/tasks/{taskId}/rollupTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
taskIdPflicht | Pfad | string | Task ID |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/rollup" \
-H "Authorization: Bearer $XISUITE_TOKEN"List effective-dated unit memberships#
/resource-planning/unit-membershipsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
from | Query | string | – |
to | Query | string | – |
unit_id | Query | string | – |
user_id | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create an effective-dated unit membership#
/resource-planning/unit-membershipsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
unit_idPflicht | string | – |
user_idPflicht | string | – |
effective_fromPflicht | string (date) | – |
effective_to | object (date) | – |
allocation_percent | object | – |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"unit_id":"…","user_id":"…","effective_from":"…"}'Update an effective-dated unit membership#
/resource-planning/unit-memberships/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
unit_id | string | – |
user_id | string | – |
effective_from | string (date) | – |
effective_to | object (date) | – |
allocation_percent | object | – |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"unit_id":"…","user_id":"…","effective_from":"…"}'Delete an effective-dated unit membership#
/resource-planning/unit-memberships/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List organization resource-planning units#
/resource-planning/unitsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
include_inactivePflicht | Query | string | – |
include_archivedPflicht | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/units" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create an organization resource-planning unit#
/resource-planning/unitsTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
namePflicht | string | – |
unit_type | string | Werte: |
parent_id | object | – |
description | object | – |
color | object | – |
sort_order | number | |
is_active | boolean |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/units" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'Update an organization resource-planning unit#
/resource-planning/units/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
name | string | – |
unit_type | string | Werte: |
parent_id | object | – |
description | object | – |
color | object | – |
sort_order | number | |
is_active | boolean |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/units/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","unit_type":"unit","parent_id":{}}'Archive an organization resource-planning unit#
/resource-planning/units/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/units/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List workload scheme member assignments#
/resource-planning/workload-scheme-membersTokenAntworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-scheme-members" \
-H "Authorization: Bearer $XISUITE_TOKEN"Assign a user to a workload scheme#
/resource-planning/workload-scheme-membersTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
scheme_idPflicht | string | – |
user_idPflicht | string | – |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-scheme-members" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"scheme_id":"…","user_id":"…"}'Remove a workload scheme member assignment#
/resource-planning/workload-scheme-members/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-scheme-members/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"List workload schemes#
/resource-planning/workload-schemesTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
include_inactivePflicht | Query | string | – |
Antworten
- 200OK
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes" \
-H "Authorization: Bearer $XISUITE_TOKEN"Create a workload scheme#
/resource-planning/workload-schemesTokenRequest-Body
| Name | Typ | Beschreibung |
|---|---|---|
namePflicht | string | – |
description | object | – |
monday_hours | number | |
tuesday_hours | number | |
wednesday_hours | number | |
thursday_hours | number | |
friday_hours | number | |
saturday_hours | number | |
sunday_hours | number | |
is_default | boolean | |
is_active | boolean |
Antworten
- 201Erstellt
curl -X POST "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…"}'Update a workload scheme#
/resource-planning/workload-schemes/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
name | string | – |
description | object | – |
monday_hours | number | |
tuesday_hours | number | |
wednesday_hours | number | |
thursday_hours | number | |
friday_hours | number | |
saturday_hours | number | |
sunday_hours | number | |
is_default | boolean | |
is_active | boolean |
Antworten
- 200OK
curl -X PATCH "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"…","description":{},"monday_hours":0}'Deactivate a workload scheme#
/resource-planning/workload-schemes/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200OK
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"