The filterSave Web API Method

Save a filter.

Version: 1.3

Required Permissions: Read-Only

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
id	Integer	No	ID of a filter.
type	String	Yes	Type of a filter (issue,job)
name	String	Yes	Name of filter. Name must be unique for a specific type of filter.
data	Array	No	Array of parameters to be saved.

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: Saved filter.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	internalServerError	Saving a filter failed due to an internal problem.

Example

Usage Example

Request

POST /ZendServer/Api/filterSave
name=Test&type=issue&data%5BeventTypes%5D%5B0%5D=request-large-mem-usage&data%5BeventTypes%5D%5B1%5D=jq-job-exec-delay&data%5Bseverities%5D%5B0%5D=critical

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse >
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>filterSave</method>
	</requestData>
	<responseData>
		<filters>
			<filter>
				<id>3</id>
				<name><![CDATA[ErrorsIssues]]</name>
				<type>issue</type>
				<custom>0</custom>
				<data>{"statuses":[],"severities":["critical"],"eventTypes":["request-large-mem-usage","jq-job-exec-delay"]}</data>
			</filter>
		</filters>
	</responseData>
<zendServerAPIResponse>