XISUITEDokumentation

Resource Planning

71 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List budget cost categories#

GET/resource-planning/budget-categoriesToken

Parameter

NameOrtTypBeschreibung
include_inactivePflichtQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/budget-categories" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a budget cost category#

POST/resource-planning/budget-categoriesToken

Request-Bodyapplication/jsonCreateBudgetCostCategoryDto

NameTypBeschreibung
codePflichtstring–
labelPflichtstring–
cost_groupstring

Werte: RCNRCOTHER

Standard: "OTHER"

sort_ordernumber

Standard: 0

colorobject–
is_activeboolean

Standard: true

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/budget-categories/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateBudgetCostCategoryDto

NameTypBeschreibung
codestring–
labelstring–
cost_groupstring

Werte: RCNRCOTHER

Standard: "OTHER"

sort_ordernumber

Standard: 0

colorobject–
is_activeboolean

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/budget-categories/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/budget-categories/seed-defaultsToken

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/budget-entriesToken

Parameter

NameOrtTypBeschreibung
fromQuerystring–
toQuerystring–
plan_idQuerystring–
task_idQuerystring–
space_idQuerystring–
entry_typeQuerystring

Werte: plannedactual

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/budget-entriesToken

Request-Bodyapplication/jsonCreateBudgetEntryDto

NameTypBeschreibung
plan_idobject–
task_idobject–
entry_typePflichtstring

Werte: plannedactual

namePflichtstring–
categoryobject–
quantitynumber

Standard: 1

unit_costnumber

Standard: 0

currencyPflichtstring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

effective_datePflichtstring (date)–
notesobject–
cost_category_idobject–
start_dateobject (date)–
end_dateobject (date)–
aggregationstring

Werte: manualrollup_sumrollup_avgrollup_max

Standard: "manual"

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/budget-entries/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateBudgetEntryDto

NameTypBeschreibung
entry_typestring

Werte: plannedactual

namestring–
categoryobject–
quantitynumber

Standard: 1

unit_costnumber

Standard: 0

currencystring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

effective_datestring (date)–
notesobject–
cost_category_idobject–
start_dateobject (date)–
end_dateobject (date)–
aggregationstring

Werte: manualrollup_sumrollup_avgrollup_max

Standard: "manual"

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/budget-entries/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/budget-splitsToken

Request-Bodyapplication/jsonCreateBudgetSplitDto

NameTypBeschreibung
overall_budget_idPflichtstring (uuid)–
task_idPflichtstring (uuid)–
amountPflichtnumber–
noteobject–

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/budget-splits/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Budget split ID

Request-Bodyapplication/jsonUpdateBudgetSplitDto

NameTypBeschreibung
amountnumber–
noteobject–

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/budget-splits/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Budget split ID

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/budget-timeline/peopleToken

Parameter

NameOrtTypBeschreibung
depthQuerynumber–
space_idQuerystring (uuid)–
fromQuerystring–
toQuerystring–
tzQuerystring–
task_idsPflichtQuerystring[]

Comma-separated root task ids of the Ressource Tree selection

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/capacityToken

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List effective-dated capacity and cost periods#

GET/resource-planning/capacity-periodsToken

Parameter

NameOrtTypBeschreibung
fromQuerystring–
toQuerystring–
user_idQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/capacity-periods" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create an effective-dated capacity period#

POST/resource-planning/capacity-periodsToken

Request-Bodyapplication/jsonCreateCapacityPeriodDto

NameTypBeschreibung
user_idPflichtstring–
effective_fromPflichtstring (date)–
effective_toobject (date)–
weekly_capacity_hoursPflichtnumber–
cost_rateobject–
currencystring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

is_activeboolean

Standard: true

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/capacity-periods/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateCapacityPeriodDto

NameTypBeschreibung
user_idstring–
effective_fromstring (date)–
effective_toobject (date)–
weekly_capacity_hoursnumber–
cost_rateobject–
currencystring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

is_activeboolean

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/capacity-periods/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
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#

PUT/resource-planning/capacity/{userId}Token

Parameter

NameOrtTypBeschreibung
userIdPflichtPfadstring

Target user ID

Request-Bodyapplication/jsonUpsertCapacityDto

NameTypBeschreibung
weekly_capacity_hoursPflichtnumber

Weekly capacity hours for the employee

cost_rateobject

Cost rate per hour (optional)

currencystring

Currency code (ISO 4217); required when cost_rate is set

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

is_activeboolean

Whether this capacity record is active

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/capacity/bulkToken

Request-Bodyapplication/jsonBulkUpdateCapacityDto

NameTypBeschreibung
actionPflichtstring

