EOAP Problem Details Registry

Title: EOAP Problem Details Registry
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
AlreadyExists
BadRequest
BusinessRuleViolation
Forbidden
InvalidBodyPropertyFormat
InvalidBodyPropertyValue
InvalidParameters
InvalidRequestHeaderFormat
InvalidRequestParameterFormat
InvalidRequestParameterValue
LicenseCancelled
LicenseExpired
MissingBodyProperty
MissingRequestHeader
MissingRequestParameter
NotFound
ServerError
ServiceUnavailable
Unauthorized
ValidationError

1. Property EOAP Problem Details Registry > anyOf > AlreadyExists
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/AlreadyExists
All of(Requirement)
ProblemDetails
item 1

1.1. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/ProblemDetails

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

Property Pattern Type Deprecated Definition Title/Description
- instance No string No - A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
- code No string No - An API specific error code aiding the provider team understand the error based on their own potential taxonomy or registry.
- errors No array No - An array of error details to accompany a problem details response.

1.1.1. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > instance
Type string
Required No

Description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Restrictions
Max length 1024

1.1.2. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > code
Type string
Required No

Description: An API specific error code aiding the provider team understand the error based on their own potential taxonomy or registry.

Restrictions
Max length 50

1.1.3. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors
Type array
Required No

Description: An array of error details to accompany a problem details response.

Array restrictions
Min items N/A
Max items 1000
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
ErrorDetail An object to provide explicit details on a problem towards an API consumer.
1.1.3.1. EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > ErrorDetail
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/ErrorDetail

Description: An object to provide explicit details on a problem towards an API consumer.

Property Pattern Type Deprecated Definition Title/Description
+ detail No string No - A granular description on the specific error related to a body property, query parameter, path parameters, and/or header.
- pointer No string No - A JSON Pointer to a specific request body property that is the source of error.
- parameter No string No - The name of the query or path parameter that is the source of error.
- header No string No - The name of the header that is the source of error.
- code No string No - A string containing additional provider specific codes to identify the error context.
1.1.3.1.1. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > errors items > detail
Type string
Required Yes

Description: A granular description on the specific error related to a body property, query parameter, path parameters, and/or header.

Restrictions
Max length 4096
1.1.3.1.2. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > errors items > pointer
Type string
Required No

Description: A JSON Pointer to a specific request body property that is the source of error.

Restrictions
Max length 1024
1.1.3.1.3. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > errors items > parameter
Type string
Required No

Description: The name of the query or path parameter that is the source of error.

Restrictions
Max length 1024
1.1.3.1.4. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > errors items > header
Type string
Required No

Description: The name of the header that is the source of error.

Restrictions
Max length 1024
1.1.3.1.5. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 0 > errors > errors items > code
Type string
Required No

Description: A string containing additional provider specific codes to identify the error context.

Restrictions
Max length 50

1.2. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the resource being created is found to already exist on the server. Your client application tried to create a resource that already exists. Perhaps review your client logic to determine if a user should be able to send such a request.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

1.2.1. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/already-exists"

1.2.2. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 409

1.2.3. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Already exists"

1.2.4. Property EOAP Problem Details Registry > anyOf > item 0 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The resource being created already exists."

2. Property EOAP Problem Details Registry > anyOf > BadRequest
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/BadRequest
All of(Requirement)
ProblemDetails
item 1

2.1. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

2.2. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: The server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing). Your client application initiated a request that is malformed. Please review your client request against the defined semantics for the API.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

2.2.1. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/bad-request"

2.2.2. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

2.2.3. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Bad Request"

2.2.4. Property EOAP Problem Details Registry > anyOf > item 1 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request is invalid or malformed."

3. Property EOAP Problem Details Registry > anyOf > BusinessRuleViolation
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/BusinessRuleViolation
All of(Requirement)
ProblemDetails
item 1

3.1. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

3.2. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request is deemed invalid as it fails to meet business rule expectations. Your client issued a request that failed business rule validation. Please review your request to determine if you can remain within appropriate business rules.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

3.2.1. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/business-rule-violation"

3.2.2. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 422

3.2.3. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Business Rule Violation"

3.2.4. Property EOAP Problem Details Registry > anyOf > item 2 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request body is invalid and not meeting business rules."

4. Property EOAP Problem Details Registry > anyOf > Forbidden
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/Forbidden
All of(Requirement)
ProblemDetails
item 1

4.1. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

4.2. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the requested resource (and/or operation combination) is not authorized for the requesting client (and or authorization context). Your client application tried to perform an operation on a resource that it's not authorized to perform in the given context.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

4.2.1. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/forbidden"

4.2.2. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 403

4.2.3. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Forbidden"

4.2.4. Property EOAP Problem Details Registry > anyOf > item 3 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The resource could not be returned as the requestor is not authorized."

5. Property EOAP Problem Details Registry > anyOf > InvalidBodyPropertyFormat
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidBodyPropertyFormat
All of(Requirement)
ProblemDetails
item 1

