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": "ee1fcd1e-0fc4-4629-9b2b-edcc0a7bae1e", "Name": "sample string 2", "Description": "sample string 3", "OrgID": "e00b7734-ad1e-4e81-ac7a-bccd3f102816", "ConnectionID": "b17dd783-4c3b-4403-861d-eb3e26ab9208", "IsActive": true, "SourceType": 1, "RuleActions": { "ID": "29fbdac9-31e6-41ac-8fa8-2f1f4a6afed5", "RuleID": "3cffa992-fe89-4773-a78c-1e121c7a4543", "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": "3b99e43f-bf3d-49f3-afe7-9f2e6b7d6e1c", "RuleID": "e579d00e-a00f-47b5-ba7d-9e9592475e2f", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 }, { "ID": "3b99e43f-bf3d-49f3-afe7-9f2e6b7d6e1c", "RuleID": "e579d00e-a00f-47b5-ba7d-9e9592475e2f", "AndOr": "sample string 2", "ConditionData": "sample string 3", "Operator": "sample string 4", "Value": "sample string 5", "IsActive": true, "CriteriaOrder": 1, "ConditionGroup": 1 } ], "RuleTriggers": { "ID": "e8b82c5d-9557-4204-a210-6d5a529275e7", "RuleID": "87196019-e1bc-4c70-a37c-fdcc0b93bd1a", "RuleType": 1, "IsRecurring": true, "RecurringInterval": 1, "RecurranceID": "sample string 2", "RecurranceRule": "sample string 3", "Description": "sample string 4", "EventType": "sample string 5" } }