Space/space Fields

​
Space フィールド定義を作成

workspace:settings が必要です。スラッグはワークスペース/プロジェクトのスコープチェーン内で重複させることはできません。

POST
/v1/space/fields
curl -X POST "https://api.orchestor.io/v1/space/fields" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "config": {},  "is_required": false,  "position": 0,  "project_id": null,  "slug": "string",  "title": "string",  "type": "text"}'
{  "data": {    "archived_at": "2026-01-01T00:00:00Z",    "config": {},    "created_at": "2026-01-01T00:00:00Z",    "id": "<string>",    "is_required": true,    "position": 0,    "project_id": "<string>",    "slug": "<string>",    "title": "<string>",    "type": "text",    "updated_at": "2026-01-01T00:00:00Z",    "workspace_id": "<string>"  }}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

ボディapplication/json必須

以下のちょうど1つに一致

形式 1: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
text

形式 2: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
long_text

形式 3: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.scaleintegerbody必須
値の範囲
≥ 0, ≤ 6
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
number

形式 4: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
checkbox

形式 5: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.optionsobject[]body必須
要素数
≥ 1
config.options[]objectbody
追加プロパティ
許可しない
config.options[].colorstringbody
config.options[].idstringbody必須
文字数
≥ 1
config.options[].labelstringbody必須
文字数
≥ 1
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
select

形式 6: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.optionsobject[]body必須
要素数
≥ 1
config.options[]objectbody
追加プロパティ
許可しない
config.options[].colorstringbody
config.options[].idstringbody必須
文字数
≥ 1
config.options[].labelstringbody必須
文字数
≥ 1
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
multi_select

形式 7: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
date

形式 8: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.multiplebooleanbody必須
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
member

形式 9: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
url

形式 10: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
timecode

形式 11: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
time_range

形式 12: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.item_schemaSpaceJsonSchemabody必須
追加プロパティ
許可しない
config.item_schema.descriptionstringbody
config.item_schema.enumany[]body
要素数
≥ 1
config.item_schema.enum[]anybody
config.item_schema.itemsSpaceJsonSchemabody
config.item_schema.maximumnumberbody
config.item_schema.minimumnumberbody
config.item_schema.propertiesobjectbody
config.item_schema.properties.*SpaceJsonSchemabody
config.item_schema.requiredstring[]body
config.item_schema.required[]stringbody
config.item_schema.typestringenum<string>body必須
許可される値
stringnumberintegerbooleanarrayobject
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
segment_list

形式 13: object

追加プロパティ
許可しない
configobjectbody必須
追加プロパティ
許可しない
config.schemaSpaceJsonSchema & object | nullbody必須

以下のすべてに一致

形式 1: SpaceJsonSchema

追加プロパティ
許可しない
config.schema.descriptionstringbody
config.schema.enumany[]body
要素数
≥ 1
config.schema.enum[]anybody
config.schema.itemsSpaceJsonSchemabody
config.schema.maximumnumberbody
config.schema.minimumnumberbody
config.schema.propertiesobjectbody
config.schema.properties.*SpaceJsonSchemabody
config.schema.requiredstring[]body
config.schema.required[]stringbody
config.schema.typestringenum<string>body必須
許可される値
stringnumberintegerbooleanarrayobject

形式 2: object | null

config.schemaobject | nullbody
is_requiredbooleanbodyデフォルト:false
positionintegerbodyデフォルト:0
project_idstring | nullbodyデフォルト:null
文字数
≥ 1
slugstringbody必須
文字数
≤ 128
パターン
^[a-z][a-z0-9_]*$
titlestringbody必須
文字数
≥ 1, ≤ 256
typestringenum<string>body必須
許可される値
object

レスポンス

application/json

Space リソース

dataSpaceField必須
data.archived_atstring | null必須形式:date-time
data.configobject必須
data.config.*any
data.created_atstring必須形式:date-time
data.idstring必須
data.is_requiredboolean必須
data.positioninteger必須
data.project_idstring | null必須
data.slugstring必須
data.titlestring必須
data.typestringenum<string>必須
許可される値
textlong_textnumbercheckboxselectmulti_selectdatememberurltimecodetime_rangesegment_listobject
data.updated_atstring必須形式:date-time
data.workspace_idstring必須