The following curl command is an example of monitoring using the Get a publish report web service:
curl --header 'Authorization: Bearer $API-KEY' https://doc.fluidtopics.com/api/khub/uploads/5aaad15b-7139-4e80-ae3a-369d62dc6c73/report
When successful, Fluid Topics confirms the success of the operation with a 200 OK response and provides the following response body:
{
"uploadId": "90caa68a-4209-45ce-ab5f-37998b059730",
"start": "2020-02-07T12:33:39.481+0000",
"source": {
"id": "dita_screencasts",
"name": "Dita Screencasts",
"type": "Dita",
"description": "Dita source for screencasts",
"category": ""
},
"filename": "TN_screencasts-for-ft-learning.zip",
"status": "DONE",
"errorMessages": [],
"publisher": "John Doe",
"paging": {
"currentPage": 1,
"perPage": 100,
"totalCount": 2
},
"type": "PUBLISH",
"publications": [
{
"originId": "a28a4316b0bd7191892eeb7d39e486ff.map",
"khubId": "OtZutoMtSUqEa0dVesovdg",
"title": "First Screencast for Fluid Topics learning",
"documentType": "MAP",
"connectorStatus": "OK",
"fluidTopicsStatus": "OK",
"readerUrl": "https://doc.fluidtopics.com/r/First-Screencast-for-Fluid-Topics-learning",
"apiUrl": "https://doc.fluidtopics.com/api/khub/maps/OtZutoMtSUqEa0dVesovdg"
},
{
"originId": "738ef55e401200f9b646cc8f524510a9.map",
"khubId": "g_VBhIw2I_Gz1gV~kAm4IQ",
"title": "Second screencast for Fluid Topics learning",
"documentType": "MAP",
"connectorStatus": "OK",
"fluidTopicsStatus": "OK",
"readerUrl": "https://doc.fluidtopics.com/r/Second-screencast-for-Fluid-Topics-learning",
"apiUrl": "https://doc.fluidtopics.com/api/khub/maps/g_VBhIw2I_Gz1gV~kAm4IQ"
}
]
}
Fluid Topics queues uploads in FIFO (First In First Out) mode. It is not recommended to fetch all publication statuses simultaneously.
If the web service returns a status value of FAILED, the publication did not succeed.
If the web service returns a status value of WARNING, the publication succeeded but there may be missing files.
If the web service returns a status value of DONE, the publication succeeded.
Make sure the following values appear for all publications: "connectorStatus": "OK" and "fluidTopicsStatus": "OK". If these values do not appear, it indicates an error with the portal.