document.process - Fluid Topics - Latest

Integrate the Fluid Topics API

Category
Technical Notes
Audience
public
Version
Latest

This server event occurs when one of the documents in a ZIP archive has been uploaded to the Knowledge Hub for processing.

This event contains the following fields:

Field Description
uploadId The identifier of the upload leading to the processing of the document.
processType The type of job. Possible values are PUBLISH, DELETE, UPDATE_METADATA, REPROCESS_METADATA, and UPDATE_ATTACHMENTS.
processStatus The status of the job. Possible values are OK, FAILED, and WARNING.
    document An object containing information about the document.
        id The document's identifier.
        title The document's title.
        type The document's type. Possible values are STRUCTURED_DOCUMENT, UNSTRUCTURED_DOCUMENT, RESOURCE, and MAP_ATTACHMENT.
    processSource An object containing information about the source.
        id The source's identifier.
        name The source's name.
        type The source's type.

A table for the most common fields is in Analytics events.

Example:

[
    {
        "appName": "ft/turnkey-portal",
        "appVersion": "4.2.26",
        "contentLocale": "und",
        "datetime": 1704191222091,
        "id": "97179a5d-94bf-42ae-9a6e-517a08f1c684",
        "name": "document.process",
        "offline": false,
        "parameters": {
            "document": {
                "id": "RHhnH6QWJ0OrQQQueJU~LQ",
                "title": "Author-It Documents Are Duplicated",
                "type": "STRUCTURED_DOCUMENT",
                "metadata": []
            },
            "processSource": {
                "id": "md_docxs",
                "name": "Markdown DocXS",
                "type": "Markdown"
            },
            "processStatus": "OK",
            "processType": "PUBLISH",
            "uploadId": "de9282b1-efcf-4639-8825-8cd9b309452c"
        },
        "sessionId": "",
        "tenantId": "1-stable",
        "uiLocale": "und",
        "user": {
            "groups": [],
            "id": "d554325-eef7-4850-93c1-cea73446582060",
            "roles": []
        },
        "userAgent": "",
        "userIp": "192.168.2.3"
    }
]