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": "d1726cef-344a-40a4-8fb8-ae85902f4363",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "cd8096c5-1973-4982-af0f-1b0a41e8326a",
"ConnectionID": "5de5c20d-85b7-49f7-968a-607963fe86a3",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "cf261982-2acd-48ce-a48c-b6159b755f1d",
"RuleID": "4ba53b5e-4f5f-4c3d-92da-b1ec2afc2f9b",
"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": "22a3bc49-a2d3-4039-bedd-ebd9400906bc",
"RuleID": "d94446a0-9e8d-420d-8379-380a672fa776",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "22a3bc49-a2d3-4039-bedd-ebd9400906bc",
"RuleID": "d94446a0-9e8d-420d-8379-380a672fa776",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "9e7dd75b-10f7-459d-814f-dff7ab6ab920",
"RuleID": "3b914f47-9d5c-4a08-8d91-07c862681ac8",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
},
{
"RuleID": "d1726cef-344a-40a4-8fb8-ae85902f4363",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "cd8096c5-1973-4982-af0f-1b0a41e8326a",
"ConnectionID": "5de5c20d-85b7-49f7-968a-607963fe86a3",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "cf261982-2acd-48ce-a48c-b6159b755f1d",
"RuleID": "4ba53b5e-4f5f-4c3d-92da-b1ec2afc2f9b",
"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": "22a3bc49-a2d3-4039-bedd-ebd9400906bc",
"RuleID": "d94446a0-9e8d-420d-8379-380a672fa776",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "22a3bc49-a2d3-4039-bedd-ebd9400906bc",
"RuleID": "d94446a0-9e8d-420d-8379-380a672fa776",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "9e7dd75b-10f7-459d-814f-dff7ab6ab920",
"RuleID": "3b914f47-9d5c-4a08-8d91-07c862681ac8",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
}
]