Werte: updatereset

user_idsPflichtstring[]–
changesBulkCapacityChangesDto

Required for 'update', must be omitted for 'reset'

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/holiday-scheme-daysToken

Parameter

NameOrtTypBeschreibung
scheme_idPflichtQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-days" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a holiday scheme day#

POST/resource-planning/holiday-scheme-daysToken

Request-Bodyapplication/jsonCreateHolidaySchemeDayDto

NameTypBeschreibung
scheme_idPflichtstring–
namePflichtstring–
descriptionobject–
recurrencePflichtstring

Werte: fixed_annualone_off

monthnumber–
daynumber–
holiday_datestring (date)–
duration_daysnumber

Standard: 1

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/holiday-scheme-days/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateHolidaySchemeDayDto

NameTypBeschreibung
scheme_idstring–
namestring–
descriptionobject–
recurrencestring

Werte: fixed_annualone_off

monthnumber–
daynumber–
holiday_datestring (date)–
duration_daysnumber

Standard: 1

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/holiday-scheme-days/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/holiday-scheme-membersToken

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/holiday-scheme-membersToken

Request-Bodyapplication/jsonAssignHolidaySchemeMemberDto

NameTypBeschreibung
scheme_idPflichtstring–
user_idPflichtstring–

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

DELETE/resource-planning/holiday-scheme-members/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-scheme-members/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List holiday schemes#

GET/resource-planning/holiday-schemesToken

Parameter

NameOrtTypBeschreibung
include_inactivePflichtQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a holiday scheme#

POST/resource-planning/holiday-schemesToken

Request-Bodyapplication/jsonCreateHolidaySchemeDto

NameTypBeschreibung
namePflichtstring–
descriptionobject–
is_defaultboolean

Standard: false

is_activeboolean

Standard: true

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/holiday-schemes/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateHolidaySchemeDto

NameTypBeschreibung
namestring–
descriptionobject–
is_defaultboolean

Standard: false

is_activeboolean

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/holiday-schemes/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/holiday-schemes/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update an overall budget#

PATCH/resource-planning/overall-budgets/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Overall budget ID

Request-Bodyapplication/jsonUpdateOverallBudgetDto

NameTypBeschreibung
namestring–
amountnumber–
currencystring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

sourcestring

Werte: internalcustomergrantpartnerinvestorloanother

financial_yearobject

Beispiel: 2026/27

responsible_user_idobject (uuid)–
cost_category_idobject (uuid)–

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/overall-budgets/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Overall budget ID

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/overall-budgets/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a plan resource allocation#

PATCH/resource-planning/plan-allocations/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Plan allocation ID

Request-Bodyapplication/jsonUpdatePlanAllocationDto

NameTypBeschreibung
planned_hoursnumber

Planned hours for this allocation

planned_budgetnumber

Planned budget for this allocation

allocation_modestring

Werte: total_hourshours_per_weekcapacity_percent

weekly_hoursobject–
capacity_percentobject–
start_dateobject (date)–
end_dateobject (date)–
roleobject

Role label for this allocation

notesobject

Notes for this allocation

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/plan-allocations/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Plan allocation ID

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/plans/{planId}/allocationsToken

Parameter

NameOrtTypBeschreibung
planIdPflichtPfadstring

Plan ID

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/plans/{planId}/allocationsToken

Parameter

NameOrtTypBeschreibung
planIdPflichtPfadstring

Plan ID

Request-Bodyapplication/jsonCreatePlanAllocationDto

NameTypBeschreibung
user_idPflichtstring

User to allocate to this plan

planned_hoursnumber

Planned hours for this allocation

Standard: 0

planned_budgetnumber

Planned budget for this allocation

Standard: 0

allocation_modestring

Werte: total_hourshours_per_weekcapacity_percent

Standard: "total_hours"

weekly_hoursobject–
capacity_percentobject–
start_dateobject (date)–
end_dateobject (date)–
roleobject

Role label for this allocation

notesobject

Notes for this allocation

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

GET/resource-planning/plans/{planId}/summaryToken

Parameter

NameOrtTypBeschreibung
planIdPflichtPfadstring

Plan ID

Antworten

  • 200OK
Beispiel (cURL)
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)#

GET/resource-planning/portfolios/{portfolioId}/summaryToken

Parameter

NameOrtTypBeschreibung
portfolioIdPflichtPfadstring

Portfolio ID

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/reportsToken

Parameter

NameOrtTypBeschreibung
fromQuerystring (date)

Inclusive UTC start date

toQuerystring (date)

Inclusive UTC end date

bucketQuerystring

Werte: dayweekmonth

group_byQuerystring

