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
Query
parent_space_idstring(uuid)

親のワークスペース/フォルダID。 指定されていない場合は、すべてのワークスペース/フォルダ一覧を取得。

Responses

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

Bodyapplication/json
spacesArray of objects(space)required
spaces[].​space_idstring(uuid)required

スペースID

spaces[].​display_namestring[ 1 .. 100 ] charactersrequired

スペース名称

spaces[].​descriptionstring[ 0 .. 100 ] characters

スペースの説明

total_sizeinteger>= 0required

検索条件に一致する総数

Response
application/json
{
  "spaces": [
    { … }
  ],
  "total_size": 150
}

ワークスペース/フォルダを作成

Request

新しいワークスペース/フォルダを作成します

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

ワークスペース/フォルダ作成リクエスト

parent_space_idstring(uuid)

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

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

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"
}

部署

部署に関する操作

Operations