API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_companytypes

Creates a person_companytypes resource.

Creates a person_companytypes resource.

Authorizations:
JWT
path Parameters
id
required
string

person_companytypes identifier

Request Body schema:
required

The new person_companytypes resource

persons
Array of strings <iri-reference> [ items <iri-reference > ]
value
required
integer [ -8388607 .. 8388607 ]
parent
string or null <iri-reference>
children
Array of strings <iri-reference> [ items <iri-reference > ]

// MUST BE MAPPED IN ENTITY

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
number
string or null
priority
integer
color
string or null
icon
string or null
notes
string or null
object
title
string
parameterTitle
string
apiTranslations
Array of strings
descriptionInternal
any
currentLocale
string or null

currentLocale is a non persisted field configured during postLoad event

defaultLocale
string
Default: "en"
root
integer or null

Get root.

lvl
integer

Get lvl.

lft
integer

Get lft.

rgt
integer

Get rgt.

currentTitle
string or null
currentDescription
string or null
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "persons": [],
  • "value": -8388607,
  • "parent": "https://example.com/",
  • "children": [],
  • "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",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "translations": {
    },
  • "title": "string",
  • "parameterTitle": "string",
  • "apiTranslations": [
    ],
  • "descriptionInternal": null,
  • "currentLocale": "string",
  • "defaultLocale": "en",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "currentTitle": "string",
  • "currentDescription": "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",
  • "value": -8388607,
  • "parent": { },
  • "children": [
    ],
  • "shortcode": "CT",
  • "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",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "parameterTitle": "string",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "personsListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "toString": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}