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": "e29aabab-21da-430c-915d-5f63e88fefa7", "Name": "sample string 2", "Description": "sample string 3", "OrgID": "140fe45d-261a-49a6-a6d1-f273ebeedfb2", "ConnectionID": "50d0eef0-516c-440f-aea1-cb1076bfd2be", "IsActive": true, "SourceType": 1, "RuleActions": { "ID": "dbda0c6b-cb89-4b38-958e-840ee078a53a", "RuleID": "6aad15bb-be63-4b17-90e6-bb5ec899eb16", "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": "041f6fba-a66e-43cd-9bf4-5c4f017595e7", "RuleID": "673a3763-77bb-4033-a95e-d626139bdd03", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 }, { "ID": "041f6fba-a66e-43cd-9bf4-5c4f017595e7", "RuleID": "673a3763-77bb-4033-a95e-d626139bdd03", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 } ], "RuleTriggers": { "ID": "e24658e3-0369-43ac-be5a-de946c557d2b", "RuleID": "8ba62f58-59f1-4b03-b06c-e6cf7b3e7e3f", "RuleType": 1, "IsRecurring": true, "RecurringInterval": 1, "RecurranceID": "sample string 2", "RecurranceRule": "sample string 3", "Description": "sample string 4", "EventType": "sample string 5" } }