List

Gets a list of media files existing in Unified CVP.

Parameters of Media File - List

URL

https://<ipaddress>:8111/cvp-config /mediafile

HTTP Method

GET.

API Type

Synchronous.

Input/Output Format

JSON, XML.

Parameters

The following query parameters are specified using (q=) syntax.

Name: filename

Description: Text parameter with first few letters of file.

Required: No.

Validations: Should not contain any starting wildcard characters.

Name : path

Description: Text parameter with the path name.

Required: No.

Values: Should be one of the internal path names.

Validations: No wild characters allowed.

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.

Name : startIndex

Description: Starting index of the result list.

Required : No.

Values: Zero-based: 0 is the first element. DEFAULT = 0.

Validations: zero or more.

Notes : URL query parameter.

Name : resultsPerPage

Description: Specifies number of elements to retrieve.

Required : No.

Values : MIN=1. DEFAULT=25 MAX=50

Validations : One or more.

Notes:

URL query parameter.

Code Snippets

Sample JAVA code


/**
 * Lists all the media files.
 * Query Parameters that can be passes are query string, summary, start index, 
results per page.
*/

private static void listMediafileRequest() {
	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").
accept(MediaType.APPLICATION_XML_TYPE).get(ClientResponse.class);
}

Sample Response Header


Response Status : 200
Response Headers : {Transfer-Encoding=[chunked], 
Date=[Mon, 08 Apr 2013 14:44:19 GMT], Expires=[Wed, 31 Dec 1969 16:00:00 PST], 
Content-Type=[application/octet-stream], Server=[Apache-Coyote/1.1], 
Pragma=[No-cache], Cache-Control=[no-cache]
}

Sample XML Response


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <pageInfo>
        <resultsPerPage>25</resultsPerPage>
        <startIndex>0</startIndex>
        <totalResults>4</totalResults>
    </pageInfo>
    <mediafiles>
        <mediafile>
            <checksum>2b38009592fc258746852002b4044ae2</checksum>
            <downloadURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music.wav/content</downloadURL>
            <errorflag>false</errorflag>
            <filename>music.wav</filename>
            <lastaccesstime>04-01-2013:07:07:14</lastaccesstime>
            <path>en-us</path>
            <refURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music.wav</refURL>
            <servers>
                <server>
                    <cdate>03-31-2013:07:12:34</cdate>
                    <mdate>03-31-2013:07:12:34</mdate>
                    <refURL>https://10.78.26.124:8111/cvp-config/server/
8cb1f705-1199-4226-b29d-bb8ddc07cc68</refURL>
                    <status>CREATED</status>
                    <statusdesc>Success</statusdesc>
                </server>
            </servers>
            <size>53437</size>
            <status>CREATED</status>
        </mediafile>
        <mediafile>
            <checksum>2b38009592fc258746852002b4044ae2</checksum>
            <downloadURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music1.wav/content</downloadURL>
            <errorflag>false</errorflag>
            <filename>music1.wav</filename>
            <lastaccesstime>04-01-2013:07:18:03</lastaccesstime>
            <path>en-us</path>
            <refURL>https://10.78.26.124:8111/cvp-config/mediafile/en-us/
music1.wav</refURL>
            <servers>
                <server>
                    <cdate>03-31-2013:07:23:22</cdate>
                    <mdate>03-31-2013:07:23:22</mdate>
                    <refURL>https://10.78.26.124:8111/cvp-config/server/
8cb1f705-1199-4226-b29d-bb8ddc07cc68</refURL>
                    <status>CREATED</status>
                    <statusdesc>Success</statusdesc>
                </server>
            </servers>
            <size>53437</size>
            <status>CREATED</status>
        </mediafile>
        <mediafile>
            <checksum>2b38009592fc258746852002b4044ae2</checksum>
            <downloadURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music11.wav/content</downloadURL>
            <errorflag>false</errorflag>
            <filename>music11.wav</filename>
            <lastaccesstime>04-01-2013:07:44:19</lastaccesstime>
            <path>en-us</path>
            <refURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music11.wav</refURL>
            <servers>
                <server>
                    <cdate>03-31-2013:07:49:39</cdate>
                    <mdate>03-31-2013:07:49:39</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>
        <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>04-01-2013:02:11:53</lastaccesstime>
            <path>en-us</path>
            <refURL>https://10.78.26.124:8111/cvp-config/mediafile/
