Provides error details for the Rules API, including an errorCode to help identify issues.
Schema overview
The Rules API returns errors using a ProblemDetails format based on RFC 7807, with an added errorCode field to help identify issues programmatically.
Summary parameters
| Field | Type | Required | Description |
|---|---|---|---|
| type | string (uri) | No | Problem type URI. |
| title | string | Yes | Short summary of the problem type. |
| status | integer | Yes | HTTP status code for this occurrence. |
| detail | string | No | Human-readable explanation of the specific occurrence. |
| instance | string (uri) | No | URI identifying the specific occurrence. |
| errorCode | string | No | Machine-readable application error code. |
| details | object | No | Additional arbitrary key-value properties for debugging or field-level validation context. |
details
| Field | Type | Description |
|---|---|---|
| additionalProperties | any | Zero or more implementation-specific keys. The structure is not fixed. |
JSON example
{
"type": "https://api.precisely.com/problems/validation",
"title": "Bad Request",
"status": 400,
"detail": "Invalid ruleId format. Expected a 24-character hexadecimal value.",
"errorCode": "INVALID_FILTER_VALUE"
}