API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dashboard_filters

Retrieves the collection of dashboard_filters resources.

Retrieves the collection of dashboard_filters resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[parameterName]
boolean
exists[label]
boolean
exists[notes]
boolean
exists[entityName]
boolean
exists[defaultValue]
boolean
exists[choices]
boolean
exists[source]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[parameterName]
string
Default: "asc"
Enum: "asc" "desc"
order[label]
string
Default: "asc"
Enum: "asc" "desc"
order[entityName]
string
Default: "asc"
Enum: "asc" "desc"
order[defaultValue]
string
Default: "asc"
Enum: "asc" "desc"
order[source]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[choices]
string
Default: "asc"
Enum: "asc" "desc"
order[required]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
string
Default: "asc"
Enum: "asc" "desc"
choices_end_with
string
choices_partial
string
choices_start_with
string
choices
string
choices[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dataCollector
string
dataCollector[]
Array of strings
defaultValue_end_with
string
defaultValue_partial
string
defaultValue_start_with
string
defaultValue
string
defaultValue[]
Array of strings
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
entityName_end_with
string
entityName_partial
string
entityName_start_with
string
entityName
string
entityName[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
label_end_with
string
label_partial
string
label_start_with
string
label
string
label[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
parameterName_end_with
string
parameterName_partial
string
parameterName_start_with
string
parameterName
string
parameterName[]
Array of strings
priority_range[between]
string
priority_range[gt]
string
priority_range[gte]
string
priority_range[lt]
string
priority_range[lte]
string
priority
integer
priority[]
Array of integers
required
boolean
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
source_end_with
string
source_partial
string
source_start_with
string
source
string
source[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}