AbstractListResponse Data Type

Abstract list response

Abstract Type
Properties
name data type description
items array of object Items in the list
hasMoreItems boolean True if more items are available to get (if paging was used)
numItems number Get total number of items available
perms map of array of Permission User permissions on the returned items, if applicable and requested
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "edit", "edit" ],
    "property2" : [ "view", "edit" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}