ワークスペース/フォルダ一覧を取得

LegalOn API (1.1.0)

API documentation for LegalOn services

Servers

サーバーのURLは `{api_base_url}/rest/v1` です。アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。

https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

ワークスペース

共通のワークスペース/フォルダは、契約書などのリソースを格納・整理する単位です。本エンドポイントは、APIを呼び出すユーザーがアクセス権を持つワークスペース/フォルダをツリー構造で返します。契約書APIなどワークスペースを対象とする操作では、ここで取得した workspace_id を指定してください。テナント内全体の管理（作成・権限設定など）は管理者設定のワークスペース操作（/spaces）を参照してください。

Operations

ワークスペース/フォルダ一覧を取得

Request

呼び出し元が閲覧権限を持つ共通のワークスペース/フォルダを取得します。取得した workspace_id は、ワークスペースを対象とする契約書APIの操作に使用します。

Security

OAuth2ClientCredentials

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/workspaces' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常にワークスペース/フォルダ一覧を取得

Bodyapplication/json

workspacesArray of objects(workspace)required

呼び出し元が参照できるワークスペース/フォルダツリーのルート

workspaces[].workspace_idstring(uuid)required

ワークスペース/フォルダID

workspaces[].workspace_namestring[ 1 .. 100 ] charactersrequired

ワークスペース/フォルダ名

workspaces[].access_levelstring(access_level)required

呼び出し元のワークスペース/フォルダに対するアクセスレベル MANAGER:管理者 EDITOR:編集者 POSTER:投稿者 VIEWER:閲覧者

Enum"MANAGER""EDITOR""POSTER""VIEWER"

workspaces[].child_workspacesArray of objects(workspace)required

呼び出し元が参照できる子ワークスペース/フォルダノード

Response

application/json

{
  "workspaces": [
    { … }
  ]
}