Rules

The following resources are applicable:

/rules

Mount Point: /v2/rules

GET

Returns the list of all the Rules created under the account of the currently connected user.

Response Body

element: rulesResult
media types: application/xml
application/json

The list of requested Rule objects.
The flag rulesEmpty is set to true if no rules exist

POST

Creates a new Rule based on the information provided in RuleCreator parameter.

Request Body

element: ruleCreator
media types: application/xml

Provides the information for the new Rule to be created.

Response Body

element: rule
media types: application/xml

The newly created Rule object.

/rules/{ruleId}

Mount Point: /v2/rules/{ruleId}

The following operations are supported on this resource:

GET

Returns the Rule specified by the "id" path parameter.

Parameters

name description type default
ruleId The id of the Rule requested. path

Response Body

element: rule
media types: application/xml
application/json

The requested Rule object.

PUT

Updates the Rule specified by the "id" path parameter based on the information provided in the Rule parameter.

Parameters

name description type default
ruleId The id of the Rule to be updated. path

Request Body

element: rule
media types: application/xml

The modified Rule whose attributed need to be updated.

Response Body

element: rule
media types: application/xml

The updated rule.

DELETE

Deletes the Rule specified by the "id" path parameter.

Parameters

name description type default
ruleId The id of the Rule to be deleted. path

/rules/actions

Mount Point: /v2/rules/actions

GET

Returns the list of all the Rule Actions available.

Response Body

element: ruleActionInfosResult
media types: application/xml
application/json

The list of requested Rule Actions.