5.1. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

5.2. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request body contain a malformed property. Your client issued a request that contained a malformed body property. Please review your request and compare against the shared API definition.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

5.2.1. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-body-property-format"

5.2.2. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

5.2.3. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid Body Property Format"

5.2.4. Property EOAP Problem Details Registry > anyOf > item 4 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request body contains a malformed property."

6. Property EOAP Problem Details Registry > anyOf > InvalidBodyPropertyValue
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidBodyPropertyValue
All of(Requirement)
ProblemDetails
item 1

6.1. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

6.2. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request body contains a invalid property value. Your client issued a request that contained an invalid body property value. Please review your request and compare against the shared API definition where applicable.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

6.2.1. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-body-property-value"

6.2.2. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

6.2.3. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid Body Property Value"

6.2.4. Property EOAP Problem Details Registry > anyOf > item 5 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request body contains an invalid body property value."

7. Property EOAP Problem Details Registry > anyOf > InvalidParameters
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidParameters
All of(Requirement)
ProblemDetails
item 1

7.1. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

7.2. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when a client request contains invalid or malformed parameters causing the server to reject the request. Your client application issued a request to an API that contains invalid or malformed parameters.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

7.2.1. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-parameters"

7.2.2. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

7.2.3. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid parameters"

7.2.4. Property EOAP Problem Details Registry > anyOf > item 6 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request contained invalid, or malformed parameters (path or header or query)."

8. Property EOAP Problem Details Registry > anyOf > InvalidRequestHeaderFormat
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidRequestHeaderFormat
All of(Requirement)
ProblemDetails
item 1

8.1. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

8.2. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request contains a malformed request header. Your client issued a request that contained a malformed request header. Please review your request parameters and compare against the shared API definition when applicable.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

8.2.1. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-request-header-format"

8.2.2. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

8.2.3. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid Request Header Format"

8.2.4. Property EOAP Problem Details Registry > anyOf > item 7 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request contains a malformed request header parameter."

9. Property EOAP Problem Details Registry > anyOf > InvalidRequestParameterFormat
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidRequestParameterFormat
All of(Requirement)
ProblemDetails
item 1

9.1. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

9.2. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request contains a malformed query or path parameter. Your client issued a request that contained a malformed query or path parameter. Please review your request parameters and compare against the shared API definition.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

9.2.1. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-request-parameter-format"

9.2.2. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

9.2.3. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid Request Parameter Format"

9.2.4. Property EOAP Problem Details Registry > anyOf > item 8 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request contains a malformed request query parameter."

10. Property EOAP Problem Details Registry > anyOf > InvalidRequestParameterValue
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/InvalidRequestParameterValue
All of(Requirement)
ProblemDetails
item 1

10.1. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

10.2. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request contains a invalid query or path parameter value. Your client issued a request that contained an invalid query or path parameter value. Please review your request and compare against the shared API definition where applicable.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

10.2.1. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/invalid-request-parameter-value"

10.2.2. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

10.2.3. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Invalid Request Parameter Value"

10.2.4. Property EOAP Problem Details Registry > anyOf > item 9 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request body contains an invalid request parameter value."

11. Property EOAP Problem Details Registry > anyOf > LicenseCancelled
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/LicenseCancelled
All of(Requirement)
ProblemDetails
item 1

11.1. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

11.2. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the license associated with the client has been cancelled thus rendering the service unavailable. The license associated with your client/organization has been cancelled. Please contact your account manager or representative.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

11.2.1. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/license-cancelled"

11.2.2. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 503

11.2.3. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "License Cancelled"

11.2.4. Property EOAP Problem Details Registry > anyOf > item 10 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The service is unavailable as the license associated with your client or organization has been cancelled. Please contact your account manager or representative."

12. Property EOAP Problem Details Registry > anyOf > LicenseExpired
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/LicenseExpired
All of(Requirement)
ProblemDetails
item 1

12.1. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

12.2. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the license associated with the client has expired thus rendering the service unavailable. The license associated with your client/organization has expired. Please contact your account manager or representative.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

12.2.1. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/license-expired"

12.2.2. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 503

12.2.3. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "License Expired"

12.2.4. Property EOAP Problem Details Registry > anyOf > item 11 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The service is unavailable as the license associated with your client or organization has expired. Please contact your account manager or representative."

13. Property EOAP Problem Details Registry > anyOf > MissingBodyProperty
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/MissingBodyProperty
All of(Requirement)
ProblemDetails
item 1

13.1. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

13.2. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request sent to the API is missing an expected body property. Your client issued a request that omitted an expected body property.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

13.2.1. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/missing-body-property"

13.2.2. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

13.2.3. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Missing body property"

13.2.4. Property EOAP Problem Details Registry > anyOf > item 12 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request is missing an expected body property."

14. Property EOAP Problem Details Registry > anyOf > MissingRequestHeader
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/MissingRequestHeader
All of(Requirement)
ProblemDetails
item 1

14.1. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

