WoodWing Help Center

Elvis 6 SOAP API - retrieve

Elvis 6 SOAP API - retrieve

Note: The Elvis SOAP Web service has been deprecated. It remains available to allow existing third-party applications or integrations to stay compatible with newer Elvis Server versions. We advise to use the REST API for any new developments.

Below is an example request and response.

Note: The wrapping SOAP envelope and authentication header have been omitted to make the samples easier to read. Detailed documentation about each of the elements and their possible values is provided in the WSDL.

Retrieve request body

Specifies the objects for which to return metadata and/or files.

<e:retrieveRequest xmlns:e="http://www.elvisdam.com/xmlns/elvis/webservice/1.0">
    <e:ids>
        <e:id>9niLL2oWKgK8SixQBgvHWU</e:id>
        <e:id>9KPmoarp4Xl96TA9sYRR2m</e:id>
    </e:ids>
    <!--
        Fields to be returned, do not specify to return all available metadata.
        Unlike the searchResponse, a retrieveResponse can return any metadata field.
    -->
    <e:metadataToReturn>
        <e:field>created</e:field>
        <e:field>fileSize</e:field>
        <e:field>folderPath</e:field>
        <e:field>tags</e:field>
    </e:metadataToReturn>
    <!--
        specifies if original file should be
        returned returned as attachment
    -->
    <e:returnFile>true</e:returnFile>
</e:retrieveRequest>

Retrieve response body

Returns metadata and file for specified assets. If returnFile was true, the asset files will be returned as attachments.

<e:retrieveResponse xmlns:e="http://www.elvisdam.com/xmlns/elvis/webservice/1.0">
    <e:asset id="9niLL2oWKgK8SixQBgvHWU">
        <e:file>
            <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include"
                href="cid:9niLL2oWKgK8SixQBgvHWU@www.elvisdam.com"/>
        </e:file>
        <e:metadata>
            <e:field name="fileSize">
                <e:value>3275199</e:value>
            </e:field>
            <e:field name="extension">
                <e:value>flv</e:value>
            </e:field>
            <e:field name="name">
                <e:value>outsourcing_child.flv</e:value>
            </e:field>
            <e:field name="folderPath">
                <e:value>/Demo Zone/Video/News</e:value>
            </e:field>
            <e:field name="filename">
                <e:value>outsourcing_child.flv</e:value>
            </e:field>
        </e:metadata>
    </e:asset>
    <e:asset id="9KPmoarp4Xl96TA9sYRR2m">
        <e:file>
            <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include"
                href="cid:9KPmoarp4Xl96TA9sYRR2m@www.elvisdam.com"/>
        </e:file>
        <e:metadata>
            <e:field name="fileSize">
                <e:value>6133728</e:value>
            </e:field>
            <e:field name="extension">
                <e:value>mp4</e:value>
            </e:field>
            <e:field name="created">
                <e:value> 1220353185000 </e:value>
            </e:field>
            <e:field name="name">
                <e:value>knowing-trailer.320.mov.mp4</e:value>
            </e:field>
            <e:field name="folderPath">
                <e:value>/Demo Zone/Video/Movie trailers</e:value>
            </e:field>
            <e:field name="filename">
                <e:value>knowing-trailer.320.mov.mp4</e:value>
            </e:field>
        </e:metadata>
    </e:asset>
</e:retrieveResponse>
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.