OBJECT

EntityValidationError

Error returned when a record fails validation, with the errors of its fields and step checklist items.

link GraphQL Schema definition

  • type EntityValidationError implements ApiErrorBase {
  • # Numeric error code.
  • code: Int!
  • # Name of the error code, for example ERROR_FIELD_VALIDATION.
  • name: String!
  • # Human-readable description of the error.
  • message: String
  • # Id of the record that failed validation.
  • entityId: UUID
  • # Position of the record, starting at 0, in the relation of its parent record; set
  • # when the record was saved as part of another record.
  • entityIndex: Int
  • # Entity of the record, for example Account.
  • entityName: String
  • # Errors of the record that do not belong to a single field.
  • entityErrors: [FieldError]
  • # Errors of the record, per field.
  • fieldErrors: [FieldError]
  • # Step checklist items of the record that are not completed or not valid.
  • stepChecklistErrors: [StepChecklistError]
  • }

link Require by