Abstract list response
name | data type | constraints | description |
---|---|---|---|
items | array of object | Items in the list | |
hasMoreItems | boolean | required boolean | True if more items are available to get (if paging was used) |
numItems | number | required int | 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 StagingResponse |
|||
stagingStatus | map of StagingStatus | Staging status of contained objects | |
Properties inherited from GenericResponse |
|||
messages | array of Message | Messages contained in the response (which should be shown to the user) | |
responseInfo | ResponseInfo |
Example
{ "items" : [ { }, { } ], "hasMoreItems" : true, "numItems" : 12345, "perms" : { "property1" : [ "deleteitems", "deleteform" ], "property2" : [ "readitems", "create" ] }, "stagingStatus" : { "property1" : { "packageName" : "...", "included" : true }, "property2" : { "packageName" : "...", "included" : true } }, "messages" : [ { }, { } ], "responseInfo" : { "responseCode" : "OK", "responseMessage" : "...", "property" : "..." } }