View as Markdown

Retired routes

The paths on this list are retired from v1 together, in one step. Their names stay reserved: once the list is removed, each answers 404 not_found as application/problem+json, the same as a path that never existed, and the name is not used for anything else. Nothing on v2 or v3 changes.

How a retirement is announced

While a route is announced it keeps working, and every answer from it carries three headers:

Deprecationheader

The day the route was deprecated, as @ and Unix seconds (RFC 9745), for example @1793491200.

Sunsetheader

The day the route is due to stop answering, as an HTTP date (RFC 8594), for example Sat, 01 May 2027 00:00:00 GMT.

Linkheader

<https://docs.aleta.ai/developers/api/v1/retired>; rel="deprecation", this page.

Once the list is removed, each route answers 404 not_found before any other check, without needing a key.

What to use instead

The commitments of a private-equity asset are read with GET /v1/assets/{asset_id}/commitments.

The list

MethodPath
POST/v1/users
GET PATCH/v1/governance-policy
POST/v1/roles
PATCH DELETE/v1/roles/{role_id}
GET POST/v1/commitments
GET PATCH DELETE/v1/commitments/{commitment_id}
GET POST/v1/corporate-actions/{corporate_action_id}/elections
GET/v1/classification-suggestions
POST/v1/classification-suggestions/{classification_suggestion_id}/accept
POST/v1/classification-suggestions/{classification_suggestion_id}/reject
POST/v1/lenses/{lens_id}/publish
POST/v1/lenses/{lens_id}/unpublish
GET/v1/tag-rule-suggestions
GET/v1/tag-rule-suggestions/{tag_rule_suggestion_id}
POST/v1/tag-rule-suggestions/{tag_rule_suggestion_id}/accept
POST/v1/tag-rule-suggestions/{tag_rule_suggestion_id}/reject
GET POST/v1/audience-profiles
GET PATCH DELETE/v1/audience-profiles/{audience_profile_id}
GET/v1/custodian-contract-holdings
GET/v1/custodian-contract-holdings/{custodian_contract_holding_id}
POST/v1/reconciliation-breaks/{reconciliation_break_id}/escalate
GET POST/v1/change-sets
GET/v1/change-sets/{change_set_id}
POST/v1/change-sets/{change_set_id}/approve
POST/v1/change-sets/{change_set_id}/commit
POST/v1/change-sets/{change_set_id}/discard
POST/v1/change-sets/{change_set_id}/submit
GET POST/v1/portfolios
GET PATCH DELETE/v1/portfolios/{portfolio_id}

Only the methods named are retired, and a HEAD of a retired GET with it. GET /v1/users, for example, stays.

Of the list, only these are served today: POST /v1/users, GET /v1/commitments, GET /v1/commitments/{commitment_id}, POST /v1/lenses/{lens_id}/publish, POST /v1/lenses/{lens_id}/unpublish, GET /v1/custodian-contract-holdings and GET /v1/custodian-contract-holdings/{custodian_contract_holding_id}. Every other path on the list is not served and answers 404 not_found like any unknown path.