PATCH /dataset/{schema_name}

カスタムコンポーネントのドキュメントバリアントをドキュメント ID をキーとしてアップサートします。

カスタムコンポーネントのバリアント（documents 行）をドキュメントの id をキーとしてアップサートします。既存のバリアントを更新するには id を指定し、新規に挿入する場合は省略します。/schemas/{schema_name} でも利用できます。コンテンツはコンポーネントのスキーマに対して検証されます。

認証: API キー — 常に必須であり、キーには content_write 権限が付与されている必要があります。

パスパラメーター

パラメーター	型	必須	備考
`schema_name`	string	yes	カスタムコンポーネントの名前。

クエリパラメーター

パラメーター	型	必須	備考
`websiteId`	uuid	no	対象ウェブサイト。省略した場合は `Host` ヘッダー / 設定が使用されます。
`api_key`	string	no	`x-api-key` ヘッダーの代替。

リクエストボディ

{
  "id": "<uuid>",
  "title": "私のバリアント",
  "content": { "title": "こんにちは", "body": "..." }
}

フィールド	型	必須	備考
`id`	uuid	no	存在する場合は一致するバリアントを更新し、省略または未検出の場合は挿入します。
`title`	string	no	表示タイトル。挿入時の既定値は `"Untitled"`。更新時に省略した場合は変更されません。
`content`	object	yes	フィールド値。コンポーネントのスキーマに対して検証されます。JSON オブジェクトである必要があります。

レスポンス

{
  "id": "...",
  "schema_name": "post",
  "title": "私のバリアント",
  "status": "下書き",
  "version": 2,
  "created": true
}

created は挿入時 (HTTP 201) には true で、更新時 (HTTP 200) には false になります。

例

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"こんにちは"}}'

エラー

400 — 無効な websiteId、オブジェクトではない content、不明またはアーカイブ済みのコンポーネント、あるいは検証失敗
401 — API キーがない、または無効
403 — キーに content_write 権限が付与されていません
404 — id が指定されているが一致するバリアントが存在しません

Previous‹GET /content-changes (SSE)NextPOST /translation›