API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

notes

Retrieves a notes resource.

Retrieves a notes resource.

Authorizations:
JWT
path Parameters
id
required
string

notes identifier

Responses

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",
  • "translationsListing": "string",
  • "childrenListing": "string",
  • "commentsListing": "string",
  • "participantsListing": "string",
  • "connectionsListing": "string",
  • "customPropertiesListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "translationTitlePropertyName": "string",
  • "virtualRelation": true,
  • "anonymousToken": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "notesListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the notes resource.

Replaces the notes resource.

Authorizations:
JWT
path Parameters
id
required
string

notes identifier

Request Body schema:
required

The updated notes resource

content
string or null
refTable
string or null
rowId
integer or null
Array of objects (note_connections.jsonld-post)

Relation notes that this note is related to

notes.jsonld-post (object) or null
children
Array of objects (notes.jsonld-post)

// MUST BE MAPPED IN ENTITY

required
object (note_statuses.jsonld-post)

Status.

required
object (note_types.jsonld-post)

Type.

required
object (people.jsonld-post)

Person.

Array of objects (note_noteparticipants.jsonld-post)
projects.jsonld-post (object) or null
priority
integer or null
Array of objects (note_comments.jsonld-post)
object
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings
title
string or null

Responses

Request samples

Content type
{
  • "content": "string",
  • "refTable": "string",
  • "rowId": 0,
  • "relatedNotes": [
    ],
  • "parent": { },
  • "children": [
    ],
  • "status": {
    },
  • "type": {
    },
  • "author": {
    },
  • "participants": [
    ],
  • "project": {
    },
  • "priority": 0,
  • "comments": [
    ],
  • "translations": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ],
  • "title": "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",
  • "translationsListing": "string",
  • "childrenListing": "string",
  • "commentsListing": "string",
  • "participantsListing": "string",
  • "connectionsListing": "string",
  • "customPropertiesListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "translationTitlePropertyName": "string",
  • "virtualRelation": true,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the notes resource.

Removes the notes resource.

Authorizations:
JWT
path Parameters
id
required
string

notes identifier

Responses