retrieve

Syntax

Dossiers.retrieve(id);

Parameters

id string

The object ID of the Dossier to retrieve from Studio Server.

Return value Dossier

The retrieved Dossier object.

Description

The retrieve() method fetches an existing Dossier from Studio Server by its object ID and adds it to the Dossiers collection. The returned Dossier object is populated with the metadata and items from Studio Server.

Examples

Retrieve a dossier and read its name

// Retrieve an existing dossier from Studio Server.
var dossier = app.dossiers.retrieve("456");
var name = dossier.entMetaData.get("Core_Name");
alert("Dossier name: " + name);

Retrieve a dossier and list its items

// Retrieve a dossier and display all item IDs it contains.
var dossier = app.dossiers.retrieve("456");
var items = dossier.items;
for (var i = 0; i < items.length; i++) {
    alert("Item ID: " + items[i]);
}

Supported versions