Space/sheets

​
社内シートの列を編集または並べ替え

型の変更により、互換性のあるセル値は型変換され、互換性のない値は削除されます。選択オプションは一致する値のみを保持します。位置は 0 始まりです。

PATCH
/v1/space/sheets/{sheet_id}/tabs/{tab_id}/columns/{column_id}
curl -X PATCH "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E/tabs/%3Ctab_id%3E/columns/%3Ccolumn_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "color": "string",  "currencyCode": "string",  "description": "string",  "hidden": true,  "options": [    "string"  ],  "pinned": true,  "position": 1,  "title": "string",  "type": "text",  "updated_at": "string",  "width": 1}'
{  "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
column_idstringpath必須
文字数
≥ 1, ≤ 256

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
colorstringbody
currencyCodestringbody
パターン
^[A-Z]{3}$
descriptionstringbody
hiddenbooleanbody
optionsstring[]body
options[]stringbody
pinnedbooleanbody
positionintegerbody
値の範囲
≥ 0
titlestringbody
文字数
≥ 1, ≤ 100
typestringenum<string>body
許可される値
textnumbercurrencyurldomaindatetimestampemailimagecheckboxselectmulti-select
updated_atstringbody必須形式:date-time
widthintegerbody
値の範囲
≥ 104

レスポンス

application/json

更新されたシートです。

dataSpaceSheet必須
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必須