NILTO

ヘルプセンター

コンテンツを更新する（PATCH /contents/{id}）

基本情報

ベータ版機能について

この機能はベータ版での提供となっており、動作が不安定な場合があります。
また、今後互換性を保たない変更が加わる可能性があります。

あらかじめご了承いただいた上でのご利用をお願いいたします。

指定IDのコンテンツの指定フィールドを更新します。

PATCH/v1/contents/{content_id}

https://cms-api.nilto.com/v1/contents/{content_id}

リクエストパラメータ

X-NILTO-API-KEY

X-NILTO-API-KEY

NILTO APIキー。

スペース設定のAPIキー画面で取得することができます。

content_id必須

integer
Example: 1234567890
置き換えるコンテンツのID

model必須

string
Example: model=blog,news
登録対象とするモデルのLUIDを指定します。

published

boolean
Default: false
Example: published=true
更新対象の公開ステータスを指定します。
下書きデータを更新する場合 false 、公開データを更新する場合は true を指定します。

space

string
Default: "_parent"
Example: space=demo
更新対象コンテンツが存在しているスペースのLUIDを指定します。

ft_format

string
Default: "portable_html"
Enum: "portable_html" "markdown"
Example: ft_format=markdown
フレキシブルテキストフィールドにデータ登録したい場合、HTMLデータとして取り込むかマークダウンデータとして取り込むかを指定します。

fields

object (contentRequest)
{フィールドLUID: 入力値}の形式のオブジェクト。
言語キー未指定時はメイン言語として登録します。

fields[{lang_key}]

any
{フィールドLUID: 入力値}の形式のオブジェクト。
[] 内は利用中言語の言語キーを指定。同時に複数の言語キーを指定できます。

リクエスト例

curl
curl -X PATCH "https://cms-api.nilto.com/v1/contents/1234567890?model=news&published=false" \
     -H "X-NILTO-API-KEY: 0000000000000000000000" \
     -H "Content-Type: application/json" \
     -d '{
       "fields": {
         "singleline_field": "このフィールドだけを更新します",
         "datetime_field": "2023-03-07T19:12:46Z"
       }
     }'
Payload
{
   "fields": {
      "singleline_field": "foobar",
      "datetime_field": "2023-01-23T04:50:00Z"
   },
   "fields[en]": {
      "singleline_field": "foobar"
   },
   "fields[zh-CN]": {
      "singleline_field": "foobar"
   }
}

レスポンス

200 OK

id

integer

コンテンツID

400 Bad Request

status

string
Value: "400"
HTTPステータスコード

code

string
Value: "BadRequest"
エラーを識別するためのコード

401 Unauthorized

status

string
Value: "401"
HTTPステータスコード

code

string
Value: "Unauthorized"
エラーを識別するためのコード

402 Payment Required

status

string
Value: "402"
HTTPステータスコード

code

string
Value: "Payment Required"
エラーを識別するためのコード

403 Forbidden

status

string
Value: "403"
HTTPステータスコード

code

string
Value: "Forbidden"
エラーを識別するためのコード

404 Not Found

status

string
Value: "404"
HTTPステータスコード

code

string
Value: "Not Found"
エラーを識別するためのコード

429 Too Many Requests

status

string
Value: "429"
HTTPステータスコード

code

string
Value: "Too Many Requests"
エラーを識別するためのコード

message

string
次のリクエストが可能になるまでの残り秒数を含むメッセージ。 秒数そのものはretry-afterヘッダーで返されます。

500 Internal Server Error

status

string
Value: "500"
HTTPステータスコード

code

string
Value: "Internal Server Error"
エラーを識別するためのコード

レスポンス例

200
{
   "id": 1234567890
 }
400
{
   "status": "400",
   "code": "BadRequest"
}
401
{
   "status": "401",
   "code": "Unauthorized"
}
402
{
   "status": "402",
   "code": "Payment Required"
}
403
{
  "status": "403",
  "code": "Forbidden"
}
404
{
  "status": "404",
  "code": "Not Found"
}
429
{
  "status": "429",
  "code": "Too Many Requests",
  "message": "Expected available in 58 seconds."
}
500
{
  "status": "500",
  "code": "Internal Server Error"
}

お困りごとは解決しましたか？

解決しない場合は、サポートへお問い合わせください。

サポートに問い合わせる

目次