Workspace Albums by Status

Lists albums based on library, format, workspace status and tag filters (contains and not contains)

“Workspace status” can be one of these enum values: 

  • "NeverCopied" - either never requested or hasn't successfully transferred to workspace (i.e. was requested but failed)
  • "InWorkspace" - currently available in workspace
  • "MetadataChanged" - metadata has changed on the album since it was last copied to workspace
  • "PreviouslyCopied" - has previously been transferred to workspace


“Containstags” can be a comma separated list of tags that ALL must be contained in the album's tags for the album to be returned in search results.

If nothing is specified, search results won't be filtered by containstags and will return results based on the other parameters in the request (i.e. library, format, workspace status etc)

“notcontainstags” can be a comma separated list of tags that ALL must NOT be contained in the album's tags for the album to be returned in the search results. If nothing is specified, this filter is ignored
as per above

Use getlibraries to get the "libraryid"
Use getaccessinfo to get the desired "format"

 

POST getalbumsbyworkspacestatus/{sessionToken}

Here's an example (will return all albums for the specified library and format which are available in the workspace and have not been tagged with "Downloaded"):

Request:

<requestalbumsbyworkspacestatus>
<libraryid>95f000000e1</libraryid>
<format>0cd000000021</format>
<workspacestatus>InWorkspace</workspacestatus>
<containstags></containstags>
<notcontainstags>Downloaded</notcontainstags>
</requestalbumsbyworkspacestatus>

Response:

<responsealbums>
<albums>
<album featured="false" detail="&quot;Dramatic and intense cues for action, adventure and soaring epic movies.&quot;" displaytitle="FEM 001 Vulcano" keywords="Battle, War, Hero, Mission, Quest, Invasion, Army, Fight, Power, Fired Earth Music, Olympics" id="4d0000000000066">
<linebreaks/>
<codes>
<code systemcode="UPC" name="UPC"/>
</codes>
<styles>
<style>
<id>335</id>
<name>Epic Film Trailers</name>
</style>
</album>
</albums>
</responsealbums>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.