API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

notes

Retrieves the collection of notes resources.

Retrieves the collection of notes 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[refTable]
boolean
exists[rowId]
boolean
exists[relatedNotes]
boolean
exists[notesRelated]
boolean
exists[parent]
boolean
exists[children]
boolean
exists[participants]
boolean
exists[project]
boolean
exists[comments]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
exists[root]
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[refTable]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[rowId]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[root]
string
Default: "asc"
Enum: "asc" "desc"
order[lvl]
string
Default: "asc"
Enum: "asc" "desc"
order[lft]
string
Default: "asc"
Enum: "asc" "desc"
order[rgt]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
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"
author
string
author[]
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
lft_range[between]
string
lft_range[gt]
string
lft_range[gte]
string
lft_range[lt]
string
lft_range[lte]
string
lft
integer
lft[]
Array of integers
lvl_range[between]
string
lvl_range[gt]
string
lvl_range[gte]
string
lvl_range[lt]
string
lvl_range[lte]
string
lvl
integer
lvl[]
Array of integers
parent
string
parent[]
Array of strings
priority_range[between]
string
priority_range[gt]
string
priority_range[gte]
string
priority_range[lt]
string
priority_range[lte]
string
priority
integer
priority[]
Array of integers
project
string
project[]
Array of strings
refTable_end_with
string
refTable_partial
string
refTable_start_with
string
refTable
string
refTable[]
Array of strings
rgt_range[between]
string
rgt_range[gt]
string
rgt_range[gte]
string
rgt_range[lt]
string
rgt_range[lte]
string
rgt
integer
rgt[]
Array of integers
root_range[between]
string
root_range[gt]
string
root_range[gte]
string
root_range[lt]
string
root_range[lte]
string
root
integer
root[]
Array of integers
rowId_range[between]
string
rowId_range[gt]
string
rowId_range[gte]
string
rowId_range[lt]
string
rowId_range[lte]
string
rowId
integer
rowId[]
Array of integers
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

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

Creates a notes resource.

Creates a notes resource.

Authorizations:
JWT
Request Body schema:
required

The new notes resource

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

Relation notes that this note is related to

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

// MUST BE MAPPED IN ENTITY

required
object (note_statuses.jsonld-add_post)

Status.

required
object (note_types.jsonld-add_post)

Type.

required
object (people.jsonld-add_post)

Person.

Array of objects (note_noteparticipants.jsonld-add_post)
projects.jsonld-add_post (object) or null
priority
integer or null
Array of objects (note_comments.jsonld-add_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
}