Get Unstructured Document Metadata - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service returns the description and metadata of an unstructured document.

Method

Endpoint

GET

/api/khub/documents/$DOC_ID

Where:

  • $DOC_ID is the document identifier.

The DOC_ID of an unstructured document can be retrieved using the List Unstructured Documents web service.

Output Example

{
"id": "zDK13oDmZHDXCEPOc4xiyw",
"filename": "FluidTopics-Zoom-KHub-Internals-2015c.pdf",
"title": "FluidTopics-Zoom-KHub-Internals-2015c",
"mimeType": "application/pdf",
"rightsApiEndpoint": "/api/khub/documents/zDK13oDmZHDXCEPOc4xiyw/rights",
"contentApiEndpoint": "/api/khub/documents/zDK13oDmZHDXCEPOc4xiyw/content",
"viewerUrl": "#/viewer/document/zDK13oDmZHDXCEPOc4xiyw",
"metadata": [
{
"key": "author",
"label": "author",
"values": [
"Fabrice LACROIX"
]
}
]
}

Where:

  • "rightsApiEndpoint" is the path to follow to get the access rights of a document.
  • "contentApiEndpoint" is the path to follow to retrieve the document content.
  • "viewerUrl" is the URL fragment to use to open the document in a Fluid Topics UI.