Plans

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

List plans in a space#

GET/plansToken

Parameter

Name	Ort	Typ	Beschreibung
`pageSize`	Query	`number`	–
`page`	Query	`number`	–
`is_archived`	Query	`boolean`	–
`owner_id`	Query	`any`	–
`status`	Query	`any`	–
`plan_type`	Query	`any`	–
`search`	Query	`any`	–
`exclude_plan_ids`	Query	`any`	–
`organization_id`	Query	`any`	–
`space_id`	Query	`any`	–

Antworten

200Space-scoped or organization-scoped plan list.
403organization_id does not match current user organization.

Beispiel (cURL)

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

Create a new plan#

POST/plansToken

Request-Body`application/jsonCreatePlanDto`

Name	Typ	Beschreibung
`space_id`Pflicht	`string`	–
`spaceId`	`string`	Legacy camelCase space field accepted for compatibility.
`organizationId`	`string`	Legacy camelCase organization field accepted for compatibility; auth context wins.
`organization_id`	`string`	Legacy snake_case organization field accepted for compatibility; auth context wins.
`name`Pflicht	`string`	–
`description`	`string`	–
`plan_type`	`string`	Werte: `waterfallagilehybridipma` Standard: `"waterfall"`
`start_date`	`string`	–
`end_date`	`string`	–
`budget`	`number`	–
`currency`	`string`	Standard: `"EUR"`
`owner_id`	`string`	–
`settings`	`object`	–

Antworten

201Erstellt

Beispiel (cURL)

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

Get plan details#

