Space/space Fields

​
Space アイテムをフォルダーに移動

ファイル/フォルダーアイテムの場合は files:write、ドキュメント/シートアイテムの場合は doc:update が必要です。Null を指定すると、フォルダー所属が解除されます。フォルダーアイテムの場合は、フォルダー更新と同じ循環チェックを行って parent_id を設定します。

PUT
/v1/space/items/{kind}/{id}/folder
curl -X PUT "https://api.orchestor.io/v1/space/items/document/%3Cid%3E/folder" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "folder_id": "string"}'
{  "data": {    "folder_id": "<string>",    "id": "<string>",    "kind": "document"  }}

Orchestor API キーを取得

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

認証

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

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

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

パスパラメータ

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

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
folder_idstring | nullbody必須
文字数
≥ 1

レスポンス

application/json

Space リソースです。

dataobject必須
data.folder_idstring | null必須
data.idstring必須
data.kindstringenum<string>必須
許可される値
documentsheetfilefolder