Class ModelError

Hierarchy

  • ModelError

Constructors

constructor

Properties

category context? correlationId errors? links? message subCategory? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

category

category: string

The error category

Optional context

context?: {
    [key: string]: string[];
}

Context about the error condition

Type declaration

  • [key: string]: string[]

correlationId

correlationId: string

A unique identifier for the request. Include this value with any error reports or support tickets

Optional errors

errors?: ErrorDetail[]

further information about the error

Optional links

links?: {
    [key: string]: string;
}

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

Type declaration

  • [key: string]: string

message

message: string

A human readable message describing the error along with remediation steps where appropriate

Optional subCategory

subCategory?: string

A specific category that contains more specific detail about the error

Static Readonly attributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Type declaration

  • baseName: string
  • format: string
  • name: string
  • type: string

Static Readonly discriminator

discriminator: undefined | string = undefined

Methods

Static getAttributeTypeMap

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc