Space/space Fields

​
Space アイテムのフィールド値を設定またはクリア

ファイル/フォルダーアイテムの場合は files:write、ドキュメント/シートアイテムの場合は doc:update が必要です。有効なフィールドタイプおよび設定に照らして値を検証します。Null を指定すると、必須フィールドを含め保存された値が削除されます（required は定義メタデータです）。無効な値の場合は書き込みを行わずに 400 を返します。フィールド値は顧客データであるため、ログに記録してはなりません。

PUT
/v1/space/items/{kind}/{id}/fields/{field_id}
curl -X PUT "https://api.orchestor.io/v1/space/items/document/%3Cid%3E/fields/%3Cfield_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "source": "user",  "value": "string"}'
{  "data": {    "field_id": "<string>",    "source": "user",    "updated_at": "2026-01-01T00:00:00Z",    "updated_by": "<string>"  }}

Orchestor API キーを取得

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

認証

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

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

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

パスパラメータ

kindstringenum<string>path必須
許可される値
documentsheetfilefolder
idstringpath必須
文字数
≥ 1
field_idstringpath必須
文字数
≥ 1

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
sourcestringenum<string>bodyデフォルト:user
許可される値
useraisystem
valueanybody必須

任意の JSON 値。null は保存された値をクリアします。

レスポンス

application/json

Space リソースです。

dataobject必須
data.field_idstring必須
data.sourcestringenum<string>
許可される値
useraisystem
data.updated_atstring形式:date-time
data.updated_bystring | null
data.valueany必須

任意の JSON 値。null は保存された値をクリアします。