Werte: userunitplanportfolio

group_idQuerystring (uuid)

Selected group filter

portfolio_idQuerystring (uuid)

Restrict the report to the plans of this portfolio

space_idQuerystring (uuid)

Restrict the report to one space (403 when Resource Planning is not available there)

include_archivedQueryboolean–

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/reports/exportToken

Parameter

NameOrtTypBeschreibung
fromQuerystring (date)

Inclusive UTC start date

toQuerystring (date)

Inclusive UTC end date

bucketQuerystring

Werte: dayweekmonth

group_byQuerystring

Werte: userunitplanportfolio

group_idQuerystring (uuid)

Selected group filter

portfolio_idQuerystring (uuid)

Restrict the report to the plans of this portfolio

space_idQuerystring (uuid)

Restrict the report to one space (403 when Resource Planning is not available there)

include_archivedQueryboolean–
formatQuerystring

Werte: csvpdf

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/rosterToken

Parameter

NameOrtTypBeschreibung
searchQuerystring

Matches name or email

pageQuerynumber–
limitQuerynumber–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/roster" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Remove an employee from the planning roster#

DELETE/resource-planning/roster/{userId}Token

Parameter

NameOrtTypBeschreibung
userIdPflichtPfadstring

Target user ID

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/roster/groupsToken

Request-Bodyapplication/jsonAddPlanningRosterGroupDto

NameTypBeschreibung
group_idPflichtstring (uuid)–

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/roster/usersToken

Request-Bodyapplication/jsonAddPlanningRosterUsersDto

NameTypBeschreibung
user_idsPflichtstring (uuid)[]–

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/scheduleToken

Parameter

NameOrtTypBeschreibung
fromPflichtQuerystring (date)

Inclusive UTC start date

toPflichtQuerystring (date)

Inclusive UTC end date

granularityQuerystring

Werte: dayweekmonth

unit_idsQuerystring[]

Comma-separated organization_unit ids

user_idsQuerystring[]

Comma-separated user ids

