Space/sheets

​
社内 Space シートの名前変更、ピン留め、並べ替え、アーカイブ、または編集を行う

PATCH
/v1/space/sheets/{sheet_id}
curl -X PATCH "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "archived": true,  "pinned": true,  "sort_position": 1,  "tabs": [    {      "columns": [        {          "color": "string",          "currencyCode": "string",          "description": "string",          "hidden": true,          "id": "string",          "options": [            "string"          ],          "pinned": true,          "title": "string",          "type": "text",          "width": 1        }      ],      "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": "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}$

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
archivedbooleanbody
pinnedbooleanbody
sort_positionintegerbody
値の範囲
≥ 0, ≤ 2147483647
tabsobject[]body
要素数
≥ 1
tabs[]objectbody
追加プロパティ
許可しない
tabs[].columnsobject[]body
tabs[].columns[]objectbody
追加プロパティ
許可しない
tabs[].columns[].colorstringbody
tabs[].columns[].currencyCodestringbody
tabs[].columns[].descriptionstringbody
tabs[].columns[].hiddenbooleanbody
tabs[].columns[].idstringbody必須
文字数
≥ 1, ≤ 256
tabs[].columns[].optionsstring[]body
tabs[].columns[].options[]stringbody
tabs[].columns[].pinnedbooleanbody
tabs[].columns[].titlestringbody必須
tabs[].columns[].typestringenum<string>body必須
許可される値
textnumbercurrencyurldomaindatetimestampemailimagecheckboxselectmulti-select
tabs[].columns[].widthintegerbody
値の範囲
≥ 104
tabs[].deletedbooleanbody
tabs[].filterobjectbody
追加プロパティ
許可しない
tabs[].filter.columnIdstringbody必須
文字数
≥ 1, ≤ 256
tabs[].filter.valuestringbody必須
tabs[].hiddenbooleanbody
tabs[].idstringbody必須
文字数
≥ 1, ≤ 256
tabs[].rowsobject[]body必須
tabs[].rows[]objectbody
追加プロパティ
許可しない
tabs[].rows[].idstringbody必須
文字数
≥ 1, ≤ 256
tabs[].rows[].parentIdstringbody
文字数
≥ 1, ≤ 256
tabs[].rows[].valuesobjectbody
tabs[].rows[].values.*string | number | boolean | string[]body

以下のいずれかに一致

形式 1: string

tabs[].rows[].values.*stringbody

形式 2: number

tabs[].rows[].values.*numberbody

形式 3: boolean

tabs[].rows[].values.*booleanbody

形式 4: string[]

tabs[].rows[].values.*[]stringbody
tabs[].sortobjectbody
追加プロパティ
許可しない
tabs[].sort.columnIdstringbody必須
文字数
≥ 1, ≤ 256
tabs[].sort.directionstringenum<string>body必須
許可される値
ascdesc
tabs[].titlestringbody必須
文字数
≥ 1, ≤ 100
titlestringbody
文字数
≥ 1, ≤ 100
updated_atstringbody必須形式:date-time

レスポンス

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