--- updatedAt: 2026-04-27T13:23:27.000Z agentTools: projectIndex: https://developers.karte.io/llms.txt --- # Get a model Craft Cross CMSのモデルの情報を取得します。 #### Required Scope APIの実行に必要なScopeです。 ``` beta.cms.model.get ``` #### 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/model/get": { "post": { "tags": [ "Models" ], "summary": "Get a model", "description": "Craft Cross CMSのモデルの情報を取得します。\n\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\nbeta.cms.model.get\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": "コレクションID" }, "modelId": { "type": "string", "description": "モデルID" } }, "required": [ "collectionId", "modelId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model" } } } }, "400": { "description": "Bad Request. CMS Management API 400 responses include a non-empty detail.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CmsBadRequestProblemDetail" } } } } }, "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": { "Model": { "type": "object", "properties": { "id": { "type": "string", "description": "モデルID" }, "sys": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "作成日時" }, "createdBy": { "type": "string", "description": "作成者" }, "updatedAt": { "type": "string", "description": "更新日時" }, "updatedBy": { "type": "string", "description": "更新者" }, "revisionId": { "type": "string", "description": "リビジョンID" }, "modelId": { "type": "string", "description": "モデルID" } }, "required": [ "createdAt", "createdBy", "updatedAt", "updatedBy", "revisionId", "modelId" ], "additionalProperties": false }, "collectionId": { "type": "string", "description": "コレクションID" }, "name": { "type": "string", "description": "モデル名" }, "fields": { "type": "array", "description": "フィールド定義", "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" ] }, "defaultValue": { "type": "string" }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "title": { "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", "title", "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" ] }, "defaultValue": { "type": "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" ] }, "defaultValue": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "sys": { "type": "object", "properties": { "createdAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "nullable": true } }, "required": [ "createdAt", "createdBy", "updatedAt", "updatedBy", "publishedAt" ], "additionalProperties": false }, "title": { "type": "string" }, "description": { "type": "string" }, "altText": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "file": { "type": "object", "properties": { "name": { "type": "string" }, "mimeType": { "type": "string" }, "src": { "type": "string" }, "size": { "type": "number" }, "width": { "type": "number", "nullable": true }, "height": { "type": "number", "nullable": true } }, "required": [ "name", "mimeType", "src", "size" ], "additionalProperties": false } }, "required": [ "id", "sys", "title", "description", "altText", "tagIds", "file" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sys": { "type": "object", "properties": { "createdAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "nullable": true } }, "required": [ "createdAt", "createdBy", "updatedAt", "updatedBy", "publishedAt" ], "additionalProperties": false }, "title": { "type": "string" }, "description": { "type": "string" }, "altText": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "file": { "type": "object", "properties": { "name": { "type": "string" }, "mimeType": { "type": "string" }, "src": { "type": "string" }, "size": { "type": "number" }, "width": { "type": "number", "nullable": true }, "height": { "type": "number", "nullable": true } }, "required": [ "name", "mimeType", "src", "size" ], "additionalProperties": false } }, "required": [ "id", "sys", "title", "description", "altText", "tagIds", "file" ], "additionalProperties": false } } ] }, "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" ] }, "defaultValue": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "sys": { "type": "object", "properties": { "createdAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "nullable": true } }, "required": [ "createdAt", "createdBy", "updatedAt", "updatedBy", "publishedAt" ], "additionalProperties": false }, "title": { "type": "string" }, "description": { "type": "string" }, "altText": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "file": { "type": "object", "properties": { "name": { "type": "string" }, "mimeType": { "type": "string" }, "src": { "type": "string" }, "size": { "type": "number" }, "width": { "type": "number", "nullable": true }, "height": { "type": "number", "nullable": true } }, "required": [ "name", "mimeType", "src", "size" ], "additionalProperties": false } }, "required": [ "id", "sys", "title", "description", "altText", "tagIds", "file" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sys": { "type": "object", "properties": { "createdAt": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "nullable": true } }, "required": [ "createdAt", "createdBy", "updatedAt", "updatedBy", "publishedAt" ], "additionalProperties": false }, "title": { "type": "string" }, "description": { "type": "string" }, "altText": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "file": { "type": "object", "properties": { "name": { "type": "string" }, "mimeType": { "type": "string" }, "src": { "type": "string" }, "size": { "type": "number" }, "width": { "type": "number", "nullable": true }, "height": { "type": "number", "nullable": true } }, "required": [ "name", "mimeType", "src", "size" ], "additionalProperties": false } }, "required": [ "id", "sys", "title", "description", "altText", "tagIds", "file" ], "additionalProperties": false } } ] }, "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" ] }, "defaultValue": { "type": "object", "description": "Default rich text value", "properties": { "text": { "type": "string" }, "html": { "type": "string" }, "json": { "type": "object", "description": "JSON representation of rich text content", "additionalProperties": { "nullable": true } } }, "required": [ "text", "html", "json" ], "additionalProperties": false }, "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" ] }, "defaultValue": { "type": "string" }, "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" ] }, "defaultValue": { "type": "boolean" }, "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" ] }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "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" ] }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "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" ] }, "defaultValue": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "lat", "lng" ], "additionalProperties": false }, "typeOptions": { "allOf": [ { "type": "object", "properties": { "required": { "type": "boolean" }, "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", "enum": [ "multi_type" ] }, "defaultValue": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "nullable": true } }, "required": [ "id", "type" ], "additionalProperties": false }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "nullable": true } }, "required": [ "id", "type" ], "additionalProperties": false } } ] }, "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 }, "availableTypes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "object", "required": [ "required", "multiple", "maxLength", "minLength", "availableTypes" ] } ] } }, "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" ] } }, "defaultValue": { "anyOf": [ { "type": "object", "additionalProperties": { "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } } ] }, "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" ] } ] } ] } }, "previewSettings": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "plain" ] }, "url": { "type": "string" } }, "required": [ "type", "url" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "url" ], "additionalProperties": false } ] } }, "required": [ "id", "sys", "collectionId", "name", "fields", "previewSettings" ], "additionalProperties": false }, "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 } } }, "x-explorer-enabled": false } ````