Playground

Playground

TechPortfolioItem

/api/v1/investments/portfolio

A budgeted technology investment line.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
namestringHuman-readable name for this portfolio item or investment initiative.
descriptionstringOptional free-text description of the initiative's scope and objectives.
business_capabilitystringBusiness capability this investment supports (e.g. 'Collaboration', 'Security', 'Developer Productivity').
strategic_prioritystringStrategic importance of this investment as assessed by business or IT leadership.
owner_iduuidUUID of the Person accountable for this portfolio item.
linked_license_idsjsonUUIDs of SoftwareLicense records that belong to this portfolio item.
linked_asset_idsjsonUUIDs of TechnologyAsset or PhysicalAsset records that belong to this portfolio item.
budgeted_cost_amountnumberApproved budget for this portfolio item in the specified currency.
actual_cost_amountnumberActual spend to date for this portfolio item in the specified currency.
currencystringISO 4217 three-letter currency code for budgeted and actual cost amounts.
initiative_tagstringOptional free-form tag linking this item to an external programme or initiative tracker.
statusstringCurrent lifecycle status of this portfolio item.

API

client.investments.portfolio.*
Loading manifest…