Space/sheets

​
社内シートタブ内の型指定されたカラムを一覧取得

GET
/v1/space/sheets/{sheet_id}/tabs/{tab_id}/columns
curl -X GET "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E/tabs/%3Ctab_id%3E/columns" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "data": [    {      "color": "<string>",      "currencyCode": "<string>",      "description": "<string>",      "hidden": true,      "id": "<string>",      "options": [        "<string>"      ],      "pinned": true,      "title": "<string>",      "type": "text",      "width": 104    }  ]}

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

順序通りのカラムです。

dataobject[]必須
data[]object
追加プロパティ
許可しない
data[].colorstring
data[].currencyCodestring
data[].descriptionstring
data[].hiddenboolean
data[].idstring必須
文字数
≥ 1, ≤ 256
data[].optionsstring[]
data[].options[]string
data[].pinnedboolean
data[].titlestring必須
data[].typestringenum<string>必須
許可される値
textnumbercurrencyurldomaindatetimestampemailimagecheckboxselectmulti-select
data[].widthinteger
値の範囲
≥ 104