LinX Result Object

The LinX Result object represents the outcome of an API request and any detailed error messaging. This object is returned for the following APIs:

Attributes

result

object

Whether the LinX workflow or template was created successfully and details for any errors.

successful

boolean

Whether the LinX workflow or template was created successfully.

error

object

LinX workflow or template validation errors.

timestamp

string (date-time)

Date and time of the error.

traceId

string (date-time)

Internal ID used by RocketKOR Support.

message

string

Error message.

errorCode

string

Error code.

errors

object

(Optional) List of detailed errors.

path

string

Path of the request field that caused the error.

message

string

Error message.

errorCode

string

Error code.

fieldErrors

array

Error information by field.

fieldName

string

Name of the field.

fieldCategory

string

Field category.

errorCode

string

Error code.

message

string

Error message.

LinX Result Object

				
					{
  "result": {
  "successful": false,
    "error": {
      "timestamp": "2024-02-02T03:19:01.798Z",
      "traceId": "string",
      "message": "string",
      "errorCode": "string",
      "errors": [
        {
          "path": "fieldName.nestedFieldName",
          "message": "string",
          "errorCode": "string"
        }
      ]
    },
    "fieldErrors": [
      {
        "fieldName": "string",
        "fieldCategory": "string",
        "code": "string",
        "message": "string"
      }
    ]
  }
}