POST/projects/api/v3/customitems/{customItemId}/fields/validate-formula.json

Validate a custom item formula expression.

Validates a candidate formula against the custom item's existing field schema without persisting anything. Returns the formula's output unit on success, or a list of structured errors describing what is wrong.

Path Params

  • Name
    customItemId
    Type
    integer
    required
    Description

Body Params

VerifyFormulaRequest is the body of POST /customitems/{customItemId}/fields/validate-formula.json. FieldID is the field being edited; omit it when validating a brand-new field.

    • Name
      fieldId
      Type
      integer
    • Name
      formula
      Type
      string

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      VerifyFormulaResponse is the body of POST /customitems/{customItemId}/fields/validate-formula.json. Unit is the formula's output unit; Errors is populated when validation failed.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    200 OK

    VerifyFormulaResponse
    {
      "errors": [
        {
          "code": "string",
          "detail": "string",
          "id": "string",
          "meta": {},
          "title": "string"
        }
      ],
      "unit": "string"
    }