Ferndesk

Artikelrevisionen

Eine Artikelrevision abrufen

Gibt einen vollständigen Revisions-Snapshot zurück. Verwenden Sie format=markdown für Markdown. Erfordert den content:read-Scope.

Erforderlicher Scope: content:read

GET /articles/{id}/revisions/{revisionId}

Eine Artikelrevision abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/revisions/{REVISIONID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "version": 1,
  "title": "<string>",
  "source": "<string>",
  "comment": "<string>",
  "createdAt": "<string>",
  "language": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Revision

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Entwicklereinstellungen generieren und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt listet den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und löschen (Änderungen live schalten)
    • analytics:read: Hilfecenter-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish schließt content:read ein. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes = Vollzugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ferndesk-Artikel-ID (art_...). Beispiel: art_01JXY9AZK4KV

  • revisionId string erforderlich

    Revisions-ID. Beispiel: rev_01JXY9AZK4KV

Query Parameters

  • format string enum

    Inhaltsdarstellungsformat. html (Standard) gibt contentHtml zurück; markdown gibt contentMarkdown zurück; json gibt contentJson zurück — das unveränderte gespeicherte ProseMirror/Tiptap-Dokument. Das JSON verwendet das Ferndesk-ProseMirror-Schema (benutzerdefinierte Nodes wie callout, steps und cards) und ist die verlustfreie Darstellung des Artikelinhalts. Beispiel: markdown

Response

application/json
  • id string

    Revisions-ID.

  • version integer

    Artikelversion, die von dieser Revision erfasst wurde.

  • title string | null
  • source string | null

    Schreibkanal der Veröffentlichung.

  • comment string | null
  • createdAt string

    ISO-8601-Zeitstempel in UTC.

  • language string

    Revisionssprache.

  • contentHtml string
  • contentMarkdown string
  • contentJson any | null

    Unveränderter gespeicherter ProseMirror/Tiptap-Revisions-Snapshot (format=json). Verlustfreies Ferndesk-ProseMirror-Schema.