Get

This API gets the details of a specified media file from Unified CVP.

Parameters of Media File - Get

URL

https://<ipaddress>:8111/cvp-config /mediafile/{path}/{filename}

HTTP Method

GET.

API Type

Synchronous.

Input/Output Format

JSON, XML.

Parameters

Name: summary

Description: Text parameter to indicate whether only file name and path is listed or full details to be listed.

Required: No.

Values: true.

Validations: Only allowed values.

Notes: URL query parameter. Default is false.

Example XML Request Payload

None.

Code Snippets

Sample Java Code


/**
 * Gets the media file details.
 * Query Parameters that can be passes is summary.
*/

private static void getMediafileRequest() {
	Client client = getSSLClient();
	ClientFilter authFilter = new HTTPBasicAuthFilter("wsmadmin", 
"<password set during installation>");
	client.addFilter(authFilter);

	WebResource webResource = null;
	webResource = client.resource("https://<OAMP IP Address>:8111/cvp-config");

	// GET the request
	ClientResponse clientResponse = webResource.path("/mediafile/<path>
/<media file name>").accept(MediaType.APPLICATION_XML_TYPE).
get(ClientResponse.class);
}

Sample Response Header


Response HTTP Status : 200
Response Headers : {Transfer-Encoding=[chunked], 
Date=[Mon, 01 Apr 2013 21:11:53 GMT], Expires=[Wed, 31 Dec 1969 16:00:00 PST], 
Content-Type=[application/xml;charset=utf-8], Server=[Apache-Coyote/1.1], 
Pragma=[No-cache], Cache-Control=[no-cache]
}

Sample XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mediafile>
    <checksum>2b38009592fc258746852002b4044ae2</checksum>
    <downloadURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music13.wav/content</downloadURL>
    <errorflag>false</errorflag>
    <filename>music13.wav</filename>
    <lastaccesstime>2013-04-01T14:11:53-07:00</lastaccesstime>
    <path>en-us</path>
    <refURL>https://10.78.26.124:8111/cvp-config/mediafile/en-us/
music13.wav</refURL>
    <servers>
        <server>
            <cdate>2013-04-01T02:17:12-07:00</cdate>
            <mdate>2013-04-01T02:17:13-07:00</mdate>
            <refURL>https://10.78.26.124:8111/cvp-config/server/
3f89872b-4dec-4021-b2a7-a66c9a77bfd7</refURL>
            <status>CREATED</status>
            <statusdesc>Success</statusdesc>
        </server>
    </servers>
    <size>53437</size>
    <status>CREATED</status>
</mediafile>

Sample JSON Response

{
    mediafile:{
        "checksum": "2b38009592fc258746852002b4044ae2",
        "downloadURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music13.wav/content",
        "errorflag": "false",
        "filename": "music13.wav",
        "lastaccesstime": "2013-04-01T14:11:53-07:00",
        "path": "en-us",
        "refURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music13.wav",
        "servers": {
            "server": {
                "cdate": "2013-04-01T02:17:12-07:00",
                "mdate": "2013-04-01T02:17:13-07:00",
                "refURL": "https://10.78.26.124:8111/cvp-config/server/
                3f89872b-4dec-4021-b2a7-a66c9a77bfd7",
                "status": "CREATED",
                "statusdesc": "Success"
            }
        },
        "size": "53437",
        "status": "CREATED"
    }
}