Get an Event Mechanization by ID
get
/api/event/Mechanizations/{id}
Gets the event mechanization that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The event mechanization ID.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventMechanizationsRead
Type:
Show Source
object
-
Days: string
Scheduled Job cron-type Days to execute (* or comma delimited ints)Example:
*
-
Description: string
Mechanization DescriptionExample:
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 NameExample:
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/DisabledExample:
Enabled
-
StatusIcon: string
Icon for the StatusExample:
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:
*
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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.
Nested Schema : items
Type:
object
An error.