Ferndesk

Artikelentwürfe

Artikelentwurf abrufen

Gibt einen Entwurf mit seinem Inhalt zurück. Verwenden Sie format=markdown für Markdown. Erfordert den content:write-Scope.

Erforderlicher Scope: content:write

GET /articles/{id}/drafts/{draftId}

Artikelentwurf abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Entwurf

Authorizations

  • Authorization string erforderlich header

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

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

    • content:read: Hilfezentrumsartikel, 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: Berichte, Analysen und Artikel-Feedback des Hilfezentrums 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 beinhaltet content:read. Vor der Einführung der Scopes ausgestellte Schlüssel haben null Scopes = Vollzugriff (Legacy-Modus).

Path Parameters

  • draftId string erforderlich

    Entwurfs-ID. Beispiel: drft_01JXY9AZK4KV

  • id string erforderlich

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

Query Parameters

  • format string enum

    Format für die Inhaltsdarstellung. 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 ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps und cards) und ist die verlustfreie Darstellung des Artikelinhalts. Beispiel: markdown

Response

application/json
  • id string

    Entwurfs-ID.

  • language string | null

    Sprache des Entwurfs.

  • status string

    Status des Entwurfs.

  • baseVersion integer

    Artikelversion, auf der der Entwurf basiert.

  • source string | null

    Schreibkanal, über den der Entwurf erstellt wurde.

  • stale boolean

    Gibt an, ob der Artikel seit dem Erstellen der Basis des Entwurfs weiterentwickelt wurde (nur primäre Entwürfe).

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.

  • title string | null

    Titel des Entwurfs.

  • contentHtml string

    Entwurfstext als HTML (format=html).

  • contentMarkdown string

    Entwurfstext als Markdown (format=markdown).

  • contentJson any | null

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