Space/sheets

​
インハウスシートの行をアトミックに作成、更新、削除

値にはカラム ID または一意のタイトルを使用します。厳密なカラム型が適用され、null はセルをクリアします。無効な値がある場合は、row_ref、column_id、reason とともにバッチ全体が拒否されます。プレビューでは、書き込みを行わずにセルの変更内容と作成/削除された行 ID を返します。すべての書き込みでシート全体が返されます。書き込みは冪等ではありません。結果が不明な場合は再試行する前に再読み込みしてください。更新は upsert ではありません。

POST
/v1/space/sheets/{sheet_id}/tabs/{tab_id}/rows/batch
curl -X POST "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E/tabs/%3Ctab_id%3E/rows/batch" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "operations": [    {      "before_row_id": "string",      "op": "create",      "row_id": "string",      "values": {}    }  ],  "preview": true,  "updated_at": "string"}'
{  "data": {    "archived": true,    "created_at": "2026-01-01T00:00:00Z",    "deleted_at": "2026-01-01T00:00:00Z",    "folder_id": null,    "id": "<string>",    "pinned": true,    "sort_position": 0,    "tabs": [      {        "columns": [          {            "color": "<string>",            "currencyCode": "<string>",            "description": "<string>",            "hidden": true,            "id": "<string>",            "options": [              "<string>"            ],            "pinned": true,            "title": "<string>",            "type": "text",            "width": 104          }        ],        "deleted": true,        "filter": {          "columnId": "<string>",          "value": "<string>"        },        "hidden": true,        "id": "<string>",        "rows": [          {            "id": "<string>",            "parentId": "<string>",            "values": {}          }        ],        "sort": {          "columnId": "<string>",          "direction": "asc"        },        "title": "<string>"      }    ],    "title": "<string>",    "updated_at": "2026-01-01T00:00:00Z",    "workspace_id": "<string>"  }}

Orchestor API キーを取得

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

認証

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

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

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

パスパラメータ

sheet_idstringpath必須
パターン
^sht_[a-f0-9]{24}$
tab_idstringpath必須
文字数
≥ 1, ≤ 256

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
operations(object | object | object)[]body必須
要素数
≥ 1
operations[]object | object | objectbody

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

形式 1: object

追加プロパティ
許可しない
operations[].before_row_idstringbody
文字数
≥ 1, ≤ 256
operations[].opstringenum<string>body必須
許可される値
create
operations[].row_idstringbody
文字数
≥ 1, ≤ 256
operations[].valuesobjectbody必須
operations[].values.*anybody

形式 2: object

追加プロパティ
許可しない
operations[].opstringenum<string>body必須
許可される値
update
operations[].row_idstringbody必須
文字数
≥ 1, ≤ 256
operations[].valuesobjectbody必須
operations[].values.*anybody

形式 3: object

追加プロパティ
許可しない
operations[].opstringenum<string>body必須
許可される値
delete
operations[].row_idstringbody必須
文字数
≥ 1, ≤ 256
previewbooleanbody
updated_atstringbody必須形式:date-time

レスポンス

application/json

更新されたシート全体またはプレビューの差分です。

dataSpaceSheet | object必須

以下のいずれかに一致

形式 1: SpaceSheet

data.archivedboolean必須
data.created_atstring必須形式:date-time
data.deleted_atstring | null必須形式:date-time
data.folder_idstring | nullデフォルト:null
data.idstring必須
パターン
^sht_[a-f0-9]{24}$
data.pinnedboolean必須
data.sort_positioninteger必須
値の範囲
≥ 0, ≤ 2147483647
data.tabsobject[]必須
要素数
≥ 1
data.tabs[]object
追加プロパティ
許可しない
data.tabs[].columnsobject[]
data.tabs[].columns[]object
追加プロパティ
許可しない
data.tabs[].columns[].colorstring
data.tabs[].columns[].currencyCodestring
data.tabs[].columns[].descriptionstring
data.tabs[].columns[].hiddenboolean
data.tabs[].columns[].idstring必須
文字数
≥ 1, ≤ 256
data.tabs[].columns[].optionsstring[]
data.tabs[].columns[].options[]string
data.tabs[].columns[].pinnedboolean
data.tabs[].columns[].titlestring必須
data.tabs[].columns[].typestringenum<string>必須
許可される値
textnumbercurrencyurldomaindatetimestampemailimagecheckboxselectmulti-select
data.tabs[].columns[].widthinteger
値の範囲
≥ 104
data.tabs[].deletedboolean
data.tabs[].filterobject
追加プロパティ
許可しない
data.tabs[].filter.columnIdstring必須
文字数
≥ 1, ≤ 256
data.tabs[].filter.valuestring必須
data.tabs[].hiddenboolean
data.tabs[].idstring必須
文字数
≥ 1, ≤ 256
data.tabs[].rowsobject[]必須
data.tabs[].rows[]object
追加プロパティ
許可しない
data.tabs[].rows[].idstring必須
文字数
≥ 1, ≤ 256
data.tabs[].rows[].parentIdstring
文字数
≥ 1, ≤ 256
data.tabs[].rows[].valuesobject
data.tabs[].rows[].values.*string | number | boolean | string[]

以下のいずれかに一致

形式 1: string

data.tabs[].rows[].values.*string

形式 2: number

data.tabs[].rows[].values.*number

形式 3: boolean

data.tabs[].rows[].values.*boolean

形式 4: string[]

data.tabs[].rows[].values.*[]string
data.tabs[].sortobject
追加プロパティ
許可しない
data.tabs[].sort.columnIdstring必須
文字数
≥ 1, ≤ 256
data.tabs[].sort.directionstringenum<string>必須
許可される値
ascdesc
data.tabs[].titlestring必須
文字数
≥ 1, ≤ 100
data.titlestring必須
文字数
≥ 1, ≤ 100
data.updated_atstring必須形式:date-time
data.workspace_idstring必須

形式 2: object

data.changesobject[]必須
data.changes[]object
data.changes[].afterstring | number | boolean | string[] | null必須

以下のいずれかに一致

形式 1: string

data.changes[].afterstring

形式 2: number

data.changes[].afternumber

形式 3: boolean

data.changes[].afterboolean

形式 4: string[]

data.changes[].after[]string

形式 5: null

data.changes[].afternull
data.changes[].beforestring | number | boolean | string[] | null必須

以下のいずれかに一致

形式 1: string

data.changes[].beforestring

形式 2: number

data.changes[].beforenumber

形式 3: boolean

data.changes[].beforeboolean

形式 4: string[]

data.changes[].before[]string

形式 5: null

data.changes[].beforenull
data.changes[].column_idstring必須
文字数
≥ 1, ≤ 256
data.changes[].row_idstring必須
文字数
≥ 1, ≤ 256
data.createdstring[]必須
data.created[]string
文字数
≥ 1, ≤ 256
data.deletedstring[]必須
data.deleted[]string
文字数
≥ 1, ≤ 256
data.previewbooleanenum<boolean>必須
許可される値
true