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

Params

Param Name Description
search
Optional

結果のフィルター

Validations:

  • Must be a String

order
Optional

結果のソート

Validations:

  • Must be a String

page
Optional

結果のページネーション

Validations:

  • Must be a String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be a String


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

Params

Param Name Description
id
Required

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
Optional

Validations:

  • Must be a String


POST /api/roles
ロールの作成

Params

Param Name Description
role
Required

Validations:

  • Must be a Hash

role[name]
Required

Validations:

  • Must be a String

role[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String

role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be a String

role
Required

Validations:

  • Must be a Hash

role[name]
Optional

Validations:

  • Must be a String

role[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String

role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be a String


POST /api/roles/:id/clone
Clone a role

Params

Param Name Description
id
Required

Validations:

  • Must be a String

role
Required

Validations:

  • Must be a Hash

role[name]
Optional

Validations:

  • Must be a String

role[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String

role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type