API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

note_statuses

Retrieves the collection of note_statuses resources.

Retrieves the collection of note_statuses 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

updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
id
integer
id[]
Array of integers
number
string
number[]
Array of strings
color
string
color[]
Array of strings
icon
string
icon[]
Array of strings
search
string
priority
integer
priority[]
Array of integers
exists[notes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
exists[number]
boolean
exists[color]
boolean
exists[icon]
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).

tag
string

Filter using tag.

order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[number]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[color]
string
Default: "asc"
Enum: "asc" "desc"
order[icon]
string
Default: "asc"
Enum: "asc" "desc"
slug_partial
string
id
integer
slug_start_with
string
id
integer
slug_end_with
string
id
integer
slug
string
id_partial
integer
slug
string
id_start_with
integer
slug
string
id_end_with
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer

Responses

Response samples

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

Creates a note_statuses resource.

Creates a note_statuses resource.

Authorizations:
JWT
Request Body schema:
required

The new note_statuses resource

note_statuses.jsonld-add_post (object) or null
note_statuses.jsonld-add_post (object) or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
number
string or null
priority
integer
color
string or null
icon
string or null
notes
string or null
parameterTitle
string
apiTranslations
Array of strings

Responses

Request samples

Content type
{
  • "previous": { },
  • "next": { },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "parameterTitle": "string",
  • "apiTranslations": [
    ]
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "relatedNotes": [],
  • "previous": "https://example.com/",
  • "next": "https://example.com/",
  • "shortcode": "NS",
  • "title": "string",
  • "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": {
    },
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "translations": {
    },
  • "parameterTitle": "string",
  • "apiTranslations": [
    ],
  • "newTranslations": {
    },
  • "currentLocale": "string",
  • "defaultLocale": "en",
  • "notesListing": "string",
  • "apiShortname": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "toString": "string",
  • "translationTitlePropertyName": "string",
  • "currentTranslation": "string",
  • "currentTitle": "string",
  • "currentDescription": "string",
  • "translationEntityClass": null,
  • "translationDescriptionPropertyName": "string",
  • "fullEntityString": "string",
  • "anonymousToken": "string",
  • "tokenString": "string",
  • "entityMetatadaEndpoint": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "tableName": "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"
}