API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

jobs

Retrieves the collection of jobs resources.

Retrieves the collection of 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

finishedExecutionDate[before]
string
finishedExecutionDate[strictly_before]
string
finishedExecutionDate[after]
string
finishedExecutionDate[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
id
integer
id[]
Array of integers
slug
string
slug[]
Array of strings
jobType
string
jobType[]
Array of strings
search
string
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).

tag
string

Filter using tag.

exists[notes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[jobType]
string
Default: "asc"
Enum: "asc" "desc"
order[jobTypeStringIndications]
string
Default: "asc"
Enum: "asc" "desc"
order[jobTypeStringParameters]
string
Default: "asc"
Enum: "asc" "desc"
order[executed]
string
Default: "asc"
Enum: "asc" "desc"
order[finishedExecutionDate]
string
Default: "asc"
Enum: "asc" "desc"
order[resultLogString]
string
Default: "asc"
Enum: "asc" "desc"
order[jobStartDate]
string
Default: "asc"
Enum: "asc" "desc"
order[jobEndDate]
string
Default: "asc"
Enum: "asc" "desc"
order[metadata]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
slug_partial
string
id
integer
slug_start_with
string
id
integer
slug_end_with
string
id
integer
slug
string
id_partial
integer
slug
string
id_start_with
integer
slug
string
id_end_with
integer

Responses

Response samples

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

Creates a jobs resource.

Creates a jobs resource.

Authorizations:
JWT
Request Body schema:
required

The new jobs resource

jobType
required
string
jobTypeStringIndications
string or null
jobTypeStringParameters
string or null
executed
required
boolean
finishedExecutionDate
string or null <date-time>
resultLogString
string or null
jobStartDate
required
string <date-time>
jobEndDate
required
string <date-time>
metadata
Array of strings or null
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "jobType": "string",
  • "jobTypeStringIndications": "string",
  • "jobTypeStringParameters": "string",
  • "executed": true,
  • "finishedExecutionDate": "2019-08-24T14:15:22Z",
  • "resultLogString": "string",
  • "jobStartDate": "2019-08-24T14:15:22Z",
  • "jobEndDate": "2019-08-24T14:15:22Z",
  • "metadata": [
    ],
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "jobType": "string",
  • "jobTypeStringIndications": "string",
  • "jobTypeStringParameters": "string",
  • "executed": true,
  • "finishedExecutionDate": "2019-08-24T14:15:22Z",
  • "jobStartDate": "2019-08-24T14:15:22Z",
  • "jobEndDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "shortcode": "JOB",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "typeName": "string",
  • "runningTime": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}