Web API Reference Guide > Available API Methods > Audit Methods > The auditGetDetails Method

The auditGetDetails Method

Get all details available on a particular audit item.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

auditId

Integer

Yes

Audit ID to get all details for

Expected Response Code: 200 OK.

Response Type: auditMessageDetails

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

Example

Usage Example

Request (headers removed for the purpose of clarity)

GET /ZendServer/Api/auditGetDetails?auditId=3

Response (not all headers are shown)

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

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

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>auditGetDetails</method>

</requestData>

<responseData>

<auditMessageDetails>

<auditMessage>

<id>3</id>

<username><![CDATA[admin]]</username>

<requestInterface>webAPI</requestInterface>

<remoteAddr>192.168.10.11</remoteAddr>

<auditType>AUDIT_DIRECTIVES_MODIFIED</auditType>

<auditTypeTranslated><![CDATA[.]]></auditTypeTranslated>

<baseUrl>![CDATA[]]</baseUrl>

<creationTime>2012-06-19T08:18:25</creationTime>

<extraData>

<extraDataMessage>

<parameter>

<name>name</name>

<value>session.cache_expire</value>

</parameter>

<parameter>

<name>oldValue</name>

<value>180</value>

</parameter>

<parameter>

<name>newValue</name>

<value>181</value>

</parameter>

</extraDataMessage>

</extraData>

</auditMessage>

<auditProgressList>

<auditProgress>

<progressId>4</progressId>

<auditId>3</auditId>

<serverId>12</serverId>

<serverIp>10.1.1.4</serverIp>

<serverName>My own server</serverName>

<creationTime>...</creationTime>

<progress>PROGRESS_REQUESTED</progress>

<extraData>

<extraDataMessage>

<parameter>

<name>name</name>

<value>session.cache_expire</value>

</parameter>

<parameter> <name>oldValue</name>

<value>180</value>

</parameter>

<parameter>

<name>newValue</name>

<value>181</value>

</parameter>

</extraDataMessage>

</extraData>

</auditProgress>

</auditProgressList>

<totalCount>1</totalCount>

</auditMessageDetails>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Audit Methods