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