Channel Developers

thumbnail

Articles & Revisions Management

管理APIは、新しい記事やリビジョンを作成したり、既存のコンテンツを修正したりすることができます。

プロパティ

説明

Method

POST

Path

/open/v1/spaces/$me/articles

Accept

application/json

Content-Type

application/json

Description

指定されたコンテンツで新しい記事とリビジョンを作成します。作成されたリビジョンは下書き状態になります。本文は、ブロック形式のオブジェクト(bodyフィールド)、またはブロック形式に解析されるHTML(bodyHtmlフィールド)のいずれかで指定できます。両方が指定された場合は、bodyが優先されます。

  • リクエスト

    • Query (empty)

    • Body

      TypeScript
  • レスポンス

    TypeScript

プロパティ

説明

Method

POST

Path

/open/v1/spaces/$me/articles/{articleId}/revisions

Accept

application/json

Content-Type

application/json

Description

記事に対して新しい下書きリビジョンを作成します。本文は、ブロック形式のオブジェクト(bodyフィールド)、またはブロック形式に解析される HTML(bodyHtmlフィールド)のいずれかで指定できます。両方が指定された場合は、bodyが優先されます。

  • リクエスト

    • Query

        (empty)

    • Body

      TypeScript
  • レスポンス

    TypeScript

プロパティ

説明

Method

PATCH

Path

/open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId}

Accept

application/json

Content-Type

application/json

Description

リビジョンのタイトルやその他のコンテンツを更新します。更新できるのは下書き状態のリビジョンのみです(一度公開されると、不変となります)。本文は、ブロック形式のオブジェクト(bodyフィールド)、またはブロック形式に解析されるHTML(bodyHtmlフィールド)のいずれかで指定できます。両方が指定された場合は、bodyが優先されます。

  • リクエスト

    • Query

      (empty)

    • Body

      TypeScript
  • レスポンス

    TypeScript

プロパティ

説明

Method

PUT

Path

/open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId}/publish

Accept

application/json

Content-Type

application/json

Description

リビジョンを公開します。公開されたリビジョンは、その言語における記事の新しい現在のバージョンとなり、公開サイトに表示されます。以前に公開されていたリビジョン(ある場合)は非公開になります。一度リビジョンが公開されると、編集はできなくなります。

  • リクエスト

    • Query

      (empty)

    • Body

      Plaintext
      // (empty)
  • レスポンス

    TypeScript

プロパティ

説明

Method

PUT

Path

/open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId}/unpublish

Accept

application/json

Content-Type

application/json

Description

リビジョンの公開を取り消します。そのリビジョンおよび記事は、公開サイトに表示されなくなります。

  • リクエスト

    • Query

      (empty)

    • Body

      Plaintext
      // (empty)
  • レスポンス

    TypeScript

プロパティ

説明

Method

DELETE

Path

/open/v1/spaces/$me/articles/{articleId}/revisions/{revisionId}

Accept

application/json

Content-Type

application/json

Description

リビジョンを削除します。(公開中のリビジョンを削除することはできません。まず公開を取り消す必要があります。)

  • リクエスト

    • Query

      (empty)

    • Body

      Plaintext
      // (empty)
  • レスポンス

    Plaintext
    // (empty)

プロパティ

説明

Method

DELETE

Path

/open/v1/spaces/$me/articles/{articleId}

Accept

application/json

Content-Type

application/json

Description

記事と、その記事に含まれるすべてのリビジョンを削除します。いずれかの言語で公開中のリビジョンがある記事を削除することはできません。

  • リクエスト

    • Query

      (empty)

    • Body

      Plaintext
      // (empty)
  • レスポンス

    Plaintext
    // (empty)