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": "5b690fed-7166-4572-865c-2df054fdac20",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "31ae179e-e9af-454f-b15b-cb3d12ce553d",
"ConnectionID": "5d0cbb97-ca98-4950-ac3f-f389dde571c5",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "f1c32fb0-d606-413a-8f09-884024e9a7eb",
"RuleID": "c9ef77dd-a363-49b5-87ad-ba03aa28a53f",
"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": "90e18646-23f0-4423-a578-c3a77850805c",
"RuleID": "52a7fc92-8572-44e2-9674-069ecc9bb079",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "90e18646-23f0-4423-a578-c3a77850805c",
"RuleID": "52a7fc92-8572-44e2-9674-069ecc9bb079",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "3525be1c-8a59-4299-967c-2812c9e95627",
"RuleID": "fb872d95-292c-4e50-b647-4c9efb438417",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
},
{
"RuleID": "5b690fed-7166-4572-865c-2df054fdac20",
"Name": "sample string 2",
"Description": "sample string 3",
"OrgID": "31ae179e-e9af-454f-b15b-cb3d12ce553d",
"ConnectionID": "5d0cbb97-ca98-4950-ac3f-f389dde571c5",
"IsActive": true,
"SourceType": 1,
"RuleActions": {
"ID": "f1c32fb0-d606-413a-8f09-884024e9a7eb",
"RuleID": "c9ef77dd-a363-49b5-87ad-ba03aa28a53f",
"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": "90e18646-23f0-4423-a578-c3a77850805c",
"RuleID": "52a7fc92-8572-44e2-9674-069ecc9bb079",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
},
{
"ID": "90e18646-23f0-4423-a578-c3a77850805c",
"RuleID": "52a7fc92-8572-44e2-9674-069ecc9bb079",
"AndOr": "sample string 2",
"ConditionData": "sample string 3",
"Operator": "sample string 4",
"Value": "sample string 5",
"IsActive": true,
"CriteriaOrder": 1,
"ConditionGroup": 1
}
],
"RuleTriggers": {
"ID": "3525be1c-8a59-4299-967c-2812c9e95627",
"RuleID": "fb872d95-292c-4e50-b647-4c9efb438417",
"RuleType": 1,
"IsRecurring": true,
"RecurringInterval": 1,
"RecurranceID": "sample string 2",
"RecurranceRule": "sample string 3",
"Description": "sample string 4",
"EventType": "sample string 5"
}
}
]