This operation returns the list of MediaAgents accessing a library.
Request
Syntax
GET <webservice>/MediaAgentForLibrary?LibraryId={libraryId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name | Description |
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
libraryId | The library ID for the library. If the library ID is not known, use the GET Library API to retrieve it. |
Response
Response Parameters
Parameter | Description | Element |
status | The status of the MediaAgent. | mediaAgentList |
platform | The operating system of the MediaAgent. | mediaAgentList |
osVersion | The version of operating system of the MediaAgent. | mediaAgentList |
mediaAgentName | The name of the MediaAgent. | mediaAgentList |
mediaAgentId | The system-generated ID assigned for the MediaAgent. | mediaAgentList |
libraryType | The library type. | mediaAgentList |
description | The library description. | mediaAgentList |
Examples
Sample Request
GET <webservice>/MediaAgentForLibrary?LibraryId=2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<EVGui_GetMediaAgentListWCResp>
<mediaAgentList status="Ready" platform="WinX64" osVersion="Windows Server 2012 R2 Standard" mediaAgentName="mmtest1" mediaAgentId="2" libraryType="0" description=""/>
</EVGui_GetMediaAgentListWCResp>