API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

keyvaluestore_keyvalues

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
user
string or null <iri-reference>
corporation
string or null <iri-reference>
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

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": "https://example.com/",
  • "corporation": "https://example.com/",
  • "notes": "string",
  • "clearanceLevel": 7,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shortcode": "KVS",
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": "https://example.com/",
  • "corporation": "https://example.com/",
  • "notes": "string",
  • "clearanceLevel": 7,
  • "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",
  • "tags": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": {
    },
  • "fieldFromKey": "string",
  • "customPropertiesListing": "string",
  • "apiShortname": "string",
  • "tableName": "string",
  • "fullEntityString": "string",
  • "anonymousToken": "string",
  • "tokenString": "string",
  • "entityMetatadaEndpoint": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "notesListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "fQCN": "string",
  • "uniqueId": "string",
  • "apiCustomData": null,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "taggableType": "string",
  • "taggableId": 0,
  • "taggingListing": "string",
  • "enabled": true,
  • "enabledVirtual": true,
  • "disabled": true,
  • "entityStorageFolder": "string"
}