--- url: https://next.zammad.org/it/reference/rest-api/knowledgebase.md --- # Base di conoscenza Zammad dispone di diversi endpoint relativi alla knowledge base. I più importanti – ma non tutti – sono trattati in questa documentazione. Puoi trovare quelli generali sulla knowledge base stessa qui sotto, seguiti dai sotto-endpoint per le [risposte](#answers) e le [categorie](#categories). ## Knowledge base general ::: info Gli esempi di richiesta e risposta includono l'ID della base di conoscenza `1`. Il tuo ID potrebbe essere diverso. ::: ### Panoramica Permesso richiesto: `knowledge_base.editor` Richiesta `POST` inviata: `/api/v1/knowledge_bases/init` ::: details ```json // HTTP-Code 200 Ok { "KnowledgeBase": { "1": { "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "show_feed_icon": false, "custom_address": null, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:00:07.819Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-12T14:52:38.025Z", "translation_ids": [ 1 ], "answer_ids": [ 1 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] }, "2": { "id": 2, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f015", "position": 1, "created_at": "2025-03-12T14:51:29.019Z", "updated_at": "2025-03-12T14:52:21.782Z", "translation_ids": [ 2 ], "answer_ids": [ 2, 3 ], "child_ids": [ 2 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" }, "2": { "id": 2, "title": "Category 2", "kb_locale_id": 1, "category_id": 2, "created_at": "2025-03-12T14:51:29.024Z", "updated_at": "2025-03-12T14:51:29.024Z" } }, "KnowledgeBaseAnswer": { "1": { "internal_at": "2025-03-12T14:52:38.014Z", "category_id": 1, "archived_at": null, "internal_by_id": 3, "published_at": null, "id": 1, "promoted": false, "internal_note": null, "position": 0, "archived_by_id": null, "published_by_id": null, "created_at": "2025-03-12T14:50:48.732Z", "updated_at": "2025-03-12T14:52:38.022Z", "translation_ids": [ 1 ], "attachments": [], "tags": [] }, "2": { "id": 2, "category_id": 2, "promoted": false, "internal_note": null, "position": 0, "archived_at": null, "archived_by_id": null, "internal_at": null, "internal_by_id": null, "published_at": null, "published_by_id": null, "created_at": "2025-03-12T14:51:34.900Z", "updated_at": "2025-03-12T14:51:49.317Z", "translation_ids": [ 2 ], "attachments": [], "tags": [] }, "3": { "published_at": "2025-03-12T14:52:21.767Z", "category_id": 2, "archived_at": null, "internal_at": null, "published_by_id": 3, "id": 3, "promoted": false, "internal_note": null, "position": 1, "archived_by_id": null, "internal_by_id": null, "created_at": "2025-03-12T14:51:58.755Z", "updated_at": "2025-03-12T14:52:21.778Z", "translation_ids": [ 3 ], "attachments": [], "tags": [] } }, "KnowledgeBaseAnswerTranslation": { "1": { "id": 1, "title": "Answer 1", "kb_locale_id": 1, "answer_id": 1, "content_id": 1, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-12T14:50:48.750Z", "updated_at": "2025-03-12T14:51:11.559Z" }, "2": { "answer_id": 2, "title": "Answer A", "id": 2, "kb_locale_id": 1, "content_id": 2, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-12T14:51:34.910Z", "updated_at": "2025-03-12T14:51:49.346Z" }, "3": { "answer_id": 3, "title": "Answer B", "id": 3, "kb_locale_id": 1, "content_id": 3, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-12T14:51:58.770Z", "updated_at": "2025-03-12T14:52:05.925Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "de-de", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-12T09:19:51.034Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } } } ``` ::: ### Mostra Permesso richiesto: `knowledge_base.reader` o `knowledge_base.editor` Richiesta `GET` inviata: `/api/v1/knowledge_bases/{ID of your KB}` ::: details ```json // HTTP-Code 200 Ok { "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "show_feed_icon": false, "custom_address": null, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-12T15:38:47.669Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } ``` ::: ### Change settings Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: `/api/v1/knowledge_bases/manage/{ID of your KB}` :::: details ::: tabs key:reqres \=== Richiesta ```json { "show_feed_icon": false, "custom_address": "mynewaddress.tld" } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } ``` ::: :::: ### Show permissions Permesso richiesto: `knowledge_base.editor` Richiesta `GET` inviata: `/api/v1/knowledge_bases/{ID of your KB}/permissions` ::: details ```json // HTTP-Code 200 Ok { "roles_reader": [ { "id": 2, "name": "Agent" } ], "roles_editor": [ { "id": 1, "name": "Admin" } ], "permissions": [], "inherited": [] } ``` ::: ### Change permissions Permesso richiesto: `knowledge_base.editor` Richiesta `PUT` inviata: `/api/v1/knowledge_bases/{ID of your KB}/permissions` :::: details ::: tabs key:reqres \=== Richiesta ```json { "permissions_dialog": { "permissions": { "1": "editor", "2": "reader", "4": "editor" } } } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "roles_reader": [], "roles_editor": [ { "id": 1, "name": "Admin" }, { "id": 2, "name": "Agent" }, { "id": 4, "name": "KB editor" } ], "permissions": [ { "id": 3, "access": "editor", "role_id": 1 }, { "id": 4, "access": "reader", "role_id": 2 }, { "id": 5, "access": "editor", "role_id": 4 } ], "inherited": [] } ``` ::: :::: ## Categorie ### Reorder sub-categories Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category} :::: details ::: tabs key:reqres \=== Richiesta ```json { "ordered_ids": [ 9, 8 ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T14:10:23.137Z", "translation_ids": [ 1 ], "answer_ids": [ 5, 6, 7, 4 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "8": { "parent_id": 1, "position": 1, "knowledge_base_id": 1, "id": 8, "category_icon": "f115", "created_at": "2025-03-13T14:09:46.597Z", "updated_at": "2025-03-13T14:10:23.135Z", "translation_ids": [ 8 ], "answer_ids": [], "child_ids": [ 8 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "9": { "parent_id": 1, "position": 0, "knowledge_base_id": 1, "id": 9, "category_icon": "f115", "created_at": "2025-03-13T14:09:54.157Z", "updated_at": "2025-03-13T14:10:23.057Z", "translation_ids": [ 9 ], "answer_ids": [], "child_ids": [ 9 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] } }, "KnowledgeBase": { "1": { "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "show_feed_icon": false, "custom_address": "mynewaddress.tld", "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T14:04:12.316Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1, 5, 4, 3 ], "answer_ids": [ 2, 3, 5, 6, 7, 4 ], "permission_ids": [ 3, 4, 5 ], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" }, "8": { "id": 8, "title": "Sub category 1", "kb_locale_id": 1, "category_id": 8, "created_at": "2025-03-13T14:09:46.602Z", "updated_at": "2025-03-13T14:09:46.602Z" }, "9": { "id": 9, "title": "Sub category 2", "kb_locale_id": 1, "category_id": 9, "created_at": "2025-03-13T14:09:54.161Z", "updated_at": "2025-03-13T14:09:54.161Z" } } } ``` ::: :::: ### Reorder root categories ::: info Devi fornire l'ordine di tutte le categorie di primo livello, ovvero categorie senza categoria. ::: Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/reorder_root_cat :::: details ::: tabs key:reqres \=== Richiesta ```json { "ordered_ids": [ 5, 2, 3, 4, 1 ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "KnowledgeBaseCategory": { "3": { "knowledge_base_id": 1, "position": 2, "id": 3, "parent_id": null, "category_icon": "f00c", "created_at": "2025-03-13T10:15:33.217Z", "updated_at": "2025-03-13T14:29:53.585Z", "translation_ids": [ 3 ], "answer_ids": [], "child_ids": [ 3 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "2": { "knowledge_base_id": 1, "position": 1, "id": 2, "parent_id": null, "category_icon": "f015", "created_at": "2025-03-12T14:51:29.019Z", "updated_at": "2025-03-13T14:29:53.552Z", "translation_ids": [ 2 ], "answer_ids": [ 2, 3 ], "child_ids": [ 2 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "4": { "knowledge_base_id": 1, "position": 3, "id": 4, "parent_id": null, "category_icon": "f00c", "created_at": "2025-03-13T10:16:55.888Z", "updated_at": "2025-03-13T14:04:12.421Z", "translation_ids": [ 4 ], "answer_ids": [], "child_ids": [ 4 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "5": { "knowledge_base_id": 1, "position": 0, "id": 5, "parent_id": null, "category_icon": "f115", "created_at": "2025-03-13T10:39:53.137Z", "updated_at": "2025-03-13T14:29:53.497Z", "translation_ids": [ 5 ], "answer_ids": [], "child_ids": [ 5 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] }, "1": { "knowledge_base_id": 1, "position": 4, "id": 1, "parent_id": null, "category_icon": "f115", "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T14:29:53.638Z", "translation_ids": [ 1 ], "answer_ids": [ 5, 6, 7, 4 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] } }, "KnowledgeBase": { "1": { "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "show_feed_icon": false, "custom_address": "mynewaddress.tld", "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T14:04:12.316Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1, 5, 8, 4, 3, 9 ], "answer_ids": [ 2, 3, 5, 6, 7, 4 ], "permission_ids": [ 3, 4, 5 ], "permissions_effective": [ { "id": 3, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 1, "access": "editor", "created_at": "2025-03-13T14:04:12.308Z", "updated_at": "2025-03-13T14:04:12.308Z" }, { "id": 4, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 2, "access": "reader", "created_at": "2025-03-13T14:04:12.311Z", "updated_at": "2025-03-13T14:04:12.311Z" }, { "id": 5, "permissionable_type": "KnowledgeBase", "permissionable_id": 1, "role_id": 4, "access": "editor", "created_at": "2025-03-13T14:04:12.313Z", "updated_at": "2025-03-13T14:04:12.313Z" } ] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "3": { "id": 3, "title": "My new category changed with PUT", "kb_locale_id": 1, "category_id": 3, "created_at": "2025-03-13T10:15:33.223Z", "updated_at": "2025-03-13T10:34:33.691Z" }, "2": { "id": 2, "title": "Category 2", "kb_locale_id": 1, "category_id": 2, "created_at": "2025-03-12T14:51:29.024Z", "updated_at": "2025-03-12T14:51:29.024Z" }, "4": { "id": 4, "title": "Yet another category", "kb_locale_id": 1, "category_id": 4, "created_at": "2025-03-13T10:16:55.891Z", "updated_at": "2025-03-13T10:16:55.891Z" }, "5": { "id": 5, "title": "New Category 5", "kb_locale_id": 1, "category_id": 5, "created_at": "2025-03-13T10:39:53.141Z", "updated_at": "2025-03-13T10:39:53.141Z" }, "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } } } ``` ::: :::: ### Mostra Permesso richiesto: `knowledge_base.reader` o `knowledge_base.editor` Richiesta `GET` inviata: `/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category}` ::: details ```json // HTTP-Code 200 Ok { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-12T14:52:38.025Z", "translation_ids": [ 1 ], "answer_ids": [ 1 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } ``` ::: ### Crea Permesso richiesto: `knowledge_base.editor` Richiesta `POST` inviata: `/api/v1/knowledge_bases/{ID of your KB}/categories` :::: details ::: tabs key:reqres \=== Richiesta ```json { "category_icon": "f115", "parent_id": "", "translations_attributes": [ { "content_attributes": { "body": "" }, "kb_locale_id": 1, "title": "New Category 6" } ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "id": 6, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 5, "created_at": "2025-03-13T10:40:37.096Z", "updated_at": "2025-03-13T10:40:37.104Z", "translation_ids": [ 6 ], "answer_ids": [], "child_ids": [ 6 ], "permission_ids": [], "permissions_effective": [] } ``` ::: :::: ### Modifica Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category} :::: details ::: tabs key:reqres \=== Richiesta ```json { "category_icon": "f00c", "parent_id": "2", "translations_attributes": [ { "id": 3, "title": "My new category" } ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "knowledge_base_id": 1, "parent_id": 2, "category_icon": "f00c", "id": 3, "position": 0, "created_at": "2025-03-13T10:15:33.217Z", "updated_at": "2025-03-13T10:32:32.559Z", "translation_ids": [ 3 ], "answer_ids": [], "child_ids": [ 3 ], "permission_ids": [], "permissions_effective": [] } ``` ::: :::: ### Elimina Permesso richiesto: `knowledge_base.editor` Richiesta `DELETE` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category ::: details ```json // HTTP-Code 200 Ok {} ``` ::: ### Show permissions Permesso richiesto: `knowledge_base.editor` Richiesta `GET` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category}/p ::: details ```json // HTTP-Code 200 Ok { "roles_reader": [], "roles_editor": [ { "id": 1, "name": "Admin" }, { "id": 2, "name": "Agent" } ], "permissions": [ { "id": 1, "access": "editor", "role_id": 1 }, { "id": 2, "access": "reader", "role_id": 2 } ], "inherited": [] } ``` ::: ### Change permissions Permesso richiesto: `knowledge_base.editor` Richiesta `PUT` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category}/p :::: details ::: tabs key:reqres \=== Richiesta ```json { "permissions_dialog": { "permissions": { "1": "editor", "2": "reader" } } } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "roles_reader": [], "roles_editor": [ { "id": 1, "name": "Admin" }, { "id": 2, "name": "Agent" } ], "permissions": [ { "id": 1, "access": "editor", "role_id": 1 }, { "id": 2, "access": "reader", "role_id": 2 } ], "inherited": [] } ``` ::: :::: ## Risposte ### Reorder answers Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/categories/{ID of category} :::: details ::: tabs key:reqres \=== Richiesta ```json { "ordered_ids": [ 1, 4, 5 ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "KnowledgeBaseAnswer": { "4": { "category_id": 1, "position": 1, "archived_at": null, "internal_at": null, "published_at": null, "id": 4, "promoted": false, "internal_note": null, "archived_by_id": null, "internal_by_id": null, "published_by_id": null, "created_at": "2025-03-13T11:02:28.728Z", "updated_at": "2025-03-13T11:04:17.812Z", "translation_ids": [ 4 ], "attachments": [], "tags": [] }, "5": { "category_id": 1, "position": 2, "archived_at": null, "internal_at": null, "published_at": null, "id": 5, "promoted": false, "internal_note": null, "archived_by_id": null, "internal_by_id": null, "published_by_id": null, "created_at": "2025-03-13T11:02:46.276Z", "updated_at": "2025-03-13T11:04:17.872Z", "translation_ids": [ 5 ], "attachments": [], "tags": [] }, "1": { "category_id": 1, "position": 0, "archived_at": null, "internal_at": "2025-03-12T14:52:38.014Z", "published_at": null, "id": 1, "promoted": false, "internal_note": null, "archived_by_id": null, "internal_by_id": 3, "published_by_id": null, "created_at": "2025-03-12T14:50:48.732Z", "updated_at": "2025-03-13T11:04:17.734Z", "translation_ids": [ 1 ], "attachments": [], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T11:04:17.874Z", "translation_ids": [ 1 ], "answer_ids": [ 1, 4, 5 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "4": { "answer_id": 4, "title": "Answer 2", "id": 4, "kb_locale_id": 1, "content_id": 4, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T11:02:28.746Z", "updated_at": "2025-03-13T11:02:35.655Z" }, "5": { "answer_id": 5, "title": "Answer 3", "id": 5, "kb_locale_id": 1, "content_id": 5, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T11:02:46.288Z", "updated_at": "2025-03-13T11:02:53.908Z" }, "1": { "id": 1, "title": "Answer 1", "kb_locale_id": 1, "answer_id": 1, "content_id": 1, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-12T14:50:48.750Z", "updated_at": "2025-03-12T14:51:11.559Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "de-de", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-12T09:19:51.034Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } } } ``` ::: :::: ### Mostra Permesso richiesto: `knowledge_base.reader` o `knowledge_base.editor` Richiesta `GET` inviata: `/api/v1/knowledge_bases/{ID of your KB}/answers/{ID of answer}` ::: tip Se vuoi ottenere il contenuto di una risposta, aggiungi i parametri \`?full=1\&include_contents= ::: :::: details ```json // HTTP-Code 200 Ok { "id": 1, "assets": { "KnowledgeBaseAnswer": { "1": { "category_id": 1, "position": 0, "archived_at": null, "internal_at": "2025-03-12T14:52:38.014Z", "published_at": null, "id": 1, "promoted": false, "internal_note": null, "archived_by_id": null, "internal_by_id": 3, "published_by_id": null, "created_at": "2025-03-12T14:50:48.732Z", "updated_at": "2025-03-13T11:04:17.734Z", "translation_ids": [ 1 ], "attachments": [], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T11:04:17.874Z", "translation_ids": [ 1 ], "answer_ids": [ 1, 4, 5 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "1": { "id": 1, "title": "Answer 1", "kb_locale_id": 1, "answer_id": 1, "content_id": 1, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-12T14:50:48.750Z", "updated_at": "2025-03-12T14:51:11.559Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "de-de", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-12T09:19:51.034Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } }, "KnowledgeBaseAnswerTranslationContent": { "1": { "body": "This is the body of answer 1.", "id": 1, "attachments": [] } } } } ``` ::: ### Crea Permesso richiesto: `knowledge_base.editor` Richiesta `POST` inviata: `/api/v1/knowledge_bases/{ID of your KB}/answers` ::: details ::: tabs key:reqres \=== Richiesta ```json { "category_id": "1", "translations_attributes": [ { "content_attributes": { "body": "This is such an important answer!" }, "kb_locale_id": 1, "title": "Very important answer!!" } ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "id": 7, "assets": { "KnowledgeBaseAnswer": { "7": { "id": 7, "category_id": 1, "promoted": false, "internal_note": null, "position": 4, "archived_at": null, "archived_by_id": null, "internal_at": null, "internal_by_id": null, "published_at": null, "published_by_id": null, "created_at": "2025-03-13T12:21:27.078Z", "updated_at": "2025-03-13T12:21:27.122Z", "translation_ids": [ 7 ], "attachments": [], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T12:21:27.123Z", "translation_ids": [ 1 ], "answer_ids": [ 1, 4, 5, 6, 7 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "7": { "id": 7, "title": "Very important answer!!", "kb_locale_id": 1, "answer_id": 7, "content_id": 7, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T12:21:27.096Z", "updated_at": "2025-03-13T12:21:27.120Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "de-de", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-12T09:19:51.034Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } }, "KnowledgeBaseAnswerTranslationContent": { "7": { "id": 7, "body": "This is such an important answer!", "attachments": [] } } } } ``` ::: :::: ### Modifica Permesso richiesto: `knowledge_base.editor` Richiesta `PATCH` inviata: `/api/v1/knowledge_bases/{ID of your KB}/answers/{ID of answer}` :::: details ::: tabs key:reqres \=== Richiesta ```json { "category_id": "1", "translations_attributes": [ { "content_attributes": { "body": "Changed text of answer via API" }, "id": 7, "title": "Changed title of answer via API" } ] } ``` \=== Risposta ```json // HTTP-Code 200 Ok { "id": 7, "assets": { "KnowledgeBaseAnswer": { "7": { "category_id": 1, "archived_at": null, "internal_at": null, "published_at": null, "id": 7, "promoted": false, "internal_note": null, "position": 4, "archived_by_id": null, "internal_by_id": null, "published_by_id": null, "created_at": "2025-03-13T12:21:27.078Z", "updated_at": "2025-03-13T12:30:14.523Z", "translation_ids": [ 7 ], "attachments": [], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T12:30:14.523Z", "translation_ids": [ 1 ], "answer_ids": [ 1, 4, 5, 6, 7 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "7": { "answer_id": 7, "title": "Changed title of answer via API", "id": 7, "kb_locale_id": 1, "content_id": 7, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T12:21:27.096Z", "updated_at": "2025-03-13T12:30:14.520Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "de-de", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-12T09:19:51.034Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } }, "KnowledgeBaseAnswerTranslationContent": { "7": { "body": "Changed text of answer via API", "id": 7, "attachments": [] } } } } ``` ::: :::: ### Elimina Permesso richiesto: `knowledge_base.editor` Richiesta `DELETE` inviata: `/api/v1/knowledge_bases/{ID of your KB}/answers/{ID of answer}` ::: details ```json // HTTP-Code 200 Ok {} ``` ::: ### Manage publication status Permesso richiesto: `knowledge_base.editor` ::: info Le risposte sono omesse qui. Puoi aspettarti di ottenere una risposta come per mostrare una risposta con. ::: :::: details ::: tabs \=== Pubblica internamente Richiesta `POST` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/ans ::: :::: ### Manage attachments Permesso richiesto: `knowledge_base.editor` Aggiungi allegato: Richiesta `POST` con payload inviata: \`/api/v1/knowledge_bases/{ID of your KB}/answers/{ID of ::: details ```json // HTTP-Code 200 Ok { "KnowledgeBaseAnswer": { "4": { "updated_at": "2025-03-13T13:07:46.955Z", "id": 4, "category_id": 1, "promoted": false, "internal_note": null, "position": 0, "archived_at": null, "archived_by_id": null, "internal_at": "2025-03-13T12:51:00.000Z", "internal_by_id": 3, "published_at": null, "published_by_id": null, "created_at": "2025-03-13T11:02:28.728Z", "translation_ids": [ 4 ], "attachments": [ { "id": 1, "url": "/api/v1/attachments/1", "preview_url": "/api/v1/attachments/1?preview=1", "filename": "html-0dd51a3.zip", "size": "9939339", "preferences": { "Content-Type": "application/zip" } }, { "id": 2, "url": "/api/v1/attachments/2", "preview_url": "/api/v1/attachments/2?preview=1", "filename": "mail-21.eml", "size": "402", "preferences": { "Content-Type": "message/rfc822" } }, { "id": 3, "url": "/api/v1/attachments/3", "preview_url": "/api/v1/attachments/3?preview=1", "filename": "sample_file.txt", "size": "39", "preferences": { "Content-Type": "text/plain" } } ], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T13:07:46.956Z", "translation_ids": [ 1 ], "answer_ids": [ 5, 6, 7, 4 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "4": { "answer_id": 4, "updated_at": "2025-03-13T13:07:46.953Z", "id": 4, "title": "Answer 2", "kb_locale_id": 1, "content_id": 4, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T11:02:28.746Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "en-us", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "4": "2025-03-12T09:19:50.743Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-13T12:51:56.613Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } } } ``` ::: Elimina allegato: Richiesta `DELETE` inviata: \`/api/v1/knowledge_bases/{ID of your KB}/answers/{ID of answer}/att ::: details ```json // HTTP-Code 200 Ok { "KnowledgeBaseAnswer": { "4": { "updated_at": "2025-03-13T13:16:32.444Z", "id": 4, "category_id": 1, "promoted": false, "internal_note": null, "position": 0, "archived_at": null, "archived_by_id": null, "internal_at": "2025-03-13T12:51:00.000Z", "internal_by_id": 3, "published_at": null, "published_by_id": null, "created_at": "2025-03-13T11:02:28.728Z", "translation_ids": [ 4 ], "attachments": [ { "id": 1, "url": "/api/v1/attachments/1", "preview_url": "/api/v1/attachments/1?preview=1", "filename": "html-0dd51a3.zip", "size": "9939339", "preferences": { "Content-Type": "application/zip" } }, { "id": 2, "url": "/api/v1/attachments/2", "preview_url": "/api/v1/attachments/2?preview=1", "filename": "mail-21.eml", "size": "402", "preferences": { "Content-Type": "message/rfc822" } } ], "tags": [] } }, "KnowledgeBaseCategory": { "1": { "id": 1, "knowledge_base_id": 1, "parent_id": null, "category_icon": "f115", "position": 0, "created_at": "2025-03-12T14:50:42.533Z", "updated_at": "2025-03-13T13:16:32.444Z", "translation_ids": [ 1 ], "answer_ids": [ 5, 6, 7, 4 ], "child_ids": [ 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBase": { "1": { "show_feed_icon": false, "custom_address": "mynewaddress.tld", "id": 1, "iconset": "FontAwesome", "color_highlight": "#38ae6a", "color_header": "#f9fafb", "color_header_link": "hsl(206,8%,50%)", "homepage_layout": "grid", "category_layout": "grid", "active": true, "created_at": "2025-03-12T10:09:01.203Z", "updated_at": "2025-03-13T09:17:11.874Z", "translation_ids": [ 1 ], "kb_locale_ids": [ 1 ], "category_ids": [ 2, 1 ], "answer_ids": [ 2, 3, 1 ], "permission_ids": [], "permissions_effective": [] } }, "KnowledgeBaseLocale": { "1": { "id": 1, "knowledge_base_id": 1, "system_locale_id": 1, "primary": true, "created_at": "2025-03-12T10:09:01.206Z", "updated_at": "2025-03-12T10:09:01.206Z", "knowledge_base_translation_ids": [ 1 ], "category_translation_ids": [], "answer_translation_ids": [], "menu_item_ids": [] } }, "KnowledgeBaseTranslation": { "1": { "id": 1, "title": "Company Knowledge Base", "footer_note": "© Company", "kb_locale_id": 1, "knowledge_base_id": 1, "created_at": "2025-03-12T10:09:01.224Z", "updated_at": "2025-03-13T09:00:07.809Z" } }, "KnowledgeBaseCategoryTranslation": { "1": { "id": 1, "title": "Category 1", "kb_locale_id": 1, "category_id": 1, "created_at": "2025-03-12T14:50:42.547Z", "updated_at": "2025-03-12T14:50:42.547Z" } }, "KnowledgeBaseAnswerTranslation": { "4": { "answer_id": 4, "updated_at": "2025-03-13T13:16:32.442Z", "id": 4, "title": "Answer 2", "kb_locale_id": 1, "content_id": 4, "created_by_id": 3, "updated_by_id": 3, "created_at": "2025-03-13T11:02:28.746Z" } }, "User": { "3": { "id": 3, "organization_id": null, "login": "admin@example.com", "firstname": "Test", "lastname": "Admin", "email": "admin@example.com", "image": null, "image_source": null, "web": "", "phone": "", "fax": "", "mobile": "", "department": null, "street": "", "zip": "", "city": "", "country": "", "address": null, "vip": false, "verified": false, "active": true, "note": "", "last_login": "2025-03-10T15:49:27.097Z", "source": null, "login_failed": 0, "out_of_office": false, "out_of_office_start_at": null, "out_of_office_end_at": null, "out_of_office_replacement_id": null, "preferences": { "notification_config": { "matrix": { "create": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "update": { "criteria": { "owned_by_me": true, "owned_by_nobody": true, "subscribed": true, "no": false }, "channel": { "email": true, "online": true } }, "reminder_reached": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } }, "escalation": { "criteria": { "owned_by_me": true, "owned_by_nobody": false, "subscribed": false, "no": false }, "channel": { "email": true, "online": true } } } }, "intro": true, "keyboard_shortcuts_clues": true, "locale": "en-us", "theme": "light", "overviews_last_used": { "1": "2025-03-12T09:19:44.289Z", "2": "2025-03-12T09:19:36.992Z", "3": "2025-03-12T09:19:43.220Z", "5": "2025-03-12T09:19:15.831Z", "6": "2025-03-12T09:19:50.081Z", "12": "2025-03-12T09:19:35.027Z", "13": "2025-03-12T09:19:41.238Z", "4": "2025-03-12T09:19:50.743Z" } }, "updated_by_id": 3, "created_by_id": 1, "created_at": "2025-02-24T14:33:11.408Z", "updated_at": "2025-03-13T12:51:56.613Z", "role_ids": [ 1, 2 ], "two_factor_preference_ids": [], "organization_ids": [], "authorization_ids": [], "overview_sorting_ids": [], "group_ids": { "1": [ "full" ], "2": [ "full" ], "3": [ "full" ], "4": [ "full" ], "5": [ "full" ], "6": [ "full" ], "7": [ "full" ], "8": [ "full" ], "9": [ "full" ], "10": [ "full" ], "11": [ "full" ], "12": [ "full" ], "13": [ "full" ], "14": [ "full" ], "15": [ "full" ], "16": [ "full" ], "17": [ "full" ], "18": [ "full" ], "19": [ "full" ], "20": [ "full" ], "21": [ "full" ] } } } } ``` :::