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": "76c77599-c3ce-455e-80e3-5f24fca747c0", "Name": "sample string 2", "Description": "sample string 3", "OrgID": "9e3981f0-a0fa-42c5-9c76-d2e9ec09ca92", "ConnectionID": "f8dd9a96-a356-460a-823c-3d71246dfa15", "IsActive": true, "SourceType": 1, "RuleActions": { "ID": "5a8e1dba-993b-467b-88fb-7f5105adf550", "RuleID": "9a565081-b540-4375-89a4-563afba927d9", "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": "1cbf5a9e-3221-4303-ae51-4ea3beb3e6c8", "RuleID": "b103ad7e-0852-4ea3-8126-b62a6fb94297", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 }, { "ID": "1cbf5a9e-3221-4303-ae51-4ea3beb3e6c8", "RuleID": "b103ad7e-0852-4ea3-8126-b62a6fb94297", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 } ], "RuleTriggers": { "ID": "ae32efe7-f639-441a-90e8-88d30f80b902", "RuleID": "c0439d0f-83b3-4fab-ad8f-1a4019d4c386", "RuleType": 1, "IsRecurring": true, "RecurringInterval": 1, "RecurranceID": "sample string 2", "RecurranceRule": "sample string 3", "Description": "sample string 4", "EventType": "sample string 5" } }