Deep Link to an Author-it Topic - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

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

/access/sources/$SOURCE_ID/topic?ait:code=$OBJECT_ID&$VARIANT_1=$VARIANT_1_VALUE&$VARIANT_2=$VARIANT_2_VALUE&...

Where

  • $SOURCE_ID is the "id" parameter of the source used to upload the content.

The $SOURCE_ID parameter is case-sensitive.

  • $OBJECT_ID is the "Object code" of the topic as generated by Author-it.
  • $VARIANT_N is 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 is the name of the variant value 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:

http://myfluidtopics.com/access/sources/ait/topic?ait:code=56789
http://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.