API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

notes

Creates a notes resource.

Creates a notes resource.

Authorizations:
JWT
path Parameters
id
required
string

notes identifier

Request Body schema:
required

The new notes resource

shortcode
string
Default: "NO"
content
string or null
refTable
string or null
rowId
integer or null
relatedNotes
Array of strings <iri-reference> [ items <iri-reference > ]

Relation notes that this note is related to

parent
string or null <iri-reference>
children
Array of strings <iri-reference> [ items <iri-reference > ]

// MUST BE MAPPED IN ENTITY

status
required
string <iri-reference>
type
required
string <iri-reference>
author
required
string <iri-reference>
participants
Array of strings <iri-reference> [ items <iri-reference > ]
project
string or null <iri-reference>
priority
integer or null
comments
Array of strings <iri-reference> [ items <iri-reference > ]
object
owningCorporation
string <iri-reference>
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
root
integer or null

Get root.

lvl
integer

Get lvl.

lft
integer

Get lft.

rgt
integer

Get rgt.

apiTranslations
Array of strings
title
string or null
descriptionInternal
any
currentLocale
string or null

currentLocale is a non persisted field configured during postLoad event

defaultLocale
string
Default: "en"
connections
Array of strings <iri-reference> [ items <iri-reference > ]
currentDescription
string or null
currentTitle
string or null
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "shortcode": "NO",
  • "content": "string",
  • "refTable": "string",
  • "rowId": 0,
  • "relatedNotes": [],
  • "parent": "https://example.com/",
  • "children": [],
  • "status": "https://example.com/",
  • "type": "https://example.com/",
  • "author": "https://example.com/",
  • "participants": [],
  • "project": "https://example.com/",
  • "priority": 0,
  • "comments": [],
  • "translations": {
    },
  • "owningCorporation": "https://example.com/",
  • "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",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "apiTranslations": [
    ],
  • "title": "string",
  • "descriptionInternal": null,
  • "currentLocale": "string",
  • "defaultLocale": "en",
  • "connections": [],
  • "currentDescription": "string",
  • "currentTitle": "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": "NO",
  • "content": "string",
  • "refTable": "string",
  • "rowId": 0,
  • "parent": { },
  • "children": [
    ],
  • "status": {
    },
  • "type": {
    },
  • "author": {
    },
  • "project": {
    },
  • "comments": [
    ],
  • "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",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "title": "string",
  • "toString": null,
  • "translationDescriptionPropertyName": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "translationTitlePropertyName": "string",
  • "virtualRelation": true,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}