GET api/Rules/All?orgId={orgId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orgId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of RuleData| Name | 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": "cc21a040-38ae-4299-bc19-c005b51b3e94",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "6e03c769-96cb-4165-84b1-909134e179e3",
"ConnectionID": "7f80cdbc-36e3-44e4-8f85-d1b4f016a755",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "614bd48f-1b82-4066-9a71-bbbfb593539a",
"RuleID": "96d2c8bd-9693-47f8-84da-65f2b7e612c2",
"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": "ba628253-ee3e-4d98-9d89-d3eab54b79f9",
"RuleID": "cc5a8c8e-350b-42f3-8db3-89df118a17b4",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "ba628253-ee3e-4d98-9d89-d3eab54b79f9",
"RuleID": "cc5a8c8e-350b-42f3-8db3-89df118a17b4",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "5e5ce213-9614-411a-9c41-021ff8e44525",
"RuleID": "f0537a95-4de7-4a7a-9df9-dfe0da8d5e97",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
},
{
"RuleID": "cc21a040-38ae-4299-bc19-c005b51b3e94",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "6e03c769-96cb-4165-84b1-909134e179e3",
"ConnectionID": "7f80cdbc-36e3-44e4-8f85-d1b4f016a755",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "614bd48f-1b82-4066-9a71-bbbfb593539a",
"RuleID": "96d2c8bd-9693-47f8-84da-65f2b7e612c2",
"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": "ba628253-ee3e-4d98-9d89-d3eab54b79f9",
"RuleID": "cc5a8c8e-350b-42f3-8db3-89df118a17b4",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "ba628253-ee3e-4d98-9d89-d3eab54b79f9",
"RuleID": "cc5a8c8e-350b-42f3-8db3-89df118a17b4",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "5e5ce213-9614-411a-9c41-021ff8e44525",
"RuleID": "f0537a95-4de7-4a7a-9df9-dfe0da8d5e97",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
}
]