Roles

>>>

GET /api/roles
모든 역할 나열

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
search
Optional

필터 결과

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

페이지네이션 결과

Validations:

  • Must be a String
per_page
Optional

요청 당 항목 수

Validations:

  • Must be a String

Search fields

Field name 유형 Possible values
builtin true, false
description text
name string
permission string
>>>

GET /api/roles/:id
역할 표시

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
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
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
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: ko.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ko.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: ko.apipie.nil_allowed">Nil Allowed</span>

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
역할 업데이트

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
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: ko.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ko.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: ko.apipie.nil_allowed">Nil Allowed</span>

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
역할 삭제

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
>>>

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

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer
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: ko.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: ko.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: ko.apipie.nil_allowed">Nil Allowed</span>

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type