TypePermissionResponse Data Type

Response containing permissions and role assignments

Properties
name data type constraints description
perms array of TypePermissionItem   Permissions
roles array of RoleItem   Roles
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "perms" : [ {
    "type" : "readitems",
    "label" : "...",
    "description" : "...",
    "category" : "...",
    "value" : true,
    "editable" : true
  }, {
    "type" : "assignroles",
    "label" : "...",
    "description" : "...",
    "category" : "...",
    "value" : true,
    "editable" : true
  } ],
  "roles" : [ {
    "id" : 12345,
    "label" : "...",
    "description" : "...",
    "value" : true,
    "editable" : true
  }, {
    "id" : 12345,
    "label" : "...",
    "description" : "...",
    "value" : true,
    "editable" : true
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}