Document toolboxDocument toolbox

Vidispine

How to retrieve the Item-ID from a File-ID

Below is a user case scenario from a customer that needs to retrieve the Item-ID.

Customer;

"Our movies are moved and automatically imported. I can find out the File-ID with "http://localhost:8080/API/storage/VX-2/file/byURI;path=2016%2F10%2F2016-10-02_23-20_1106_test.mov",but i need the ITEM-ID to fetch out the thumbnails/posters. How can I do that if I have only the FILE-ID?"

Resolution;

To get different file details, you can use the "includeitem" parameter, see below;

 GET {storage-resource}/file;includeItem=true 

Your outcome will be a list of all files with their specific file details.

The item id will be in the response, if the item belongs to an item. Example:

<file> <id>VX-1027</id> <path>VX-1027.mov</path> <state>CLOSED</state> <size>47712885</size> <hash>5ba56a996de14b68a7c8f37c08ddeb74dbea8fdc</hash> <timestamp>2013-06-24T15:39:26.117+02:00</timestamp> <refreshFlag>8418</refreshFlag> <storage>VX-1</storage> <item> <id>VX-804</id> <shape> <id>VX-916</id> <component> <id>VX-1488</id> </component> <component> <id>VX-1487</id> </component> <component> <id>VX-1486</id> </component> </shape> </item> <metadata/> </file>

There are more values you can use in the link below;

http://apidoc.vidispine.com/latest/ref/storage/file.html?highlight=includeitem#get-{storage-resource}-file