Jump to

• Request
• Response

Check Syntax for a CAPE Node

post

/api/event/Nodes/executeCheckSyntax

Runs the CAPE node file provided in the request body through the CheckSyntax utility and returns the result.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Content: string
  The CAPE node content.
• FileName: string
  The CAPE node name.

{
    "type":"object",
    "properties":{
        "Content":{
            "description":"The CAPE node content.",
            "type":"string"
        },
        "FileName":{
            "description":"The CAPE node name.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "message":{
                    "example":"Syntax Check OK"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• message:
  Example: Syntax Check OK

{
    "type":"object",
    "properties":{
        "message":{
            "example":"Syntax Check OK"
        }
    }
}

Default Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "success":{
                    "example":false
                },
                "message":{
                    "example":"Syntax Check found errors"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• message:
  Example: Syntax Check found errors
• success:
  Example: false

{
    "type":"object",
    "properties":{
        "success":{
            "example":false
        },
        "message":{
            "example":"Syntax Check found errors"
        }
    }
}

Back to Top