API
Common HTTP models data models
Read the shared common http models fields used by the customer API.
Shared contract
Common HTTP models
These 3 models come from the same Product owned OpenAPI 3.2 contract as the operation reference.
APIError4 fields
Shared APIError representation.
APIError fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
error | required | object | The stable error envelope returned for a failed API request. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | No additional schema limit is listed | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
error.code | required | string | Stable machine readable Pūnaha error code. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Pattern: ^[A Z][A Z0-9_]+$. Example: PERMISSION_REQUIRED | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
error.details | required | object or array or string or number or integer or boolean or null | Error code specific diagnostic values. The operation error catalogue documents their meaning. They may be null when no safe detail is available. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: {"permission":"workflows.manage"} | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. Sensitive. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
error.message | required | string | Human readable explanation of the failure. Do not parse this text for control flow. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Minimum length: 1. Example: The exact permission or resource action is required. | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
Pagination3 fields
Shared Pagination representation.
Pagination fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
limit | required | integer | Maximum records requested for this page. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Minimum: 1. Example: 20 | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
offset | required | integer | Number of matching records skipped before this page. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Minimum: 0. Example: 0 | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
total | required | integer in int64 format | Total matching records available at the time of the query. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Minimum: 0. Example: 42 | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
ServerSentEvent4 fields
Shared ServerSentEvent representation.
ServerSentEvent fields
| Field | Presence | Type | Meaning | Empty and default | Limits and example | Access, sensitivity and lifecycle |
|---|---|---|---|---|---|---|
data | required | string | Event payload after Server Sent Event parsing. JSON payloads remain string encoded and are interpreted using contentSchema. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: {"status":"completed"} | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
event | optional | string | Optional event type used to select the event specific payload meaning. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: workflow run | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
id | optional | string | Optional event identifier used for ordering or reconnection when the operation supports replay. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Example: example event 001 | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
retry | optional | integer | Optional server suggested reconnection delay in milliseconds. | Omission, null, an empty value, zero, and false have distinct JSON meanings. Only values permitted by this schema and the operation may be used. Default: No client default is assumed unless a JSON Schema default is present. | Minimum: 0. Example: 2000 | Inherits the operation access boundary. Shared across documented Pūnaha HTTP operations. No special sensitivity is marked. Do not copy customer content, credentials, or personal information into examples or unsupported logs. Lifecycle: Next Product release. |
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.