Ferndesk

Artikelentwürfe

Artikelentwürfe auflisten

Listet offene Entwürfe für einen Artikel (Primärartikel und Übersetzungen) auf. Erfordert den Bereich content:write.

Erforderlicher Bereich: content:write

GET /articles/{id}/drafts

Artikelentwürfe auflisten

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

Entwürfe

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit 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 Bereiche beschränkt werden (jeder Endpunkt führt den über x-required-scopes erforderlichen Bereich 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, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfecenters 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. Schlüssel, die vor der Bereichszuordnung erstellt wurden, haben null Bereiche = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

Response

application/json
  • items[] object array item

    Zusammenfassung des Entwurfs.

    + Show Child Attributes
    • 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, der den Entwurf erstellt hat.

    • stale boolean

      Gibt an, ob der Artikel seit der Erstellung der Grundlage des Entwurfs weiterentwickelt wurde (nur Primärentwürfe).

    • updatedAt string

      ISO-8601-Zeitstempel in UTC.