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

RuleData

Name	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": "780cc592-fc33-4130-ab67-f28777c68d40",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "OrgID": "75603f9b-146e-4e28-9660-fbf71913d34b",
  "ConnectionID": "8431b4e5-ca63-4f44-8d65-3f92d4365106",
  "IsActive": true,
  "SourceType": 1,
  "RuleActions": {
    "ID": "d6e9f788-e8a9-42d2-aa7c-0c62c703226d",
    "RuleID": "f0e24855-e15a-4ee0-84d6-bb768761090b",
    "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": "a55e32cc-901c-490d-8d4d-70fdc2e2a2c6",
      "RuleID": "1aeb6fbf-53ae-445c-b4ba-d7cfb972e03a",
      "AndOr": "sample string 2",
      "ConditionData": "sample string 3",
      "Operator": "sample string 4",
      "Value": "sample string 5",
      "IsActive": true,
      "CriteriaOrder": 1,
      "ConditionGroup": 1
    },
    {
      "ID": "a55e32cc-901c-490d-8d4d-70fdc2e2a2c6",
      "RuleID": "1aeb6fbf-53ae-445c-b4ba-d7cfb972e03a",
      "AndOr": "sample string 2",
      "ConditionData": "sample string 3",
      "Operator": "sample string 4",
      "Value": "sample string 5",
      "IsActive": true,
      "CriteriaOrder": 1,
      "ConditionGroup": 1
    }
  ],
  "RuleTriggers": {
    "ID": "c8f7dbb0-4014-4e42-8570-8521d1390ceb",
    "RuleID": "e69ed69d-adcc-42a6-b385-18dbde5e0909",
    "RuleType": 1,
    "IsRecurring": true,
    "RecurringInterval": 1,
    "RecurranceID": "sample string 2",
    "RecurranceRule": "sample string 3",
    "Description": "sample string 4",
    "EventType": "sample string 5"
  }
}