GET api/v2.0/AutomationRules/GetActiveRulesByType

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

Request Information

URI Parameters

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "64a889d1-a1b9-40e5-ba34-9e5783d5040a",
    "RuleName": "sample string 2",
    "RuleDescription": "sample string 3",
    "RuleTypeName": "sample string 4",
    "GroupName": "sample string 5"
  },
  {
    "RuleScheduleKey": "64a889d1-a1b9-40e5-ba34-9e5783d5040a",
    "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>64a889d1-a1b9-40e5-ba34-9e5783d5040a</RuleScheduleKey>
    <RuleTypeName>sample string 4</RuleTypeName>
  </RuleSchedule>
  <RuleSchedule>
    <RuleDescription>sample string 3</RuleDescription>
    <RuleName>sample string 2</RuleName>
    <RuleScheduleKey>64a889d1-a1b9-40e5-ba34-9e5783d5040a</RuleScheduleKey>
    <RuleTypeName>sample string 4</RuleTypeName>
  </RuleSchedule>
</ArrayOfRuleSchedule>