portfolio_idQuerystring (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_idQuerystring (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_idsQuerystring[]

Comma-separated plan ids. Combined with portfolio_id it narrows further (intersection), it does not widen.

rolesQuerystring[]

Comma-separated role labels (free-text, not a lookup table)

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/schedule/rolesToken

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/schedule/roles" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List a space's overall budgets#

GET/resource-planning/spaces/{spaceId}/overall-budgetsToken

Parameter

NameOrtTypBeschreibung
spaceIdPflichtPfadstring

Space ID

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/spaces/{spaceId}/overall-budgetsToken

Parameter

NameOrtTypBeschreibung
spaceIdPflichtPfadstring

Space ID

Request-Bodyapplication/jsonCreateOverallBudgetDto

NameTypBeschreibung
namePflichtstring–
amountPflichtnumber–
currencyPflichtstring

Werte: USDEURGBPCHFJPYINRAUDCADCNYSGDHKDAEDZARNZDSEKNOKDKKMXNBRLPLN

sourcestring

Werte: internalcustomergrantpartnerinvestorloanother

financial_yearobject

Beispiel: 2026/27

responsible_user_idobject (uuid)–
cost_category_idobject (uuid)–

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/task-allocations/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Task allocation ID

Request-Bodyapplication/jsonUpdateTaskAllocationDto

NameTypBeschreibung
planned_hoursnumber

Planned hours for this allocation

allocation_modestring

Werte: total_hourshours_per_weekcapacity_percent

weekly_hoursobject–
capacity_percentobject–
start_dateobject (date)–
end_dateobject (date)–
roleobject

Role label for this allocation

notesobject

Notes for this allocation

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/task-allocations/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring

Task allocation ID

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/tasks/{taskId}/allocationsToken

Parameter

NameOrtTypBeschreibung
taskIdPflichtPfadstring

Task ID

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/tasks/{taskId}/allocationsToken

Parameter

NameOrtTypBeschreibung
taskIdPflichtPfadstring

Task ID

Request-Bodyapplication/jsonCreateTaskAllocationDto

NameTypBeschreibung
user_idPflichtstring

User to allocate to this task

planned_hoursnumber

Planned hours for this allocation (total_hours mode only)

Standard: 0

allocation_modestring

Werte: total_hourshours_per_weekcapacity_percent

Standard: "total_hours"

weekly_hoursobject–
capacity_percentobject–
start_dateobject (date)–
end_dateobject (date)–
roleobject

Role label for this allocation

notesobject

Notes for this allocation

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

GET/resource-planning/tasks/{taskId}/budget-timelineToken

Parameter

NameOrtTypBeschreibung
taskIdPflichtPfadstring–
depthQuerynumber–
space_idQuerystring (uuid)–
fromQuerystring–
toQuerystring–
tzQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
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#

GET/resource-planning/tasks/{taskId}/budget-treeToken

Parameter

NameOrtTypBeschreibung
taskIdPflichtPfadstring–
depthQuerynumber–
directionQuerystring

Werte: children

space_idQuerystring (uuid)–
include_dependenciesQueryboolean–

Antworten

  • 200OK
Beispiel (cURL)
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)#

GET/resource-planning/tasks/{taskId}/rollupToken

Parameter

NameOrtTypBeschreibung
taskIdPflichtPfadstring

Task ID

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/tasks/{taskId}/rollup" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List effective-dated unit memberships#

GET/resource-planning/unit-membershipsToken

Parameter

NameOrtTypBeschreibung
fromQuerystring–
toQuerystring–
unit_idQuerystring–
user_idQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create an effective-dated unit membership#

POST/resource-planning/unit-membershipsToken

Request-Bodyapplication/jsonCreateUnitMembershipDto

NameTypBeschreibung
unit_idPflichtstring–
user_idPflichtstring–
effective_fromPflichtstring (date)–
effective_toobject (date)–
allocation_percentobject–

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/unit-memberships/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateUnitMembershipDto

NameTypBeschreibung
unit_idstring–
user_idstring–
effective_fromstring (date)–
effective_toobject (date)–
allocation_percentobject–

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/unit-memberships/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/unit-memberships/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List organization resource-planning units#

GET/resource-planning/unitsToken

Parameter

NameOrtTypBeschreibung
include_inactivePflichtQuerystring–
include_archivedPflichtQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/units" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create an organization resource-planning unit#

POST/resource-planning/unitsToken

Request-Bodyapplication/jsonCreateOrganizationUnitDto

NameTypBeschreibung
namePflichtstring–
unit_typestring

Werte: unitteam

Standard: "unit"

parent_idobject–
descriptionobject–
colorobject–
sort_ordernumber

Standard: 0

is_activeboolean

Standard: true

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/units/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateOrganizationUnitDto

NameTypBeschreibung
namestring–
unit_typestring

Werte: unitteam

Standard: "unit"

parent_idobject–
descriptionobject–
colorobject–
sort_ordernumber

Standard: 0

is_activeboolean

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/units/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/units/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List workload scheme member assignments#

GET/resource-planning/workload-scheme-membersToken

Antworten

  • 200OK
Beispiel (cURL)
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#

POST/resource-planning/workload-scheme-membersToken

Request-Bodyapplication/jsonAssignWorkloadSchemeMemberDto

NameTypBeschreibung
scheme_idPflichtstring–
user_idPflichtstring–

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

DELETE/resource-planning/workload-scheme-members/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-scheme-members/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List workload schemes#

GET/resource-planning/workload-schemesToken

Parameter

NameOrtTypBeschreibung
include_inactivePflichtQuerystring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a workload scheme#

POST/resource-planning/workload-schemesToken

Request-Bodyapplication/jsonCreateWorkloadSchemeDto

NameTypBeschreibung
namePflichtstring–
descriptionobject–
monday_hoursnumber

Standard: 8

tuesday_hoursnumber

Standard: 8

wednesday_hoursnumber

Standard: 8

thursday_hoursnumber

Standard: 8

friday_hoursnumber

Standard: 8

saturday_hoursnumber

Standard: 0

sunday_hoursnumber

Standard: 0

is_defaultboolean

Standard: false

is_activeboolean

Standard: true

Antworten

  • 201Erstellt
Beispiel (cURL)
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#

PATCH/resource-planning/workload-schemes/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Request-Bodyapplication/jsonUpdateWorkloadSchemeDto

NameTypBeschreibung
namestring–
descriptionobject–
monday_hoursnumber

Standard: 8

tuesday_hoursnumber

Standard: 8

wednesday_hoursnumber

Standard: 8

thursday_hoursnumber

Standard: 8

friday_hoursnumber

Standard: 8

saturday_hoursnumber

Standard: 0

sunday_hoursnumber

Standard: 0

is_defaultboolean

Standard: false

is_activeboolean

Standard: true

Antworten

  • 200OK
Beispiel (cURL)
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#

DELETE/resource-planning/workload-schemes/{id}Token

Parameter

NameOrtTypBeschreibung
idPflichtPfadstring–

Antworten

  • 200OK
Beispiel (cURL)
curl -X DELETE "https://xapi.ambertech.cloud/api/v1/resource-planning/workload-schemes/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"
Stand: 25. Oktober 2026© 2026 XISUITE · AmberTech Solutions