Web API Reference Guide > Available API Methods > Z-Ray Methods > The zrayGetCustomData Method

The zrayGetCustomData Method

Get all custom data stored for the current request. Custom data is collected using the ZRayExtension class API and is stored with the official data collected by ZRay’s default operations. Custom data can be formatted in any way the extension is designed to hold. This may mean an unusually large payload.

Version: 1.9

Required Permissions: Read-only

HTTP method: GET

Supported Editions: Zend Server

Request parameters:

Parameter

 Type

Required

Description

requestId

Integer

Yes

The request ID of the environment information to retrieve.

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

Response Format:

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request (headers removed for the purpose of clarity)

GET/ZendServer/Api/zrayGetCustomData?requestId=14

Response (not all headers are shown)

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.9">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>zrayGetCustomData</method>

</requestData>

<responseData>

<zrayExtensions>

<zrayExtension>

<extensionName>zf2</extensionName>

<datatypes>

<datatype>events</datatype>

<datatype>modules</datatype>

</datatypes>

</zrayExtension>

...

</zrayExtensions>

<zrayExtensionsData>

<zrayExtensionParameters>

<extensionName>zf2</extensionName>

<datatype>events</datatype>

<parameters>

<parameterMap>

<name><![CDATA[0]]></name>

<type>array</type>

<parameters>

<parameterMap>

<name><![CDATA[‘event_route’]]></name>

<type>array</type>

<parameters>

<parameter>

<name><![CDATA[target]]></name>

<value><![CDATA[Resolver]]></value>

</parameter>

<parameter>

<name><![CDATA[listener]]></name>

<value><![CDATA[match]]></value>

</parameter>

...

</parameters>

</parameterMap>

...

</parameters>

</parameterMap>

</parameters>

</zrayExtensionParameters>

...

</zrayExtensionsData>

</responseData>

</zendServerAPIResponse>

   
   
 

Read Also

  Available API Methods    
  Z-Ray Methods