API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

import_jobs

Retrieves the collection of import_jobs resources.

Retrieves the collection of import_jobs 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[fileName]
boolean
exists[originalFileName]
boolean
exists[filePath]
boolean
exists[metadata]
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[fileName]
string
Default: "asc"
Enum: "asc" "desc"
order[originalFileName]
string
Default: "asc"
Enum: "asc" "desc"
order[filePath]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[jobStartDate]
string
Default: "asc"
Enum: "asc" "desc"
order[jobEndDate]
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[slug]
string
Default: "asc"
Enum: "asc" "desc"
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
fileName_end_with
string
fileName_partial
string
fileName_start_with
string
fileName
string
fileName[]
Array of strings
filePath_end_with
string
filePath_partial
string
filePath_start_with
string
filePath
string
filePath[]
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
jobEndDate[before]
string
jobEndDate[strictly_before]
string
jobEndDate[after]
string
jobEndDate[strictly_after]
string
jobStartDate[before]
string
jobStartDate[strictly_before]
string
jobStartDate[after]
string
jobStartDate[strictly_after]
string
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
originalFileName_end_with
string
originalFileName_partial
string
originalFileName_start_with
string
originalFileName
string
originalFileName[]
Array of strings
person
string
person[]
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": {
    }
}