ObjectPropertyResource Resource

Resource for management of object property definitions

GET /objectproperty

List object properties

Request Parameters
name type description default constraints multivalued
embed query Comma separated list of attributes that contain references to other objects, which shall be embedded into the returned objects.     no
page query Returned page, if paging is used. Paging starts with 1 1 int no
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int no
q query Query string for filtering     no
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name   no
type query Filter by object type(s)   "file" or "folder" or "image" or "page" or "template" yes
Response Codes
code condition
200 List of object properties is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ObjectPropertyListResponse (JSON) response containing a list of object properties

Example

Request
GET /objectproperty
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "edit", "publish" ],
    "property2" : [ "publish", "view" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}