Deep link to an Author-it topic - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

The deep link to the topic of a Fluid Topics book using Author-it-generated contents takes the following form:

/access/sources/{sourceId}/topic?ait:code=$OBJECT_ID&$VARIANT_1=$VARIANT_1_VALUE&$VARIANT_2=$VARIANT_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
$OBJECT_ID String Yes The "Object code" of the book as generated by Author-it.
$VARIANT_N String Yes The name of the variant as created in Author-it. It can be a variant used to generate a facet or not.
$VARIANT_N_VALUE String Yes The name of the variant as created in Author-it.

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

Example

The "My Topic" topic has been created in Author-it. The following variant values have been applied:

  • Version: 3.1
  • Product: Fluid Topics
  • Platform: RHEL, Debian
  • Audience: internal, public

To access the "public" version of this specific topic for "RHEL", the following path is possible:

/access/sources/ait/topic?ft:topicTitle=My Topic&Audience=public&Platform=RHEL

If the "Object code" of this specific topic is 56789, the following path is also possible:

/access/sources/ait/topic?ait:code=56789

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

https://myfluidtopics.com/access/sources/ait/topic?ait:code=56789
https://myfluidtopics.com/access/sources/ait/topic?ft:topicTitle=My Topic&Audience=public&Platform=RHEL

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