The filterGetByType Web API Method

Retrieve and display a list of filters.

Version: 1.3

Required Permissions: Read-Only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

type

String

Yes

Type of a filter (issue,job)

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

Response Format: A list of filters

Possible Action Specific Error Codes:

HTTP Code

 Error Code

Description

500

internalServerError

Retrieving a list of filters failed due to an internal problem.

Example

Usage Example

Request

GET /ZendServer/Api/filterGetByType

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>filterGetByType</method>
	</requestData>
	<responseData>
		<filters>
			<filter>
				<id>3</id>
				<name><![CDATA[ErrorsIssues]]</name>
				<type>issue</type>
				<custom>0</custom>
				<data>[]</data>
			</filter>
		</filters>
	</responseData>
<zendServerAPIResponse>