GET/plans/{planId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Update plan#

PATCH/plans/{planId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanDto`

Name	Typ	Beschreibung
`id`	`string`	Legacy body field accepted for compatibility; route param wins.
`organizationId`	`string`	Legacy camelCase organization field accepted for compatibility; auth context wins.
`organization_id`	`string`	Legacy snake_case organization field accepted for compatibility; auth context wins.
`name`	`string`	–
`description`	`string`	–
`plan_type`	`string`	Werte: `waterfallagilehybridipma`
`status`	`string`	Werte: `draftactiveon_holdcompletedarchived`
`start_date`	`string`	–
`end_date`	`string`	–
`budget`	`number`	–
`currency`	`string`	–
`owner_id`	`string`	–
`filter_id`	`string`	–
`progress`	`number`	–
`sort_order`	`number`	–
`settings`	`object`	–
`is_archived`	`boolean`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/plans/{planId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","organizationId":"…","organization_id":"…"}'

Delete plan (must be archived first)#

DELETE/plans/{planId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Archive plan#

POST/plans/{planId}/archiveToken

Parameter

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

Antworten

201Erstellt

Beispiel (cURL)

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

Unarchive plan#

DELETE/plans/{planId}/archiveToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

List plan baselines#

GET/plans/{planId}/baselinesToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Create a plan baseline snapshot#

POST/plans/{planId}/baselinesToken

Parameter

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

Request-Body`application/jsonCreatePlanBaselineDto`

Name	Typ	Beschreibung
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`Pflicht	`string`	–
`is_active`	`boolean`	Legacy body field accepted for compatibility; Nest creates the baseline active.

Antworten

201Erstellt

Beispiel (cURL)

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

Delete a baseline#

DELETE/plans/{planId}/baselines/{baselineId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Activate a baseline#

POST/plans/{planId}/baselines/{baselineId}/activateToken

Parameter

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

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/plans/{planId}/baselines/{baselineId}/activate" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get Earned Value Management metrics#

GET/plans/{planId}/baselines/evmToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

List comments for a plan#

GET/plans/{planId}/commentsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Add a comment to a plan#

POST/plans/{planId}/commentsToken

Parameter

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

Request-Body`application/jsonCreatePlanCommentDto`

Name	Typ	Beschreibung
`content`Pflicht	`string`	Comment content — supports HTML (max 10000 chars)

Antworten

201Erstellt

Beispiel (cURL)

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

Update a plan comment (author only)#

PUT/plans/{planId}/comments/{commentId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanCommentDto`

Name	Typ	Beschreibung
`content`Pflicht	`string`	Updated comment content — supports HTML (max 10000 chars)

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/plans/{planId}/comments/{commentId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"…"}'

Delete a plan comment (author only)#

DELETE/plans/{planId}/comments/{commentId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

List Gantt dependencies#

GET/plans/{planId}/dependenciesToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Add a dependency between plan items#

POST/plans/{planId}/dependenciesToken

Parameter

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

Request-Body`application/jsonCreatePlanDependencyDto`

Name	Typ	Beschreibung
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`predecessor_id`Pflicht	`string`	Predecessor task ID
`successor_id`Pflicht	`string`	Successor task ID
`dependency_type`	`string`	Werte: `finish_to_startstart_to_startfinish_to_finishstart_to_finish` Standard: `"finish_to_start"`
`lag_days`	`number`	Lag in days (negative = lead)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/plans/{planId}/dependencies" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"predecessor_id":"…","successor_id":"…"}'

Remove a dependency#

DELETE/plans/{planId}/dependencies/{depId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Get Gantt view data#

GET/plans/{planId}/ganttToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Generate AI plan preview from prompt#

POST/plans/{planId}/generateToken

Parameter

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

Request-Body`application/jsonGeneratePlanDto`

Name	Typ	Beschreibung
`prompt`Pflicht	`string`	Natural language prompt describing the project plan (10-50000 chars)

Antworten

201Erstellt

Beispiel (cURL)

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

Materialize AI-generated plan (execute generation)#

POST/plans/{planId}/generate/executeToken

Parameter

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

Request-Body`application/jsonExecutePlanDto`

Name	Typ	Beschreibung
`generation_id`Pflicht	`string`	ID of the plan_ai_generations record to execute

Antworten

201Erstellt

Beispiel (cURL)

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

List all items in a plan#

GET/plans/{planId}/itemsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Add item to plan#

POST/plans/{planId}/itemsToken

Parameter

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

Request-Body`application/jsonCreatePlanItemDto`

Name	Typ	Beschreibung
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`Pflicht	`string`	–
`description`	`string`	–
`item_type`	`string`	Werte: `phasework_packagetaskmilestone` Standard: `"task"`
`parent_id`	`string`	–
`start_date`	`string`	–
`end_date`	`string`	–
`duration_days`	`number`	Duration in days
`priority`	`string`	Werte: `highesthighmediumlowlowest`
`assigned_to`	`string`	–
`estimated_hours`	`number`	–
`estimated_cost`	`number`	–
`color`	`string`	–
`sort_order`	`number`	–
`progress`	`number`	Progress percentage 0-100
`linked_task_id`	`string`	Link existing task instead of creating new
`task_type_id`	`string`	Task type ID from task_hierarchy_configurations

Antworten

201Erstellt

Beispiel (cURL)

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

Get a single plan item#

GET/plans/{planId}/items/{itemId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Update a plan item#

PATCH/plans/{planId}/items/{itemId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanItemDto`

Name	Typ	Beschreibung
`id`	`string`	Legacy body field accepted for compatibility; route param wins.
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`	`string`	–
`description`	`string`	–
`item_type`	`string`	Werte: `phasework_packagetaskmilestone`
`start_date`	`string`	–
`end_date`	`string`	–
`duration_days`	`number`	–
`priority`	`string`	Werte: `highesthighmediumlowlowest`
`assigned_to`	`string`	–
`estimated_hours`	`number`	–
`actual_hours`	`number`	–
`estimated_cost`	`number`	–
`actual_cost`	`number`	–
`color`	`string`	–
`sort_order`	`number`	–
`is_critical_path`	`boolean`	–
`progress`	`number`	–
`status`	`string`	–
`parent_id`	`object`	Parent task ID; send null to unset parent
`task_type_id`	`string`	Task type ID from task_hierarchy_configurations
`linked_task_id`	`string`	Accepted for compatibility; ignored on update (used on create only)

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/plans/{planId}/items/{itemId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","plan_id":"…","name":"…"}'

Remove item from plan#

DELETE/plans/{planId}/items/{itemId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Move plan item to new parent#

POST/plans/{planId}/items/{itemId}/moveToken

Parameter

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

Request-Body`application/jsonMovePlanItemDto`

Name	Typ	Beschreibung
`task_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`new_parent_id`Pflicht	`object`	New parent item ID; pass null to move to root level
`sort_order`	`number`	New sort order position

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/plans/{planId}/items/{itemId}/move" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"new_parent_id":{}}'

Bulk reorder plan items#

PUT/plans/{planId}/items/reorderToken

Parameter

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

Request-Body`application/jsonReorderPlanItemsDto`

Name	Typ	Beschreibung
`items`Pflicht	`ReorderItemEntry[]`	–
`items[].id`	`string`	Legacy alias for task_id. task.id, not plan_tasks.id.
`items[].task_id`Pflicht	`string`	task.id (not plan_tasks.id)
`items[].sort_order`Pflicht	`number`	–
`items[].parent_task_id`	`object`	New parent task ID (optional reparent)
`items[].parent_id`	`object`	Legacy alias for parent_task_id.

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/plans/{planId}/items/reorder" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"items":[]}'

List plan permissions#

GET/plans/{planId}/permissionsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Grant permission on a plan#

POST/plans/{planId}/permissionsToken

Parameter

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

Request-Body`application/jsonCreatePlanPermissionDto`

Name Typ Beschreibung

plan_id

string

Legacy body field accepted for compatibility; route param wins.

user_idPflicht string –

permission_level

string

Werte: vieweditadmin

Standard: "view"

Antworten

201Erstellt

Beispiel (cURL)

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

Update plan permission level#

PATCH/plans/{planId}/permissions/{permissionId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanPermissionDto`

Name	Typ	Beschreibung
`id`	`string`	Legacy body field accepted for compatibility; route param wins.
`permission_level`Pflicht	`string`	Werte: `vieweditadmin`

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/plans/{planId}/permissions/{permissionId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"permission_level":"view"}'

Revoke plan permission#

DELETE/plans/{planId}/permissions/{permissionId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Set manual RAG health for a plan#

POST/plans/{planId}/ragToken

Parameter

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

Request-Body`application/jsonSetRagDto`

Name	Typ	Beschreibung
`rag_status`Pflicht	`string`	Werte: `greenamberred`

Antworten

201Manual RAG override persisted.
400Invalid RAG payload.
403User cannot edit this plan.

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/plans/{planId}/rag" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rag_status":"green"}'

Clear manual RAG health for a plan#

DELETE/plans/{planId}/ragToken

Parameter

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

Antworten

200Manual RAG override cleared and computed RAG returned.
403User cannot edit this plan.

Beispiel (cURL)

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

Refresh filter-driven plan#

POST/plans/{planId}/refreshToken

Parameter

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

Antworten

201Erstellt

Beispiel (cURL)

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

List plan risks#

GET/plans/{planId}/risksToken

Parameter

Name	Ort	Typ	Beschreibung
`planId`Pflicht	Pfad	`string`	–
`risk_type`	Query	`string`	–
`is_blocker`	Query	`string`	Filter by blocker flag. Pass true to return only blockers, false to exclude them.

Antworten

200OK

Beispiel (cURL)

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

Add risk to plan#

POST/plans/{planId}/risksToken

Parameter

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

Request-Body`application/jsonCreatePlanRiskDto`

Name	Typ	Beschreibung
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`Pflicht	`string`	–
`description`	`string`	–
`risk_type`	`string`	Werte: `riskopportunity` Standard: `"risk"`
`category`	`string`	Category (e.g. Technical, Schedule, Budget)
`probability`	`number`	Probability 1-5 Standard: `3`
`impact`	`number`	Impact 1-5 Standard: `3`
`expected_value`	`number`	–
`status`	`string`	Werte: `identifiedanalyzingmitigatingacceptedresolvedoccurred` Standard: `"identified"`
`mitigation_strategy`	`string`	–
`contingency_plan`	`string`	–
`owner_id`	`string`	–
`task_id`	`string`	Associated task ID
`response_date`	`string`	–
`is_blocker`	`boolean`	When true, the risk is a blocker (rendered under Blockers on portfolio letters and badged on the plan risk register). Standard: `false`

Antworten

201Erstellt

Beispiel (cURL)

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

Update a risk#

PATCH/plans/{planId}/risks/{riskId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanRiskDto`

Name	Typ	Beschreibung
`id`	`string`	Legacy body field accepted for compatibility; route param wins.
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`	`string`	–
`description`	`string`	–
`risk_type`	`string`	Werte: `riskopportunity`
`category`	`string`	–
`probability`	`number`	–
`impact`	`number`	–
`expected_value`	`number`	–
`status`	`string`	Werte: `identifiedanalyzingmitigatingacceptedresolvedoccurred`
`mitigation_strategy`	`string`	–
`contingency_plan`	`string`	–
`owner_id`	`string`	–
`task_id`	`string`	–
`response_date`	`string`	–
`is_blocker`	`boolean`	Toggle the blocker flag on an existing plan risk.

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/plans/{planId}/risks/{riskId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","plan_id":"…","name":"…"}'

Delete a risk#

DELETE/plans/{planId}/risks/{riskId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Risk matrix view#

GET/plans/{planId}/risks/matrixToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Risk register (5x5 matrix)#

GET/plans/{planId}/risks/registerToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

List plan stakeholders#

GET/plans/{planId}/stakeholdersToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Add stakeholder to plan#

POST/plans/{planId}/stakeholdersToken

Parameter

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

Request-Body`application/jsonCreatePlanStakeholderDto`

Name	Typ	Beschreibung
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`Pflicht	`string`	–
`role`	`string`	–
`email`	`string`	–
`user_id`	`string`	–
`organization_name`	`string`	–
`power_level`	`number`	Power/influence level 1-10 Standard: `5`
`interest_level`	`number`	Interest level 1-10 Standard: `5`
`attitude`	`string`	Werte: `supportiveneutralresistant`
`engagement_strategy`	`string`	–
`notes`	`string`	–

Antworten

201Erstellt

Beispiel (cURL)

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

Update a stakeholder#

PATCH/plans/{planId}/stakeholders/{stakeholderId}Token

Parameter

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

Request-Body`application/jsonUpdatePlanStakeholderDto`

Name	Typ	Beschreibung
`id`	`string`	Legacy body field accepted for compatibility; route param wins.
`plan_id`	`string`	Legacy body field accepted for compatibility; route param wins.
`name`	`string`	–
`role`	`string`	–
`email`	`string`	–
`user_id`	`string`	–
`organization_name`	`string`	–
`power_level`	`number`	–
`interest_level`	`number`	–
`attitude`	`string`	Werte: `supportiveneutralresistant`
`engagement_strategy`	`string`	–
`notes`	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/plans/{planId}/stakeholders/{stakeholderId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","plan_id":"…","name":"…"}'

Delete a stakeholder#

DELETE/plans/{planId}/stakeholders/{stakeholderId}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Stakeholder power/interest matrix#

GET/plans/{planId}/stakeholders/matrixToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Get WBS tree view#

GET/plans/{planId}/wbsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

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

Get one accessible plan by UUID or plan key#

GET/plans/mine/{planIdOrKey}Token

Resolves a plan by UUID or org-scoped plan key and returns a whitelisted detail (metadata + item/risk/stakeholder counts — no items, no baseline, no financials) only when the caller can view it (org admin/owner, member space with view_plans, or a per-plan permission grant). Cross-org, non-member, permission-denied, ambiguous-key, and nonexistent all return an IDENTICAL 404 (anti-probing). Archived plans are returned flagged. Backs the MCP plan.get tool.

Parameter

Name	Ort	Typ	Beschreibung
`planIdOrKey`Pflicht	Pfad	`string`	Plan UUID or plan key

Antworten

200Accessible plan returned
401Not authenticated
404Plan not found or not accessible

Beispiel (cURL)

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

Search plans the current user can access#

GET/plans/mine/searchToken

Name search over plans the authenticated caller can read in their active organization — member spaces with view_plans (or org admin/owner) plus per-plan permission grants. Never cross-org, never a non-member space plan without an explicit grant. Archived plans are excluded unless includeArchived=true. An absent query lists all accessible plans. Backs the MCP plan.search tool.

Parameter

Name	Ort	Typ	Beschreibung
`q`	Query	`string`	–
`spaceIdOrKey`	Query	`string`	–
`status`	Query	`string`	–
`ownerId`	Query	`string`	–
`includeArchived`	Query	`boolean`	–
`limit`	Query	`number`	–
`cursor`	Query	`string`	–

Antworten

200Accessible plans returned
401Not authenticated

Beispiel (cURL)

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

Plans

List plans in a space#

Parameter

Antworten

Create a new plan#

Request-Bodyapplication/jsonCreatePlanDto

Antworten

Get plan details#

Parameter

Antworten

Update plan#

Parameter

Request-Bodyapplication/jsonUpdatePlanDto

Antworten

Delete plan (must be archived first)#

Parameter

Antworten

Archive plan#

Parameter

Antworten

Unarchive plan#

Parameter

Antworten

List plan baselines#

Parameter

Antworten

Create a plan baseline snapshot#

Parameter

Request-Bodyapplication/jsonCreatePlanBaselineDto

Antworten

Delete a baseline#

Parameter

Antworten

Activate a baseline#

Parameter

Antworten

Get Earned Value Management metrics#

Parameter

Antworten

List comments for a plan#

Parameter

Antworten

Add a comment to a plan#

Parameter

Request-Bodyapplication/jsonCreatePlanCommentDto

Antworten

Update a plan comment (author only)#

Parameter

Request-Bodyapplication/jsonUpdatePlanCommentDto

Antworten

Delete a plan comment (author only)#

Parameter

Antworten

List Gantt dependencies#

Parameter

Antworten

Add a dependency between plan items#

Parameter

Request-Bodyapplication/jsonCreatePlanDependencyDto

Antworten

Remove a dependency#

Parameter

Antworten

Get Gantt view data#

Parameter

Antworten

Generate AI plan preview from prompt#

Parameter

Request-Bodyapplication/jsonGeneratePlanDto

Antworten

Materialize AI-generated plan (execute generation)#

Parameter

Request-Bodyapplication/jsonExecutePlanDto

Antworten

List all items in a plan#

Parameter

Antworten

Add item to plan#

Parameter

Request-Bodyapplication/jsonCreatePlanItemDto

Request-Body`application/jsonCreatePlanDto`

Request-Body`application/jsonUpdatePlanDto`

Request-Body`application/jsonCreatePlanBaselineDto`

Request-Body`application/jsonCreatePlanCommentDto`

Request-Body`application/jsonUpdatePlanCommentDto`

Request-Body`application/jsonCreatePlanDependencyDto`

Request-Body`application/jsonGeneratePlanDto`

Request-Body`application/jsonExecutePlanDto`

Request-Body`application/jsonCreatePlanItemDto`

Request-Body`application/jsonUpdatePlanItemDto`

Request-Body`application/jsonMovePlanItemDto`

Request-Body`application/jsonReorderPlanItemsDto`

Request-Body`application/jsonCreatePlanPermissionDto`

Request-Body`application/jsonUpdatePlanPermissionDto`

Request-Body`application/jsonSetRagDto`

Request-Body`application/jsonCreatePlanRiskDto`

Request-Body`application/jsonUpdatePlanRiskDto`

Request-Body`application/jsonCreatePlanStakeholderDto`