Examples

POST /api/filters
{
  "filter": {
    "role_id": 17,
    "permission_ids": [
      350275019
    ],
    "override": true,
    "location_ids": [
      255093256
    ],
    "organization_ids": [
      447626438
    ]
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "organization_ids": [
        "You can't assign organizations to this resource"
      ],
      "location_ids": [
        "You can't assign locations to this resource"
      ]
    },
    "full_messages": [
      "Organization ids You can't assign organizations to this resource",
      "Location ids You can't assign locations to this resource"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

filter
required

Validations:

  • Must be a Hash

filter[role_id]
required

Validations:

  • Must be a String

filter[search]
optional , nil allowed

Validations:

  • Must be a String

filter[override]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.

filter[permission_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[organization_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

filter[location_ids]
optional , nil allowed

Validations:

  • Must be an array of any type