collection.update - Fluid Topics - Latest

Integrate the Fluid Topics API

Category
Technical Notes
Audience
public
Version
Latest

This server event occurs when a COLLECTION_USER user updates a collection's information, adds a document to a collection, or removes a document from a collection.

This event contains the following fields:

Field Description
collection An object containing information about the collection.
     id The collection's identifier.
     name The collection's name.
searchQuery Information about the query if the collection was created by saving the results of a search. null if the collection was not created this way.
     terms The terms included in the query.
     facets The list of facets applied at query time. Can be null.
     lastUpdate The selected period at query time. Can be LAST_WEEK, LAST_MONTH, LAST_YEAR, CUSTOM, or null.
     searchType The search type. Can be EVERYWHERE, TITLE_ONLY, NONE, or null.
updateType The type of update that occurred. Can be ADD_DOCUMENT, REMOVE_DOCUMENT, CHANGE_PROPERTIES, or CHANGE_SEARCH_QUERY.
documents An array containing information about the document in static collections.
     id The document's identifier.
     title The document's title. Null if a document was removed.
     type The document's type. Can be STRUCTURED_DOCUMENT, UNSTRUCTURED_DOCUMENT, PERSONAL_BOOK, SHARED_PERSONAL_BOOK, or null.
  • Since this event originates from the server and not the web application, it is not possible to listen to it.
  • Updating a collection by web service generates a separate event for each update type.

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

Example:

[
    {
        "appName": "ft/turnkey-portal",
        "appVersion": "4.1.34",
        "contentLocale": "en-US",
        "datetime": 1688128164138,
        "id": "6b12a075-e307-4126-90cd-8f4637217ef6",
        "name": "collection.update",
        "offline": false,
        "parameters": {
            "collection": {
                "id": "bfe5a4f6-40e7-40e9-b1f8-3e0f782b994f",
                "name": "K2-Collection"
            },
            "document": {
                "id": "m27nLjomVg08FbI7W1Mvjg",
                "title": "Author-it Connector Reference Guide",
                "type": "STRUCTURED_DOCUMENT"
            },
            "updateType": "ADD_DOCUMENT"
        },
        "sessionId": "9447ed5c-abe0-42ef-9ef0-5393dc8a4714",
        "tenantId": "1-stable",
        "uiLocale": "en-US",
        "user": {
            "groups": [
                "ft:administrator",
                "antidot",
                "ft:authenticated",
                "TechWriter",
                "Fluid Topics"
            ],
            "id": "d554325-eef7-4850-93c1-cea73446582060",
            "roles": [
                "BETA_USER",
                "HTML_EXPORT_USER",
                "OFFLINE_USER",
                "SAVED_SEARCH_USER",
                "PERSONAL_BOOK_SHARE_USER",
                "PERSONAL_BOOK_USER",
                "DEBUG_USER",
                "ANALYTICS_USER",
                "PRINT_USER",
                "FEEDBACK_USER",
                "COLLECTION_USER",
                "RATING_USER",
                "PDF_EXPORT_USER",
                "ADMIN"
            ]
        },
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
        "userIp": "192.168.2.3"
    }
]