Get a Dataflow Report - Fluid Topics - 3.2 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.2
Category
Reference Guides
Language
English
Target Audience
public

This web service is used to get all information pertaining to a specific report generated by Fluid Topics on the data that has been updated/deleted.

Method

Endpoint

GET

/api/admin/khub/dataflow/reports/$REPORT_ID

Where:

Output Example

{
"id": "0ca262904cb74244aaf6a95b86f3bb3e",
"date": "2016-02-04T14:05:44.143+0000",
"mode": "INCREMENTAL",
"maps": [
{
"id": "RWQIOUifmm25E3y7E5JrVg",
"status": "UPDATED",
"mapApiEndpoint": "/api/khub/maps/RWQIOUifmm25E3y7E5JrVg",
"topics": [
{
"id": "loyLFep1qJkRYtCaVxojUA",
"status": "CREATED",
"topicApiEndpoint": "/api/khub/maps/RWQIOUifmm25E3y7E5JrVg/topics/loyLFep1qJkRYtCaVxojUA"
},
{
"id": "y0yx0fUwHZAUSdYujCELjA",
"status": "DELETED"
}
]
}
],
"documents": [
{
"id": "CksZkQsW7dbgLEIPJrV4Qg",
"status": "UPDATED",
"documentApiEndpoint": "/api/khub/documents/CksZkQsW7dbgLEIPJrV4Qg"
}
]
}

Where:

  • "mapApiEndpoint" is the path where details about a map can be found.
  • "topicApiEndpoint" is the path where details about a topic can be found (available only if status is not DELETED).
  • "documentApiEndpoint" is the path where details about a document can be found (available only if status is not DELETED).

Dataflow web services are only available to users with the KHUB Administrator Role. Basic authentication via the header is required.