Jump to

• Request
• Response

Create an Event Mechanization

post

/api/event/Mechanizations/

Creates a new event mechanization.
The minimum required properties in the request body are:

• EventMechanizationName
• Description
• Minutes
• Hours
• Days
• Months
• WeekDays
• StatusID
• StoredProcedure

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

• Days: string
  Scheduled Job cron-type Days to execute (* or comma delimited ints)

  Example: *
• Description: string
  Mechanization Description

  Example: Update all matching problems and resolutions to normal severity and set expiration to 10 minutes
• EventMechanizationName: string
  The event mechanization name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: CorrelateProblemResolutions
• Hours: string
  Scheduled Job cron-type Hours to execute (* or comma delimited ints)

  Example: *
• Minutes: string
  Scheduled Job cron-type Minutes to execute (* or comma delimited ints)

  Example: 0,5,10,15,20,25,30,35,40,45,50,55
• Months: string
  Scheduled Job cron-type Months to execute (* or comma delimited ints)

  Example: *
• StatusID: integer
  The mechanization status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• StoredProcedure: string
  Mechanization Logic
• WeekDays: string
  Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)

  Example: *

{
    "type":"object",
    "properties":{
        "EventMechanizationName":{
            "description":"The event mechanization name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"CorrelateProblemResolutions"
        },
        "Description":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/Description"
        },
        "StoredProcedure":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/StoredProcedure"
        },
        "Minutes":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/Minutes"
        },
        "Hours":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/Hours"
        },
        "Days":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/Days"
        },
        "Months":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/Months"
        },
        "WeekDays":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/WeekDays"
        },
        "StatusID":{
            "$ref":"#/components/schemas/eventMechanizationsRead/properties/StatusID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new event mechanization.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventMechanizationsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

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

{
    "description":"The response body for a successful add operation.",
    "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

• data: array data
  The properties of the new event mechanization.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new event mechanization.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventMechanizationsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new event mechanization.

Show Source

• Array of: object eventMechanizationsRead

{
    "description":"The properties of the new event mechanization.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventMechanizationsRead"
    }
}

Nested Schema : eventMechanizationsRead

Type: object

Show Source

• Days: string
  Scheduled Job cron-type Days to execute (* or comma delimited ints)

  Example: *
• Description: string
  Mechanization Description

  Example: Update all matching problems and resolutions to normal severity and set expiration to 10 minutes
• EventMechanizationID: integer
  The event mechanization ID.

  Example: 2
• EventMechanizationName: string
  Mechanization Name

  Example: CorrelateProblemResolutions
• Hours: string
  Scheduled Job cron-type Hours to execute (* or comma delimited ints)

  Example: *
• Minutes: string
  Scheduled Job cron-type Minutes to execute (* or comma delimited ints)

  Example: 0,5,10,15,20,25,30,35,40,45,50,55
• Months: string
  Scheduled Job cron-type Months to execute (* or comma delimited ints)

  Example: *
• Status: string
  Says if it is Enabled/Disabled

  Example: Enabled
• StatusIcon: string
  Icon for the Status

  Example: OrbGreen.png
• StatusID: integer
  The mechanization status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• StoredProcedure: string
  Mechanization Logic
• WeekDays: string
  Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)

  Example: *

{
    "type":"object",
    "properties":{
        "EventMechanizationID":{
            "description":"The event mechanization ID.",
            "type":"integer",
            "example":"2"
        },
        "EventMechanizationName":{
            "description":"Mechanization Name",
            "type":"string",
            "example":"CorrelateProblemResolutions"
        },
        "Description":{
            "description":"Mechanization Description",
            "type":"string",
            "example":"Update all matching problems and resolutions to normal severity and set expiration to 10 minutes"
        },
        "Minutes":{
            "description":"Scheduled Job cron-type Minutes to execute (* or comma delimited ints)",
            "type":"string",
            "example":"0,5,10,15,20,25,30,35,40,45,50,55"
        },
        "Hours":{
            "description":"Scheduled Job cron-type Hours to execute (* or comma delimited ints)",
            "type":"string",
            "example":"*"
        },
        "Days":{
            "description":"Scheduled Job cron-type Days to execute (* or comma delimited ints)",
            "type":"string",
            "example":"*"
        },
        "Months":{
            "description":"Scheduled Job cron-type Months to execute (* or comma delimited ints)",
            "type":"string",
            "example":"*"
        },
        "WeekDays":{
            "description":"Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)",
            "type":"string",
            "example":"*"
        },
        "StatusID":{
            "description":"The mechanization status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "Status":{
            "description":"Says if it is Enabled/Disabled",
            "type":"string",
            "example":"Enabled"
        },
        "StatusIcon":{
            "description":"Icon for the Status",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "StoredProcedure":{
            "description":"Mechanization Logic",
            "type":"string"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

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

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top