Deep link to an unstructured document - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

The deep link to a Fluid Topics Unstructured Document takes the following form:

/access/sources/{sourceId}/document?$METADATA_1=$METADATA_1_VALUE&$METADATA_2=$METADATA_2_VALUE&...
Path parameter Type Description
{sourceId} String The id parameter of the source used to upload the content.

The {sourceId} parameter is case-sensitive.

Query parameter Type Required? Description
$METADATA_N String Yes The name of the metadata available to target the Unstructured Document.
$METADATA_N_VALUE String Yes The name of the metadata value available to target the Unstructured Document.

Sub-books objects from the Author-it export cannot be accessed via their ID, as they are not considered as "publications".

Example

The "My UD" document has been created using the ud source ID. The following metadata values are available for this document:

  • ft:title: My UD
  • ft:baseId: 8FOPbIlJ8MFqLOC0w8a8wg
  • Category: Training
  • Product: Fluid Topics
  • audience: internal, public

To access the "public" version of this specific document for the "Fluid Topics Training" scope, the following path is possible:

/access/sources/ud/document?ft:title=My UD&Category=Training&Product=Fluid Topics&audience=public

As the ft:baseId of this specific document is 8FOPbIlJ8MFqLOC0w8a8wg, the following path is also possible:

/access/sources/ud/document?ft:baseId=8FOPbIlJ8MFqLOC0w8a8wg

It is then possible to share this document by using either one of the following links:

https://myfluidtopics.com/access/sources/ud/document?ft:baseId=8FOPbIlJ8MFqLOC0w8a8wg
https://myfluidtopics.com/access/sources/ud/document?ft:title=My UD&Category=Training&Product=Fluid Topics&audience=public

All variant values can be used to build a link pointing to a specific publication.