Portfolios

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

List portfolios#

GET/portfoliosToken

Parameter

Name	Ort	Typ	Beschreibung
`status`	Query	`string`	Werte: `draftactiveon_holdcompleted`
`search`	Query	`string`	–
`include_archived`	Query	`boolean`	–
`page`	Query	`number`	–
`pageSize`	Query	`number`	–

Antworten

200Portfolio list with pagination metadata.
403Portfolio module disabled or insufficient permissions.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a portfolio#

POST/portfoliosToken

Request-Body`application/jsonCreatePortfolioDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	–
`description`	`object`	–
`status`	`string`	Werte: `draftactiveon_holdcompleted`
`color`	`object`	–
`owner_id`	`object`	–

Antworten

201Portfolio created.
400Invalid portfolio payload.
403Portfolio module disabled or insufficient permissions.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

Get a portfolio by ID#

GET/portfolios/{portfolioId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Antworten

200Portfolio row.
404Portfolio not found.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a portfolio#

PATCH/portfolios/{portfolioId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdatePortfolioDto`

Name	Typ	Beschreibung
`name`	`string`	–
`description`	`object`	–
`status`	`string`	Werte: `draftactiveon_holdcompleted`
`color`	`object`	–
`owner_id`	`object`	–
`is_archived`	`boolean`	–
`sort_order`	`number`	–

Antworten

200Portfolio updated.
400Invalid update payload.
404Portfolio not found.

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":{},"status":"draft"}'

Archive or hard-delete a portfolio#

