Skip to content
/
ワークスペース/フォルダを移動

LegalOn API (0.9.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

ワークスペース/フォルダを更新

Request

ワークスペース/フォルダを更新します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

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

Bodyapplication/jsonrequired

ワークスペース/フォルダ更新リクエスト

display_namestring[ 1 .. 100 ] charactersrequired

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

descriptionstring[ 0 .. 100 ] characters

ワークスペース/フォルダの説明

Responses

正常にワークスペース/フォルダを更新

Bodyapplication/json
space_idstring(uuid)required

スペースID

display_namestring[ 1 .. 100 ] charactersrequired

スペース名称

descriptionstring[ 0 .. 100 ] characters

スペースの説明

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department Space",
  "description": "Contract Review Space"
}

ワークスペース/フォルダを移動

Request

ワークスペース/フォルダを移動します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

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

Bodyapplication/jsonrequired

ワークスペース/フォルダ移動リクエスト

destination_parent_space_idstring(uuid)

移動先の親ワークスペース/フォルダID。指定されたワークスペース/フォルダの直下に移動します。指定されていない場合は、トップ階層に移動します。

Responses

正常にワークスペース/フォルダを移動

Response
No content

アクセスコントロール一覧を取得

Request

アクセスコントロール一覧を取得します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

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

Query
search_querystringnon-empty

検索文字列。ユーザー名、ユーザーグループ名、またはメールアドレス。

Responses

正常にアクセスコントロール一覧を取得

Bodyapplication/json
space_idstring(uuid)required

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

is_inheritedbooleanrequired

アクセスコントロールが上位から継承されているかどうか

user_group_access_levelArray of objects(user_group_access_level)
user_access_levelArray of objects(user_access_level)
user_group_total_sizeinteger>= 0

検索条件に一致するユーザーグループの総数

user_total_sizeinteger>= 0

検索条件に一致するユーザーの総数

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "is_inherited": false,
  "user_group_access_level": [
    { … },
    { … }
  ],
  "user_access_level": [
    { … }
  ],
  "user_group_total_size": 2,
  "user_total_size": 1
}

部署

部署に関する操作

Operations