Ls == List the children of a specific document class. May also list files with that class. Request ------- :: POST https://test-uni.cloudplan.biz/api/docclass/ls { "class_id": ... //(string) id of the parent class, leave empty to get root level classes "admin": false //(optional, bool) list all where the user has rights through their admin priviliges "include_child_classes": true //(optional, bool) add list of child classes to the reply, or not "include_files": false //(optional, bool) include files with the parent class assigned to them "include_workflows": false //(optional, bool) include workflows with the parent class assigned to them "admin": false //(optional, bool) use org rights instead of user rights for permission checking "for_user_id": "" //(optional, string) return docclasses where this user has permission instead of calling user calling user needs to be an admin "include_deleted": false//(optional, bool) also return deleted docclasses, can be used to restore any deleted class with docclass/restore "tags_filter": [] //(optional) list of filters for certain tags e.g. {"tag_id": "56XYZ..."} {"tag_id": "56ZYXVW.", "val_int":{"gt": 10, "lt":42}} } Example 0 --------- :: REQUEST { "class_id": "60DC25612A3E59074C0D37187C16678B", "include_files": false } REPLY { "result": true, "class_docs": [ { "cp_id": "60DC25670E03B53F62A4C4125DDB7281", "parent_id": "60DC25612A3E59074C0D37187C16678B", "name": "Sub1.1", "org_id": "56A23D908AD3312676D3D9DF9099A5C9", "path_ids": [ "60DC25612A3E59074C0D37187C16678B" ], "rights_user_605A0A9DB614D9194268170DCE5696A9": { "read_acl": true, "write_acl": true, "delete_acl": true, "sync_acl": true, "transfer_acl": true }, "rights_user_ids": [ "605A0A9DB614D9194268170DCE5696A9", "00000000576806997E8F9E59363FA8E7", "56A23EB6998F303B134C1C0A723447B0" ], "rights_user_00000000576806997E8F9E59363FA8E7": { "read_acl": true, "delete_acl": false, "sync_acl": false, "transfer_acl": false, "view_acl": false, "weblink_acl": false, "write_acl": false }, "rights_user_56A23EB6998F303B134C1C0A723447B0": { "read_acl": true, "write_acl": true, "delete_acl": false, "sync_acl": false, "transfer_acl": false, "view_acl": false, "weblink_acl": false }, "rights_group_60D2F8D8C489C5FA2A87B489CE77A698": { "transfer_acl": true }, "rights_group_ids": [ "60D2F8D8C489C5FA2A87B489CE77A698" ] } ], "parent_class_doc": { "cp_id": "60DC25612A3E59074C0D37187C16678B", "parent_id": "", "name": "Class1a", "org_id": "56A23D908AD3312676D3D9DF9099A5C9", "path_ids": [], "rights_user_605A0A9DB614D9194268170DCE5696A9": { "read_acl": true, "write_acl": true, "delete_acl": true, "sync_acl": true, "transfer_acl": true }, "rights_user_ids": [ "605A0A9DB614D9194268170DCE5696A9", "00000000576806997E8F9E59363FA8E7" ], "rights_user_00000000576806997E8F9E59363FA8E7": { "read_acl": true, "write_acl": true, "delete_acl": false, "sync_acl": false, "transfer_acl": false, "view_acl": false, "weblink_acl": false } } } Error Codes ----------- :: user_not_admin error codes from :doc:`api/user/login`