en-us/music13.wav</refURL>
            <servers>
                <server>
                    <cdate>04-01-2013:02:17:12</cdate>
                    <mdate>04-01-2013:02:17:13</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>
    </mediafiles>
</results>

Sample JSON Response


{
    "results":{
        "pageInfo": {
            "resultsPerPage": "25",
            "startIndex": "0",
            "totalResults": "4"
        },
        "mediafiles": {
            "mediafile":[
             {
                  "checksum": "2b38009592fc258746852002b4044ae2",
                   "downloadURL": "https://10.78.26.124:8111/cvp-config/mediafile/
                en-us/music.wav/content",
                   "errorflag": "false",
                    "filename": "music.wav",
                    "lastaccesstime": "04-01-2013:07:07:14",
                 "path": "en-us",
                 "refURL": "https://10.78.26.124:8111/cvp-config/mediafile/
             en-us/music.wav",
                    "servers": {
                       "server" :{
                           "cdate": "03-31-2013:07:12:34",
                           "mdate": "03-31-2013:07:12:34",
                            "refURL": "https://10.78.26.124:8111/cvp-config/server/
                     8cb1f705-1199-4226-b29d-bb8ddc07cc68",
                           "status": "CREATED",
                          "statusdesc": "Success"
                     }
                     },
                     "size": "53437",
                     "status": "CREATED"
            },
            {
                "checksum": "2b38009592fc258746852002b4044ae2",
                "downloadURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music1.wav/content",
                 "errorflag": "false",
                 "filename": "music1.wav",
                 "lastaccesstime": "04-01-2013:07:18:03",
                 "path": "en-us",
                 "refURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music1.wav",
                 "servers": {
                    "server": {
                       "cdate": "03-31-2013:07:23:22",
                       "mdate": "03-31-2013:07:23:22",
                       "refURL": "https://10.78.26.124:8111/cvp-config/server/
        8cb1f705-1199-4226-b29d-bb8ddc07cc68",
                       "status": "CREATED",
                       "statusdesc": "Success"
                    }
                 },
                 "size": "53437",
                 "status": "CREATED"
            },
            {
                "checksum": "2b38009592fc258746852002b4044ae2",
                "downloadURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music11.wav/content",
                 "errorflag": "false",
                 "filename": "music11.wav",
                 "lastaccesstime": "04-01-2013:07:44:19",
                 "path": "en-us",
                 "refURL": "https://10.78.26.124:8111/cvp-config/mediafile/
        en-us/music11.wav",
                 "servers": {
                    "server": {
                       "cdate": "03-31-2013:07:49:39",
                       "mdate": "03-31-2013:07:49:39",
                       "refURL": "https://10.78.26.124:8111/cvp-config/
        server/3f89872b-4dec-4021-b2a7-a66c9a77bfd7",
                       "status": "CREATED",
                       "statusdesc": "Success"
                    }
                 },
                 "size": "53437",
                 "status": "CREATED"
            },
            {
                "checksum": "2b38009592fc258746852002b4044ae2",
                "downloadURL": "https://10.78.26.124:8111/cvp-config/
        mediafile/en-us/music13.wav/content",
                 "errorflag": "false",
                 "filename": "music13.wav",
                 "lastaccesstime": "04-01-2013:02:11:53",
                 "path": "en-us",
                 "refURL": "https://10.78.26.124:8111/cvp-config/
        mediafile/en-us/music13.wav",
                 "servers": {
                    "server":
                    {
                       "cdate": "04-01-2013:02:17:12",
                       "mdate": "04-01-2013:02:17:13",
                       "refURL": "https://10.78.26.124:8111/cvp-config/
        server/3f89872b-4dec-4021-b2a7-a66c9a77bfd7",
                       "status": "CREATED",
                       "statusdesc": "Success"
                    }
                 },
                 "size": "53437",
                 "status": "CREATED"
            }
        ]
        }
    }
    }