14.2. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request sent to the API is missing an expected request header. Your client issued a request that omitted an expected request header.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

14.2.1. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/missing-request-header"

14.2.2. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

14.2.3. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Missing request header"

14.2.4. Property EOAP Problem Details Registry > anyOf > item 13 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request is missing an expected HTTP request header."

15. Property EOAP Problem Details Registry > anyOf > MissingRequestParameter
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/MissingRequestParameter
All of(Requirement)
ProblemDetails
item 1

15.1. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

15.2. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request sent to the API is missing an query or path parameter. Your client issued a request that omitted an expected query or path par.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

15.2.1. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/missing-request-parameter"

15.2.2. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 400

15.2.3. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Missing request parameter"

15.2.4. Property EOAP Problem Details Registry > anyOf > item 14 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request is missing an expected query or path parameter."

16. Property EOAP Problem Details Registry > anyOf > NotFound
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/NotFound
All of(Requirement)
ProblemDetails
item 1

16.1. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

16.2. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the requested resource could not be found. Your client application tried to access a resource that does not exist (or could not be found).

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

16.2.1. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/not-found"

16.2.2. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 404

16.2.3. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Not Found"

16.2.4. Property EOAP Problem Details Registry > anyOf > item 15 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The requested resource was not found."

17. Property EOAP Problem Details Registry > anyOf > ServerError
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/ServerError
All of(Requirement)
ProblemDetails
item 1

17.1. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

17.2. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the server encounters an unexpected condition that prevents it from fulfilling the request. Your client application did everything correct. Unfortunately our API encountered a condition that resulted in this problem.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

17.2.1. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/server-error"

17.2.2. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 500

17.2.3. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Server Error"

17.2.4. Property EOAP Problem Details Registry > anyOf > item 16 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The server encountered an unexpected error."

18. Property EOAP Problem Details Registry > anyOf > ServiceUnavailable
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/ServiceUnavailable
All of(Requirement)
ProblemDetails
item 1

18.1. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

18.2. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the service requested is currently unavailable and the server is not ready to handle the request. Your client application did everything correct. Unfortunately our API is currently unavailable.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

18.2.1. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/service-unavailable"

18.2.2. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 503

18.2.3. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Service Unavailable"

18.2.4. Property EOAP Problem Details Registry > anyOf > item 17 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The service is currently unavailable."

19. Property EOAP Problem Details Registry > anyOf > Unauthorized
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/Unauthorized
All of(Requirement)
ProblemDetails
item 1

19.1. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

19.2. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the requested resource could not be returned as the client request lacked valid authentication credentials. Your client application issued a requested to a protected resource without supplying the required auth details.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

19.2.1. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/unauthorized"

19.2.2. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 401

19.2.3. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Unauthorized"

19.2.4. Property EOAP Problem Details Registry > anyOf > item 18 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "Access token not set or invalid, and the requested resource could not be returned."

20. Property EOAP Problem Details Registry > anyOf > ValidationError
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/ValidationError
All of(Requirement)
ProblemDetails
item 1

20.1. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > ProblemDetails
Type object
Required No
Additional properties Any type allowed
Same definition as anyOf_i0_allOf_i0

Description: The ProblemDetails object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the RFC9457 (formerly RFC7807). The object is extended with the following properties: - code - a string identifier to aid the provider team better understand the error - errors - and array of errors providing contextual information on the root cause of the problem The ProblemDetails referenced by this domain utilize the EOAP Problems Registry.

20.2. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > item 1
Type object
Required No
Additional properties Any type allowed

Description: This problem occurs when the request is deemed unprocessable. Your client issued a request that failed validation. Certain validation libraries return multi-errors and cannot be easily parsed into discreet types. This problem type, afforded the provider with the ability to surface all validation errors and negate the need for a trial and error workflow on your side. Please review your request to determine if you can remain within appropriate business rules. Consider validating your request against available metadata (e.g. schemas) prior to sending to the server.

Property Pattern Type Deprecated Definition Title/Description
+ type No const No - A URI reference that identifies the problem type.
+ status No const No - The HTTP status code generated by the origin server for this occurrence of the problem.
+ title No const No - A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+ detail No const No - A human-readable explanation specific to this occurrence of the problem.

20.2.1. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > item 1 > type
Type const
Required Yes
Format uri

Description: A URI reference that identifies the problem type.

Specific value: "https://eoap.github.io/problems-registry/validation-error"

20.2.2. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > item 1 > status
Type const
Required Yes
Format int32

Description: The HTTP status code generated by the origin server for this occurrence of the problem.

Specific value: 422

20.2.3. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > item 1 > title
Type const
Required Yes

Description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.

Specific value: "Validation Error"

20.2.4. Property EOAP Problem Details Registry > anyOf > item 19 > allOf > item 1 > detail
Type const
Required Yes

Description: A human-readable explanation specific to this occurrence of the problem.

Specific value: "The request is not valid."

Generated using json-schema-for-humans on 2026-07-02 at 12:01:42 +0200