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": "b46fc459-5759-4f19-9557-1c37dd939454", "Name": "sample string 2", "Description": "sample string 3", "OrgID": "9a9fc529-04f6-487d-b4c5-15acfffbbeb9", "ConnectionID": "cdfce239-92f1-4e6a-9094-d2c971b436fd", "IsActive": true, "SourceType": 1, "RuleActions": { "ID": "c56da9c3-10da-414a-85f9-0d7c066700ac", "RuleID": "e5015d90-8be4-4d3e-9391-799ffb7a3f85", "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": "e8693007-acbe-41f2-9c65-3f8034f45748", "RuleID": "ad59976c-0114-4b72-bc47-597e903bf852", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 }, { "ID": "e8693007-acbe-41f2-9c65-3f8034f45748", "RuleID": "ad59976c-0114-4b72-bc47-597e903bf852", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 } ], "RuleTriggers": { "ID": "35853c41-699b-4e4a-bf29-57d6efbe1e47", "RuleID": "ef00074b-97fd-440d-82ec-e5fec3fa95a6", "RuleType": 1, "IsRecurring": true, "RecurringInterval": 1, "RecurranceID": "sample string 2", "RecurranceRule": "sample string 3", "Description": "sample string 4", "EventType": "sample string 5" } }