Get DITA-OT metadata - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service returns the metadata of the DITA-OT version used for the processing of DITA documents on a Fluid Topics portal.

Method Endpoint
GET
/api/admin/khub/dita-ot

Response body

When the current DITA-OT is not the default one, the web service returns:

{
  "filename": "dita-ot-4.0.zip",
  "modificationDate": "2023-02-17T13:57:14.604896047Z",
  "uploaderId": "eff982-xc12-1i77-652p-659210erf",
  "uploaderName": "Alan Smithee"
}

When the current DITA-OT is the default one, the web service returns:

{
  "filename": "Default dita-ot used: DITA-OT-3.5"
}
Field Type Description
filename String The name of the DITA-OT archive used for the processing of DITA documents on a Fluid Topics portal.
modificationDate String The modification date in the ISO 8601 format.
uploaderId String The ID of the user who uploaded the DITA-OT archive. The ID is available in the List users web service.
uploaderName String The name of the user who uploaded the DITA-OT archive.

If the DITA-OT is uploaded using an API key as authentication, there is no uploaderName and the uploaderId is the ID of the API key.

Return code Description
200 OK Returns details about the DITA-OT integrated to a Fluid Topics portal.

For a list of all possible return codes, see Return codes.