Interface: ErrorResponse
clients/platform-client/src.ErrorResponse
Export
ErrorResponse
Properties
data
data?:
object
additional data that can be used by the client to handle the error
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:266
detail
detail:
string
detail of the error, comprehensive message for the end user (e.g. 'customer with id 12344321 not found')
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:260
instance
instance:
string
error instance, unique identifier for this particular occurrence of the problem
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:272
status
status:
number
http status code of the error, e.g. 404
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:254
title
title:
string
title of the error, short description
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:248
type
type:
string
link to the docs with more details about the error
Memberof
ErrorResponse
Source
libs/clients/platform-client/src/lib/generated/api.ts:242
Generated using typedoc-plugin-markdown and TypeDoc