Roles

>>>

GET /api/roles
Lista wszystkich roli

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String
order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.
per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
builtin true, false
description
name
permission string
>>>

GET /api/roles/:id
Pokaż rolę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

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
opcjonalny

Validations:

  • Must be a String
>>>

POST /api/roles
Utwórz rolę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
role
wymagany

Validations:

  • Must be a Hash
role[name]
wymagany

Validations:

  • Must be a String
role[description]
opcjonalny , nil dopuszczalny

Role description

Validations:

  • Must be a String
role[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
role[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
Aktualizuj rolę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Validations:

  • Must be a String
role
wymagany

Validations:

  • Must be a Hash
role[name]
opcjonalny

Validations:

  • Must be a String
role[description]
opcjonalny , nil dopuszczalny

Role description

Validations:

  • Must be a String
role[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
role[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
Usuń rolę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Validations:

  • Must be a String
>>>

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Validations:

  • Must be a String
role
wymagany

Validations:

  • Must be a Hash
role[name]
opcjonalny

Validations:

  • Must be a String
role[description]
opcjonalny , nil dopuszczalny

Role description

Validations:

  • Must be a String
role[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
role[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type