Error types for field validation.
| Name | Value | Description |
|---|---|---|
| isNull | isNull | Field is null or missing. |
| isEmpty | isEmpty | Field is empty. |
| minimumLength | minimumLength | Field length is less than the minimum allowed. |
| maximumLength | maximumLength | Field exceeds the maximum allowable length. |
| pattern | pattern | Field does not match a predefined pattern. |
| syntax | syntax | Field syntax type error. |
Interfaces: None
A response object for field 409 conflict errors resulting from trying to create a resource that already exists.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| status | integer | Yes | - | The response status.
Minimum: 100 |
| message | string | Yes | - | The response message.
Minimum: 1 |
Interfaces: None
Error description object for a single field.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| path | string | Yes | - | The object path of the field.
Minimum: 1 |
| message | string | Yes | - | A user friendly error message.
Minimum: 1 |
Interfaces: None
A single validation error description.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| message | string | Yes | - | A user friendly error message.
Minimum: 1 |
| errors | fieldValidationErrorType | Yes | - | A field validation type.
Example: isNull |
Interfaces: None
A response object for field validation errors.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| status | integer | Yes | - | The response status.
Minimum: 100 |
| message | string | Yes | - | The response message.
Minimum: 1 |
| errors | [fieldValidationError] | Yes | - | A set of field validation errors.
Maximum: 32 |
