API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

custom_properties

Retrieves the collection of custom_properties resources.

Retrieves the collection of custom_properties 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[source]
boolean
exists[maxLength]
boolean
exists[minLength]
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[tableName]
string
Default: "asc"
Enum: "asc" "desc"
order[propertyName]
string
Default: "asc"
Enum: "asc" "desc"
order[fieldType]
string
Default: "asc"
Enum: "asc" "desc"
order[propertyType]
string
Default: "asc"
Enum: "asc" "desc"
order[source]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[maxLength]
string
Default: "asc"
Enum: "asc" "desc"
order[minLength]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[required]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
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"
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
fieldType_end_with
string
fieldType_partial
string
fieldType_start_with
string
fieldType
string
fieldType[]
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
maxLength_range[between]
string
maxLength_range[gt]
string
maxLength_range[gte]
string
maxLength_range[lt]
string
maxLength_range[lte]
string
maxLength
integer
maxLength[]
Array of integers
minLength_range[between]
string
minLength_range[gt]
string
minLength_range[gte]
string
minLength_range[lt]
string
minLength_range[lte]
string
minLength
integer
minLength[]
Array of integers
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
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
propertyName_end_with
string
propertyName_partial
string
propertyName_start_with
string
propertyName
string
propertyName[]
Array of strings
propertyType_end_with
string
propertyType_partial
string
propertyType_start_with
string
propertyType
string
propertyType[]
Array of strings
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
tableName_end_with
string
tableName_partial
string
tableName_start_with
string
tableName
string
tableName[]
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": {
    }
}

Creates a custom_properties resource.

Creates a custom_properties resource.

Authorizations:
JWT
Request Body schema:
required

The new custom_properties resource

tableName
required
string
propertyName
required
string^([a-zA-Z_\-$][a-zA-Z_\-$0-9]*)$
fieldType
required
string

This is the value type for THE FORM

propertyType
required
string

This is the value type for THE API

source
string or null
priority
integer
required
boolean
maxLength
integer or null
minLength
integer 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
{
  • "tableName": "string",
  • "propertyName": "string",
  • "fieldType": "string",
  • "propertyType": "string",
  • "source": "string",
  • "priority": 0,
  • "required": true,
  • "maxLength": 0,
  • "minLength": 0,
  • "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",
  • "tableName": "string",
  • "propertyName": "string",
  • "fieldType": "string",
  • "propertyType": "string",
  • "source": "string",
  • "priority": 0,
  • "required": true,
  • "maxLength": 0,
  • "minLength": 0,
  • "notes": "string",
  • "shortcode": "CP",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}