Roles

>>>

GET /api/roles
すべてのロールを一覧表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
search
任意

結果のフィルター

Validations:

  • Must be a String
order
任意

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
任意

結果のページネーション

Validations:

  • Must be a String
per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String

検索フィールド

フィールド名 タイプ 設定可能な値
builtin true, false
description text
name string
permission string
>>>

GET /api/roles/:id
ロールの表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
description
任意

Validations:

  • Must be a String
>>>

POST /api/roles
ロールの作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
role
必須

Validations:

  • Must be a Hash
role[name]
必須

Validations:

  • Must be a String
role[description]
任意 , nil可

ロールの説明

Validations:

  • Must be a String
role[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type
role[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
ロールの更新

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String
role
必須

Validations:

  • Must be a Hash
role[name]
任意

Validations:

  • Must be a String
role[description]
任意 , nil可

ロールの説明

Validations:

  • Must be a String
role[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type
role[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
ロールの削除

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String
>>>

POST /api/roles/:id/clone
ロールのクローン作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String
role
必須

Validations:

  • Must be a Hash
role[name]
任意

Validations:

  • Must be a String
role[description]
任意 , nil可

ロールの説明

Validations:

  • Must be a String
role[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type
role[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type