Get a publish report - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service displays all the information included in the publish report that Fluid Topics generates when a user uploads content.

Method Endpoint
GET 
/api/khub/uploads/{uploadId}/report
Path parameter Type Description
{uploadId} String An identifier listed in the response body when uploading content.

Response body

{
    "uploadId": "d441085c-4209-45ce-ab5f-37998b059730",
    "start": "2023-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.antidot.net/r/First-Screencast-for-Fluid-Topics-learning",
            "apiUrl": "https://doc.antidot.net/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.antidot.net/r/Second-screencast-for-Fluid-Topics-learning",
            "apiUrl": "https://doc.antidot.net/api/khub/maps/g_VBhIw2I_Gz1gV~kAm4IQ"
        }
    ]
}
Field Type Description
start String The date and time when the content processing began.
source Object A list of source properties.
filename String The name of the uploaded file.
status String The state of processing. In order:
  1. WAITING

    The processing of the archive is pending.

  2. RUNNING

    The archive is being processed.

ADMIN, KHUB_ADMIN, or CONTENT_PUBLISHER users can also stop the processing at any time during the previous two stages. This results in a state of STOPPED.
Then, if the user does not stop the processing, it can have one of the following states:
  • DONE

    The processing succeeded, and it found no error in the content.

  • WARNING

    The processing found an error in the content which did not prevent the publication of the document.

  • FAILED

    The processing found an error in the content which prevented the publication of the document.

Authorized users can see what the errors are in the Logs section.
errorMessages Array Deprecated. Displays errors if any occurred.
publisher String The name of the user who submitted the content for processing.
paging Object The number of pages for all variants.
type String The type of process (PUBLISH or REPROCESS).
publications Array A detailed list of all documents submitted for processing, with one object per variant.
  • Authentication via the header is required in all calls to Fluid Topics Dataflow web services.
  • The first processing job launched after reprocessing may take more time than all other processing jobs.