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": "c3df85ab-f210-45ac-a09e-366e2437e812",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "cc96411d-ad0d-429a-aa44-aeea81e466b7",
"ConnectionID": "743c41ac-e2fc-4691-891b-6c82a06adfe9",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "4a84c9db-2ec5-4f53-ad6d-d9a3077ceef4",
"RuleID": "a67cbf88-85ec-4aee-b09e-b7a8a7cba546",
"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": "17920c1a-be9b-4c49-921e-46879c93fb72",
"RuleID": "2e86ea93-4bfe-4f41-99a4-4f209abf3616",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "17920c1a-be9b-4c49-921e-46879c93fb72",
"RuleID": "2e86ea93-4bfe-4f41-99a4-4f209abf3616",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "9f6870b7-696e-44de-8322-7da9fbce3b1b",
"RuleID": "f2e07d41-b8e8-4e67-86da-ce137bdb6261",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
},
{
"RuleID": "c3df85ab-f210-45ac-a09e-366e2437e812",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "cc96411d-ad0d-429a-aa44-aeea81e466b7",
"ConnectionID": "743c41ac-e2fc-4691-891b-6c82a06adfe9",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "4a84c9db-2ec5-4f53-ad6d-d9a3077ceef4",
"RuleID": "a67cbf88-85ec-4aee-b09e-b7a8a7cba546",
"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": "17920c1a-be9b-4c49-921e-46879c93fb72",
"RuleID": "2e86ea93-4bfe-4f41-99a4-4f209abf3616",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "17920c1a-be9b-4c49-921e-46879c93fb72",
"RuleID": "2e86ea93-4bfe-4f41-99a4-4f209abf3616",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "9f6870b7-696e-44de-8322-7da9fbce3b1b",
"RuleID": "f2e07d41-b8e8-4e67-86da-ce137bdb6261",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
}
]