API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dataanalysis_dataprocessors

Retrieves the collection of dataanalysis_dataprocessors resources.

Retrieves the collection of dataanalysis_dataprocessors 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[dataCollectors]
boolean
exists[dataProcessorResults]
boolean
exists[seriesNames]
boolean
exists[graphType]
boolean
exists[widgets]
boolean
exists[templates]
boolean
exists[notes]
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[title]
string
Default: "asc"
Enum: "asc" "desc"
order[managerName]
string
Default: "asc"
Enum: "asc" "desc"
order[seriesNames]
string
Default: "asc"
Enum: "asc" "desc"
order[graphType]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[isSeriesData]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[cacheTTL]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
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"
cacheTTL_range[between]
string
cacheTTL_range[gt]
string
cacheTTL_range[gte]
string
cacheTTL_range[lt]
string
cacheTTL_range[lte]
string
cacheTTL
integer
cacheTTL[]
Array of integers
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
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
graphType_end_with
string
graphType_partial
string
graphType_start_with
string
graphType
string
graphType[]
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
isSeriesData
boolean
managerName_end_with
string
managerName_partial
string
managerName_start_with
string
managerName
string
managerName[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
seriesNames_end_with
string
seriesNames_partial
string
seriesNames_start_with
string
seriesNames
string
seriesNames[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
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": {
    }
}