The libraryCheckDependents Web API Method

Check if a library has another application or library which depends on it. Should this library and its versions be removed, the dependent application or library may cease to function. A valid result means this library has no dependents that will fail if it were removed. Note that this action is very similar to libraryVersionCheckDependents and is different only in that it checks for all versions of the library, not just a single one.

Version: 1.5

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

libraryId

Integer

Yes

A library version id for checking prerequisites.

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

Response Type: prerequisitesCheck

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

Example

Usage Example

Request

GET /ZendServer/Api/libraryCheckDependents?libraryVersionId=13

Response

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

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

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>libraryCheckDependents</method>

</requestData>

<responseData>

<prerequsitesCheck>

<valid>Yes</valid>

<type>library</type>

<identifier>13</identifier>

</prerequsitesCheck>

</responseData>

</zendServerAPIResponse>