Paths on this page are relative to /api/liquidity-studio/v2. Authentication and required headers vary by operation.
API reference overview · OpenAPI download
Operations on this page#
| Method | Path | Operation |
|---|---|---|
GET |
/treasury/assumptions |
listTreasuryAssumptions |
POST |
/treasury/assumptions |
createTreasuryAssumptions |
GET |
/treasury/assumptions/{id} |
getTreasuryAssumptions |
GET |
/treasury/assumptions/{id}/versions |
listTreasuryAssumptionsVersions |
GET |
/treasury/assumptions/{id}/versions/{sequence} |
getTreasuryAssumptionsVersion |
POST |
/treasury/assumptions/{id}/revisions |
reviseTreasuryAssumptions |
listTreasuryAssumptions#
GET /treasury/assumptions
Operation ID: listTreasuryAssumptions
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Pattern: ^treasury_assumptions_[a-f0-9]{32}$ |
limit |
query | No | integer |
Default: 20; Minimum: 1; Maximum: 20 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptionsList | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
createTreasuryAssumptions#
POST /treasury/assumptions
Operation ID: createTreasuryAssumptions
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
Idempotency-Key |
header | Yes | string |
Pattern: ^[\x21-\x7E]+$; Min length: 8; Max length: 200 |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
201 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
409 |
Request key already binds another request. | application/json: object |
412 |
Ledger or custody source is no longer current. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptionsWrite | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
201 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptionsWrite | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
409 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
409 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
412 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
412 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
getTreasuryAssumptions#
GET /treasury/assumptions/{id}
Operation ID: getTreasuryAssumptions
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
Pattern: ^treasury_assumptions_[a-f0-9]{32}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptions | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
listTreasuryAssumptionsVersions#
GET /treasury/assumptions/{id}/versions
Operation ID: listTreasuryAssumptionsVersions
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
Pattern: ^treasury_assumptions_[a-f0-9]{32}$ |
cursor |
query | No | string |
Pattern: ^[1-9][0-9]{0,17}$ |
limit |
query | No | integer |
Default: 20; Minimum: 1; Maximum: 20 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptionsHistory | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
getTreasuryAssumptionsVersion#
GET /treasury/assumptions/{id}/versions/{sequence}
Operation ID: getTreasuryAssumptionsVersion
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
Pattern: ^treasury_assumptions_[a-f0-9]{32}$ |
sequence |
path | Yes | string |
Pattern: ^[1-9][0-9]{0,17}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptions | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
reviseTreasuryAssumptions#
POST /treasury/assumptions/{id}/revisions
Operation ID: reviseTreasuryAssumptions
Authentication: __Host-klineo_session cookie (sessionCookie)
Private issuer-declared planning assumptions tied to one acknowledged reconciliation. Writes require current workspace treasury authority and recent authentication. Creation rechecks live source authority; revisions preserve exact historical source bindings and do not assert current cash applicability. Exact token units come from server records. Immutable revisions preserve attributed history. Declarations never establish verified expense completeness, actual receipts, spendability or financial authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
Pattern: ^treasury_assumptions_[a-f0-9]{32}$ |
Idempotency-Key |
header | Yes | string |
Pattern: ^[\x21-\x7E]+$; Min length: 8; Max length: 200 |
If-Match |
header | Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private declared planning inputs or immutable history. Does not establish spendability. | application/json: object |
400 |
Invalid closed request or pagination. | application/json: object |
401 |
Interactive session and recent authentication for writes required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved record unavailable. | application/json: object |
409 |
Request identity conflict. | application/json: object |
412 |
Assumptions version or source authority changed. | application/json: object |
428 |
Strong exact If-Match required. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source verification unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryAssumptionsWrite | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
409 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
409 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
412 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
412 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
428 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
428 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.