microCMS

コンテンツのステータス

最終更新日:2024年08月19日

コンテンツには以下の4つのステータスが存在します。

  1. 公開中
  2. 公開終了
  3. 下書き中
  4. 公開中かつ下書き中

各ステータスによってAPIでの動作、コンテンツに自動付与される値が異なります。

ステータスの説明

各ステータスについて説明します。

1. 公開中

ステータスが公開中の場合、APIでコンテンツの内容を取得することができます。
ステータスコードは200になります。

コンテンツに自動付与される値

2. 公開終了

ステータスが公開終了の場合、APIでコンテンツの内容を取得することはできません。
ステータスコードは404になります。
ただし、APIキーに「公開終了コンテンツの全取得」権限を付与した場合は、コンテンツの内容を取得することができます。

3. 下書き中

ステータスが下書き中の場合、APIでコンテンツの内容を取得することはできません。
ステータスコードは404になります。
ただし、draftKeyを付与してリクエストするか、APIキーに「下書きコンテンツの全取得」権限を付与した場合は、コンテンツの内容を取得することができます。

コンテンツに自動付与される値

informationInformation
  • publishedAt および revisedAtはレスポンスに含まれません。
  • 一度公開したコンテンツについては、publishedAt および revisedAt は含まれます(過去、公開した時点での値)。

4. 公開中かつ下書き中

ステータスが公開中かつ下書き中の場合、APIで公開中のコンテンツの内容のみ取得することができます。
ステータスコードは200になります。
ただし、draftKeyを付与してリクエストするか、APIキーに下書き全取得権限をつけた場合は、下書き中のコンテンツの内容を取得することができます。

コンテンツに自動付与される値