--- updatedAt: 2026-04-27T13:23:27.000Z agentTools: projectIndex: https://developers.karte.io/llms.txt --- # Update custom field type Updates an existing custom field type. This endpoint allows you to modify the fields and configuration of an existing custom field type. #### Required Scope APIの実行に必要なScopeです。 ``` beta.cms.customFieldType.update ``` #### Required Role 管理画面でScopeを追加する際に必要な権限です。 ``` Craft Cross CMS > CMSの編集 ``` # OpenAPI definition ````json { "openapi": "3.0.0", "servers": [ { "url": "https://api.karte.io", "description": "Production server" }, { "url": "https://api-jp.karte.io", "description": "Production JP server. リージョン固定オプションのプロジェクトはこちらのエンドポイントを利用してください." } ], "info": { "version": "2.0.0", "title": "CMS Management" }, "paths": { "/v2beta/cms/customFieldType/update": { "post": { "tags": [ "CustomFieldTypes" ], "summary": "Update custom field type", "description": "Updates an existing custom field type.\n\nThis endpoint allows you to modify the fields and configuration of an existing custom field type.\n\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\nbeta.cms.customFieldType.update\n```\n\n#### Required Role\n管理画面でScopeを追加する際に必要な権限です。\n```\nCraft Cross CMS > CMSの編集\n```\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionId": { "type": "string", "description": "The ID of the collection" }, "customFieldTypeId": { "type": "string", "description": "The ID of the custom field type to update" }, "data": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the custom field type" }, "fields": { "type": "array", "description": "The fields definition for the custom field type. Fields with ID will be updated, fields without ID will be added as new", "items": { "oneOf": [ { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "unique": { "type": "boolean" }, "maxCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "inputType": { "type": "string", "enum": [ "text", "textarea" ] } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "number" ] }, "typeOptions": { "type": "object", "properties": { "maxValue": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minValue": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "availableFileTypes": { "type": "array", "items": { "type": "string", "enum": [ "image", "video" ] } } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rich_text" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "maxCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "availableFormats": { "type": "array", "items": { "type": "string", "enum": [ "h1", "h2", "h3", "h4", "h5", "h6", "bold", "italic", "strike", "bullet-list", "ordered-list", "code", "code-block", "blockquote", "horizontal-rule", "underline", "link", "text-align", "image", "embed", "table", "superscript", "subscript", "highlight", "custom-class" ] } }, "embedOptions": { "type": "object", "properties": { "lazy": { "type": "boolean" } }, "required": [ "lazy" ], "additionalProperties": false }, "customClassOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string", "minLength": 1, "maxLength": 50 }, "value": { "type": "string", "pattern": "^[a-z]([a-z0-9_-]| [a-z0-9_-])*$" } }, "required": [ "label", "value" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "date" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "inputType": { "type": "string", "enum": [ "datetime", "date" ] } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "checkbox" ] }, "typeOptions": { "type": "object", "properties": { "inputType": { "type": "string", "enum": [ "checkbox", "radio" ] } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "select" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "selectOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "reference" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "refModel": { "type": "string", "nullable": true }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "map" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean", "default": false }, "defaultMapView": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "center": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "lat", "lng" ], "additionalProperties": false }, "zoom": { "type": "number" } }, "required": [ "enabled", "center", "zoom" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Field ID (optional - if not provided, creates new field)" }, "uid": { "type": "string", "description": "Unique identifier for the field" }, "name": { "type": "string", "description": "Display name of the field" }, "description": { "type": "string", "description": "Description of the field" } }, "required": [ "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "not": { "enum": [ "text", "number", "image", "file", "rich_text", "date", "checkbox", "select", "reference", "map", "multi_type" ] } }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type" ] } ] } ] } } }, "additionalProperties": false, "minProperties": 1 } }, "required": [ "collectionId", "customFieldTypeId", "data" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the custom field type" }, "collectionId": { "type": "string", "description": "The ID of the collection" }, "uid": { "type": "string", "description": "The unique identifier of the custom field type" }, "name": { "type": "string", "description": "The name of the custom field type" }, "fields": { "type": "array", "description": "The fields of the custom field type", "items": { "oneOf": [ { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "unique": { "type": "boolean" }, "maxCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "inputType": { "type": "string", "enum": [ "text", "textarea" ] } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "unique", "maxCharLength", "minCharLength", "inputType" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "number" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "maxValue": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minValue": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "maxValue", "minValue" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "multiple", "maxLength", "minLength" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "availableFileTypes": { "type": "array", "items": { "type": "string", "enum": [ "image", "video" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "multiple", "maxLength", "minLength" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rich_text" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "maxCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minCharLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "availableFormats": { "type": "array", "items": { "type": "string", "enum": [ "h1", "h2", "h3", "h4", "h5", "h6", "bold", "italic", "strike", "bullet-list", "ordered-list", "code", "code-block", "blockquote", "horizontal-rule", "underline", "link", "text-align", "image", "embed", "table", "superscript", "subscript", "highlight", "custom-class" ] } }, "embedOptions": { "type": "object", "properties": { "lazy": { "type": "boolean" } }, "required": [ "lazy" ], "additionalProperties": false }, "customClassOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string", "minLength": 1, "maxLength": 50 }, "value": { "type": "string", "pattern": "^[a-z]([a-z0-9_-]| [a-z0-9_-])*$" } }, "required": [ "id", "label", "value" ], "additionalProperties": false } } }, "required": [ "required", "maxCharLength", "minCharLength", "availableFormats", "embedOptions", "customClassOptions" ], "additionalProperties": false } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "date" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "inputType": { "type": "string", "enum": [ "datetime", "date" ] } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "inputType" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "checkbox" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "inputType": { "type": "string", "enum": [ "checkbox", "radio" ] } }, "additionalProperties": false }, { "type": "object", "required": [ "inputType" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "select" ] }, "typeOptions": { "type": "object", "properties": { "required": { "type": "boolean" }, "selectOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "label", "value" ], "additionalProperties": false } }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "required": [ "required", "selectOptions", "multiple", "maxLength", "minLength" ], "additionalProperties": false } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "reference" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "refModel": { "type": "string", "nullable": true }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "multiple", "maxLength", "minLength" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "map" ] }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "default": false }, "defaultMapView": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "center": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "lat", "lng" ], "additionalProperties": false }, "zoom": { "type": "number" } }, "required": [ "enabled", "center", "zoom" ], "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "defaultMapView" ] } ] } }, "required": [ "type", "typeOptions" ] } ] }, { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "uid", "name" ] }, { "type": "object", "properties": { "type": { "type": "string", "not": { "enum": [ "text", "number", "image", "file", "rich_text", "date", "checkbox", "select", "reference", "map", "multi_type" ] } }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "maxLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false }, "minLength": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "value": { "type": "number" } }, "required": [ "enabled", "value" ], "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "multiple", "maxLength", "minLength" ] } ] } }, "required": [ "type", "typeOptions" ] } ] } ] } } }, "required": [ "id", "collectionId", "uid", "name", "fields" ], "additionalProperties": false } } } }, "400": { "description": "Bad Request. CMS Management API 400 responses include a non-empty detail.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CmsBadRequestProblemDetail" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false } } } }, "422": { "description": "Unprocessable Content. CMS model or custom field type structure validation failed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CmsUnprocessableProblemDetail" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false } } } } }, "security": [ { "bearer": [] } ], "parameters": [ { "in": "header", "name": "x-karte-api", "schema": { "type": "string" }, "description": "今後利用する可能性のある予約語です。現在は設定不要です。" }, { "in": "header", "name": "authorization", "schema": { "type": "string" }, "description": "認証情報を含むトークンです。\"Authorization\" ヘッダーに `Bearer ` の形式で設定してください。" }, { "in": "header", "name": "content-type", "schema": { "type": "string" }, "description": "リクエストのコンテンツタイプを指定します。通常は `application/json` を使用してください。" } ] } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } }, "schemas": { "CmsBadRequestProblemDetail": { "description": "RFC 9457 Problem Details returned when the CMS request is invalid.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "https://api.karte.io/errors/bad-request" ] }, "title": { "type": "string", "enum": [ "Bad Request" ] }, "status": { "type": "integer", "enum": [ 400 ] }, "detail": { "type": "string", "minLength": 1 }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ], "additionalProperties": false } } }, "required": [ "type", "title", "status", "detail" ], "additionalProperties": false }, "CmsUnprocessableProblemDetail": { "description": "RFC 9457 Problem Details returned when a CMS model or custom field type structure is invalid.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "https://api.karte.io/errors/unprocessable-content" ] }, "title": { "type": "string", "enum": [ "Unprocessable Content" ] }, "status": { "type": "integer", "enum": [ 422 ] }, "detail": { "type": "string", "minLength": 1 }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ], "additionalProperties": false } } }, "required": [ "type", "title", "status", "detail" ], "additionalProperties": false } } }, "x-explorer-enabled": false } ````