Examples

PUT /api/filters/1062414190
{
  "filter": {
    "override": false
  }
}
200
{
  "search": null,
  "resource_type": "Domain",
  "resource_type_label": "Domain",
  "unlimited?": false,
  "created_at": "2019-11-07 08:51:43 UTC",
  "updated_at": "2019-11-07 08:51:43 UTC",
  "override?": false,
  "id": 1062414190,
  "role": {
    "name": "New Role",
    "id": 19,
    "description": null,
    "origin": null
  },
  "permissions": [
    {
      "name": "view_domains",
      "id": 623290985,
      "resource_type": "Domain"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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

id
Required

Validations:

  • Must be a String

filter
Required

Validations:

  • Must be a Hash

filter[role_id]
Optional

Validations:

  • Must be a String

filter[search]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

filter[override]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

filter[permission_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type