Skip to content

LegalOn API (1.0.0)

API documentation for LegalOn services

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

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

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

Operations

ワークスペース

ワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

部署一覧を取得

Request

部署の一覧を取得します

Security
OAuth2ClientCredentials
Query
search_querystringnon-empty

部署名の検索クエリ（部分一致）

page_sizeinteger>= 1required

1ページあたりの取得件数

page_tokenstring

前/次ページ取得用トークン

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/departments?search_query=string&page_size=1&page_token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に部署一覧を取得

Bodyapplication/json
departmentsArray of objects(department)required
departments[].​department_idstring(uuid)required

部署ID

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

部署名

next_page_tokenstring

次のページを取得するトークン（ページが存在しない場合は省略）

prev_page_tokenstring

前のページを取得するトークン（ページが存在しない場合は省略）

total_sizeinteger>= 0required

検索条件に一致する総数

Response
application/json
{
  "departments": [
    { … }
  ],
  "total_size": 150,
  "next_page_token": "eyJvZmZz...",
  "prev_page_token": "eyJvZmZz..."
}

部署を作成

Request

新しい部署を作成します

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

部署作成リクエスト

display_namestring[ 1 .. 100 ] charactersrequired

部署名

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/departments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string"
  }'

Responses

正常に部署を作成

Bodyapplication/json
department_idstring(uuid)required

部署ID

display_namestring[ 1 .. 100 ] charactersrequired

部署名

Response
application/json
{
  "department_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department"
}

部署を更新

Request

部署を更新します

Security
OAuth2ClientCredentials
Path
department_idstring(uuid)required

部署ID

Bodyapplication/jsonrequired

部署更新リクエスト

display_namestring[ 1 .. 100 ] charactersrequired

Department name

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/departments/{department_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string"
  }'

Responses

正常に部署を更新

Bodyapplication/json
department_idstring(uuid)required

部署ID

display_namestring[ 1 .. 100 ] charactersrequired

部署名

Response
application/json
{
  "department_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department"
}