DELETE/portfolios/{portfolioId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`hard`	Query	`boolean`	–

Antworten

200Portfolio archived or hard deleted.

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get portfolio KPI dashboard data#

GET/portfolios/{portfolioId}/dashboardToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Antworten

200Portfolio KPI summary.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/dashboard" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get portfolio Gantt tree#

GET/portfolios/{portfolioId}/ganttToken

Returns a hierarchical { portfolio, spaces: [{ space, plans: [...] }] } tree. Each plan row includes owner, budget, CPI/SPI, last-letter status, custom field values, and archive flag.

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Antworten

200Portfolio Gantt tree grouped by space, with archived plans included (flagged via is_archived).

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/gantt" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List management letters for a portfolio#

GET/portfolios/{portfolioId}/lettersToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`status`	Query	`string`	Werte: `draftsubmittedapprovedrejected`

Antworten

200Management letters visible to the current user.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a portfolio management letter#

POST/portfolios/{portfolioId}/lettersToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonCreateLetterDto`

Name	Typ	Beschreibung
`plan_id`Pflicht	`string`	–
`reporting_period_start`Pflicht	`string`	Beispiel: `2026-05-01`
`reporting_period_end`Pflicht	`string`	Beispiel: `2026-05-31`
`due_date`	`object`	Beispiel: `2026-06-07`
`rag_schedule`	`string`	Werte: `greenamberred`
`rag_budget`	`string`	Werte: `greenamberred`
`rag_quality`	`string`	Werte: `greenamberred`
`key_message`	`object`	–
`assigned_to_user_id`	`object`	Explicit assignee for this letter. Falls back to plan owner when omitted.

Antworten

201Management letter created and linked task created.
400Invalid period, duplicate period, or plan is not in portfolio.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":"…","reporting_period_start":"2026-05-01","reporting_period_end":"2026-05-31"}'

Get a portfolio management letter#

GET/portfolios/{portfolioId}/letters/{letterId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a portfolio management letter#

PATCH/portfolios/{portfolioId}/letters/{letterId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateLetterDto`

Name	Typ	Beschreibung
`rag_schedule`	`string`	Werte: `greenamberred`
`rag_budget`	`string`	Werte: `greenamberred`
`rag_quality`	`string`	Werte: `greenamberred`
`key_message`	`object`	–
`milestones_achieved`	`string[]`	–
`success_factors`	`object`	–
`planned_vs_actual`	`object`	–
`next_steps`	`string[]`	–
`budget_consumption_percent`	`object`	–
`resource_availability`	`object`	–
`identified_risks`	`string[]`	–
`blockers`	`string[]`	–
`due_date`	`object`	–
`assigned_to_user_id`	`object`	Reassign this letter to another user. Managers only; must always resolve to a non-null user.

Antworten

200Management letter updated.

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rag_schedule":"green","rag_budget":"green","rag_quality":"green"}'

Delete a portfolio management letter#

DELETE/portfolios/{portfolioId}/letters/{letterId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Approve a portfolio management letter#

POST/portfolios/{portfolioId}/letters/{letterId}/approveToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter approved.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/approve" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Recompute a letter's budget_consumption_percent from tasks active during the reporting period#

POST/portfolios/{portfolioId}/letters/{letterId}/recompute-budget-consumptionToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter budget consumption percent refreshed from the linked plan tasks.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/recompute-budget-consumption" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Recompute a letter's achieved milestones from plan milestones completed in the reporting period#

POST/portfolios/{portfolioId}/letters/{letterId}/recompute-milestonesToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter milestones recomputed from the plan.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/recompute-milestones" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Recompute a letter's RAG fields from the plan baseline EVM#

POST/portfolios/{portfolioId}/letters/{letterId}/recompute-ragToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter RAG recomputed from baseline EVM.
400No active baseline for this plan.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/recompute-rag" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Recompute a letter's risks_snapshot from the linked plan's plan_risks (draft letters only)#

POST/portfolios/{portfolioId}/letters/{letterId}/recompute-risksToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter risks snapshot refreshed from the plan.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/recompute-risks" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Reject a portfolio management letter#

POST/portfolios/{portfolioId}/letters/{letterId}/rejectToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonRejectLetterDto`

Name	Typ	Beschreibung
`reason`Pflicht	`string`	–

Antworten

201Letter rejected back to draft.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/reject" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"…"}'

Submit a portfolio management letter#

POST/portfolios/{portfolioId}/letters/{letterId}/submitToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`letterId`Pflicht	Pfad	`string`	–

Antworten

201Letter submitted for review.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/letters/{letterId}/submit" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List plans included in a portfolio#

GET/portfolios/{portfolioId}/plansToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Antworten

200Plans visible to the current user.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/plans" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add a plan to a portfolio#

POST/portfolios/{portfolioId}/plansToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonAddPortfolioPlanDto`

Name	Typ	Beschreibung
`plan_id`Pflicht	`string`	–

Antworten

201Plan added to portfolio.
409Plan already exists in portfolio.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/plans" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":"…"}'

Remove a plan from a portfolio#

DELETE/portfolios/{portfolioId}/plans/{planId}Token

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–
`planId`Pflicht	Pfad	`string`	–

Antworten

200Plan removed from portfolio.

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/plans/{planId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get portfolio management-letter schedule config#

GET/portfolios/{portfolioId}/scheduleToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Antworten

200Portfolio letter schedule.
404Schedule feature flag is disabled.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/schedule" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Set portfolio management-letter schedule config#

PATCH/portfolios/{portfolioId}/scheduleToken

Parameter

Name	Ort	Typ	Beschreibung
`portfolioId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateLetterScheduleDto`

Name	Typ	Beschreibung
`enabled`Pflicht	`boolean`	–
`cadence`Pflicht	`string`	Werte: `weeklybiweeklymonthlyquarterly`
`day_of_period`Pflicht	`number`	–
`reporting_period_anchor`Pflicht	`string`	Werte: `period_startperiod_end`

Antworten

200Schedule updated.

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/portfolios/{portfolioId}/schedule" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"cadence":"weekly","day_of_period":0,"reporting_period_anchor":"period_start"}'

Get a portfolio by friendly key#

GET/portfolios/by-key/{key}Token

Parameter

Name	Ort	Typ	Beschreibung
`key`Pflicht	Pfad	`string`	–

Antworten

200Portfolio row.
404Portfolio not found.

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/portfolios/by-key/{key}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Portfolios

List portfolios#

Parameter

Antworten

Create a portfolio#

Request-Bodyapplication/jsonCreatePortfolioDto

Antworten

Get a portfolio by ID#

Parameter

Antworten

Update a portfolio#

Parameter

Request-Bodyapplication/jsonUpdatePortfolioDto

Antworten

Archive or hard-delete a portfolio#

Parameter

Antworten

Get portfolio KPI dashboard data#

Parameter

Antworten

Get portfolio Gantt tree#

Parameter

Antworten

List management letters for a portfolio#

Parameter

Antworten

Create a portfolio management letter#

Parameter

Request-Bodyapplication/jsonCreateLetterDto

Antworten

Get a portfolio management letter#

Parameter

Antworten

Update a portfolio management letter#

Parameter

Request-Bodyapplication/jsonUpdateLetterDto

Antworten

Delete a portfolio management letter#

Parameter

Antworten

Approve a portfolio management letter#

Parameter

Antworten

Recompute a letter's budget_consumption_percent from tasks active during the reporting period#

Parameter

Antworten

Recompute a letter's achieved milestones from plan milestones completed in the reporting period#

Parameter

Antworten

Recompute a letter's RAG fields from the plan baseline EVM#

Parameter

Antworten

Recompute a letter's risks_snapshot from the linked plan's plan_risks (draft letters only)#

Parameter

Antworten

Reject a portfolio management letter#

Parameter

Request-Bodyapplication/jsonRejectLetterDto

Antworten

Submit a portfolio management letter#

Parameter

Antworten

List plans included in a portfolio#

Parameter

Antworten

Add a plan to a portfolio#

Parameter

Request-Bodyapplication/jsonAddPortfolioPlanDto

Antworten

Remove a plan from a portfolio#

Parameter

Antworten

Get portfolio management-letter schedule config#

Parameter

Antworten

Set portfolio management-letter schedule config#

Parameter

Request-Bodyapplication/jsonUpdateLetterScheduleDto

Antworten

Get a portfolio by friendly key#

Request-Body`application/jsonCreatePortfolioDto`

Request-Body`application/jsonUpdatePortfolioDto`

Request-Body`application/jsonCreateLetterDto`

Request-Body`application/jsonUpdateLetterDto`

Request-Body`application/jsonRejectLetterDto`

Request-Body`application/jsonAddPortfolioPlanDto`

Request-Body`application/jsonUpdateLetterScheduleDto`