GET api/Rule?ruleId={ruleId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ruleId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
RuleDataName | Description | Type | Additional information |
---|---|---|---|
RuleID | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
OrgID | globally unique identifier |
None. |
|
ConnectionID | globally unique identifier |
None. |
|
IsActive | boolean |
None. |
|
SourceType | integer |
None. |
|
RuleActions | RuleActionData |
None. |
|
RuleCriterias | Collection of RuleCriteriaData |
None. |
|
RuleTriggers | RuleTriggerData |
None. |
Response Formats
application/json, text/json
Sample:
{ "RuleID": "064971bd-ee13-4bec-827a-270467011bb6", "Name": "sample string 2", "Description": "sample string 3", "OrgID": "9e5a5ca1-0015-4a16-98d1-2cffa260f1d5", "ConnectionID": "e4ee8ed0-65f5-42cd-9af1-1f61e9fa5a9c", "IsActive": true, "SourceType": 1, "RuleActions": { "ID": "e3efe9d2-a912-491b-9a67-5c4f98a61566", "RuleID": "3f6ee2e9-f3af-4083-a0e8-4ebe3d1ee2e7", "ActionType": 1, "ActionData": "sample string 2", "Data": { "IsAggregate": true, "ScheduleTime": "sample string 1" }, "EmailAction": { "subject": "sample string 1", "toRecepient": "sample string 2", "emailbody": "sample string 3" }, "SupportTicketAction": { "summary": "sample string 1", "ticketbody": "sample string 2", "ticketPriority": "sample string 3", "priorityType": "sample string 4" }, "WebHookAction": { "WebhookURL": "sample string 1", "WebHookMethod": "sample string 2", "WebhookBody": "sample string 3", "requestType": "sample string 4", "HeaderList": [ { "key": "sample string 1", "value": "sample string 2" }, { "key": "sample string 1", "value": "sample string 2" } ] }, "CleanUpAction": { "LogData": [ 1, 2 ], "ResyncData": [ 1, 2 ], "FileData": [ 1, 2 ] }, "CloudResourceAction": { "contextId": "sample string 1", "contextType": "sample string 2", "functionName": "sample string 3" }, "ActionDataObj": { "<subject>k__BackingField": "sample string 1", "<toRecepient>k__BackingField": "sample string 2", "<emailbody>k__BackingField": "sample string 3", "<IsAggregate>k__BackingField": true, "<ScheduleTime>k__BackingField": "sample string 5" } }, "RuleCriterias": [ { "ID": "220060c9-9f11-4123-8b8c-eb366cadf71b", "RuleID": "2cb4a80e-c685-4608-b440-e7ed33b44e0f", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 }, { "ID": "220060c9-9f11-4123-8b8c-eb366cadf71b", "RuleID": "2cb4a80e-c685-4608-b440-e7ed33b44e0f", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 } ], "RuleTriggers": { "ID": "4896117e-2c27-47f3-8490-193c1c399269", "RuleID": "927337a8-4d34-4093-adc6-23b64db24b53", "RuleType": 1, "IsRecurring": true, "RecurringInterval": 1, "RecurranceID": "sample string 2", "RecurranceRule": "sample string 3", "Description": "sample string 4", "EventType": "sample string 5" } }