The monitorGetIssuesListByPredefinedFilter Method

Retrieve a list of monitor issues according to a preset filter identifier.
The filter identifier is shared with the UI's predefined filters.
This WebAPI method may also accept ordering details and paging limits.

The response is a list of issue elements with their general details and event-groups identifiers.
license New BSD License
link for the canonical source repository
author Ingo Walz
category Zend
package Zend_Service
subpackage ZendServerAPI

 Methods

Base constructor for the method implementations

__construct() 
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::__construct()

Returns the parameter array for index $index

buildParameterArray(string $index, array $values) : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::buildParameterArray()

Parameters

$index

string

$values

array

Returns

string

Configures all needed information for the method implementation

configure() : void

Returns the accept header

getAcceptHeader() : string

Returns

string

Returns the default content type

getContentType() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getContentType()

Returns

string

Get the values for preparing the post

getContentValues() : array
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getContentValues()

Returns

array

Getter for the path to server method

getFunctionPath() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getFunctionPath()

Returns

string

Get method for the api call

getMethod() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getMethod()

Returns

string

Get class for result mapping

getParser() : \ZendService\ZendServerAPI\Adapter\Adapter
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getParser()

Returns

Returns the default post files

getPostFiles() : array
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getPostFiles()

Returns

array

Get result from parser

parseResponse(string $xml) : \ZendService\ZendServerAPI\Method\DataTypes\DataType
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::parseResponse()

Parameters

$xml

string

Returns

\ZendService\ZendServerAPI\Method\DataTypes\DataType

Set arguments MonitorGetIssuesListByPredefinedFilter

setArgs(string $filterId, Integer | null $limit, Integer | null $offset, string | null $order, string | null $direction) : \ZendService\ZendServerAPI\Method\MonitorGetIssuesListByPredefinedFilter

Retrieve a list of monitor issues according to a preset filter identifier. The filter identifier is shared with the UI's predefined filters. This WebAPI method may also accept ordering details and paging limits. The response is a list of issue elements with their general details and event-groups identifiers.

Parameters

$filterId

string

The predefined filter's id

$limit

Integernull

The number of rows to retrieve

$offset

Integernull

A paging offset to begin the issues list from

$order

stringnull

Column identifier for sorting the result set

$direction

stringnull

Sorting direction: Ascending or Descending

Returns

Setter for the function path

setFunctionPath(string $functionPath) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setFunctionPath()

Parameters

$functionPath

string

e.g. /ZendServerManager/Api/Foo

Set method for the api call

setMethod(string $method) 
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setMethod()

Parameters

$method

string

GET|POST

Set the implementation for the result mapping

setParser(\ZendService\ZendServerAPI\Adapter\Adapter $parser) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setParser()

Parameters

$parser

\ZendService\ZendServerAPI\Adapter\Adapter

for result mapping

Set the Zend HTTP Response

setResponse(\Zend\Http\Response $response) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setResponse()

Parameters

$response

\Zend\Http\Response

 Properties

 

$direction : string

Default is DESC

 

$filterId : string

Can be the filter's “name” or the actual identifier randomly created by the system. This parameter is case-sensitive

 

$functionPath : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$functionPath
 

$limit : Integer

Default lists all events up to an arbitrary limit set by the system

 

$method : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$method
 

$offset : Integer

Default is 0

 

$order : string

Default is date

 

$parser : \ZendService\ZendServerAPI\Adapter\Adapter
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$parser