API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

keyvaluestore_keyvalues

Retrieves the collection of keyvaluestore_keyvalues resources.

Retrieves the collection of keyvaluestore_keyvalues 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[description]
boolean
exists[user]
boolean
exists[corporation]
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[key]
string
Default: "asc"
Enum: "asc" "desc"
order[description]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[value]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[clearanceLevel]
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"
clearanceLevel_range[between]
string
clearanceLevel_range[gt]
string
clearanceLevel_range[gte]
string
clearanceLevel_range[lt]
string
clearanceLevel_range[lte]
string
clearanceLevel
integer
clearanceLevel[]
Array of integers
corporation
string
corporation[]
Array of strings
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
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
key_end_with
string
key_partial
string
key_start_with
string
key
string
key[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
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
user
string
user[]
Array of strings
value_end_with
string
value_partial
string
value_start_with
string

Responses

Response samples

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

Creates a keyvaluestore_keyvalues resource.

Creates a keyvaluestore_keyvalues resource.

Authorizations:
JWT
Request Body schema:
required

The new keyvaluestore_keyvalues resource

key
string >= 2 characters
value
string
description
string or null
users.jsonld-add_post (object) or null
person_corporations.jsonld-add_post (object) or null
notes
string or null
clearanceLevel
integer
Default: 7

0 secret 1 super-admin 2 admin 3 super user 4 manager 5 sub manager 6 user 7 limiter user 8 almost general 9 general 10 public

https://github.com/PHPCreation/phpr_erp/issues/3316

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
{
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": {
    },
  • "corporation": {
    },
  • "notes": "string",
  • "clearanceLevel": 7,
  • "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",
  • "shortcode": "KVS",
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": {
    },
  • "corporation": {
    },
  • "notes": "string",
  • "clearanceLevel": 7,
  • "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",
  • "fieldFromKey": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}