Sign in
Notes

note_get_collection_summary

note_get_collection_description

post/pimcore-studio/api/notes

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/notes
  • Auth: none declared

Request body

pageinteger required
pageSizeinteger required
sortOrder'ASC' | 'DESC'

Sort order (asc or desc).

sortBy'id' | 'type' | 'cId' | 'cType' | 'cPath' | 'date' | 'title' | 'description' | 'locked'

Sort by field. Only works in combination with sortOrder.

filterstring

Filter for notes

fieldFiltersobject

Filter for specific fields, will be json decoded to an array. e.g. [{"operator":"like","value":"John","field":"name","type":"string"}]

Example request

{
  "page": 1,
  "pageSize": 50,
  "sortOrder": "ASC",
  "sortBy": "id"
}

Response

note_get_collection_success_response

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "id": 666,
      "type": "Type of note",
      "cId": 667,
      "cType": "asset",
      "cPath": "/path/to/element",
      "date": 1634025600,
      "title": "Title of note",
      "description": "This is a description",
      "userId": 1,
      "userName": "shaquille.oatmeal"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.