GET api/v2.0/AutomationRules/GetActiveRulesByType

Retrieves a list of Automation Rules and associated data. Accessible only by Admin Users.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

Integer value corresponding to the Rule Schedule Type to filter by.

RuleScheduleType

Required

Body Parameters

None.

Response Information

Resource Description

List of Rule Schedules.

Collection of RuleSchedule
NameDescriptionTypeAdditional information
RuleScheduleKey

Unique Identifier for an Automation Rule.

globally unique identifier

None.

RuleName

Name of the Automation Rule.

string

None.

RuleDescription

Additional detail about the Automation Rule.

string

None.

RuleTypeName

Name of the Automation Rule Type.

string

None.

GroupName

Group assigned to the Automation Rule (can be empty).

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "RuleScheduleKey": "3e7c219e-8cc3-48da-b6c9-ae6a6c432b01",
    "RuleName": "sample string 2",
    "RuleDescription": "sample string 3",
    "RuleTypeName": "sample string 4",
    "GroupName": "sample string 5"
  },
  {
    "RuleScheduleKey": "3e7c219e-8cc3-48da-b6c9-ae6a6c432b01",
    "RuleName": "sample string 2",
    "RuleDescription": "sample string 3",
    "RuleTypeName": "sample string 4",
    "GroupName": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRuleSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.AutomationRules">
  <RuleSchedule>
    <RuleDescription>sample string 3</RuleDescription>
    <RuleName>sample string 2</RuleName>
    <RuleScheduleKey>3e7c219e-8cc3-48da-b6c9-ae6a6c432b01</RuleScheduleKey>
    <RuleTypeName>sample string 4</RuleTypeName>
  </RuleSchedule>
  <RuleSchedule>
    <RuleDescription>sample string 3</RuleDescription>
    <RuleName>sample string 2</RuleName>
    <RuleScheduleKey>3e7c219e-8cc3-48da-b6c9-ae6a6c432b01</RuleScheduleKey>
    <RuleTypeName>sample string 4</RuleTypeName>
  </RuleSchedule>
</ArrayOfRuleSchedule>