{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Sharing & Collaboration APIs API", "version": "1.0.0" }, "items": [ { "info": { "name": "Sharing & Collaboration APIs", "type": "folder" }, "items": [ { "info": { "name": "Get Org Admins", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/orgadmins" }, "docs": "Returns list of admins for a specified organization." }, { "info": { "name": "Get Workspace Admins", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/admins", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns list of admins for the specified workspace." }, { "info": { "name": "Add Workspace Admins", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/admins", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Adds admins for the specified workspace." }, { "info": { "name": "Remove Workspace Admins", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/admins", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Removes admins from the specified workspace." }, { "info": { "name": "Get Workspace Shared Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/share", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns sharing details of all views in the specified workspace." }, { "info": { "name": "Share Views", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/share", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Shares the specified views in the workspace with users or groups with selected permissions." }, { "info": { "name": "Update Shared Details For View", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/share", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Updates the existing sharing configuration for a view." }, { "info": { "name": "Remove Share", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/share", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Removes view sharing from specified users or groups in the workspace." }, { "info": { "name": "Get My Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace-id/views/:view-id/share/mypermissions", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns permissions for the specified view." }, { "info": { "name": "Get Shared Details For Views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace-id/share/shareddetails", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "CONFIG", "value": "", "type": "query", "description": "View IDs for which shared details need to be fetched." } ] }, "docs": "Returns shared details of the specified views." }, { "info": { "name": "Get Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace-id/groups", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns list of groups for the specified workspace." }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces/:workspace-id/groups", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Create a group in the specified workspace." }, { "info": { "name": "Get Group Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace-id/groups/:group-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "group-id", "value": "", "type": "path", "description": "ID of the group." } ] }, "docs": "Returns details of the specified group." }, { "info": { "name": "Rename Group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workspaces/:workspace-id/groups/:group-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "group-id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Rename a specified group." }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaces/:workspace-id/groups/:group-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "group-id", "value": "", "type": "path", "description": "ID of the group." } ] }, "docs": "Delete a specified group." }, { "info": { "name": "Add Group Members", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces/:workspace-id/groups/:group-id/members", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "group-id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Add users to the specified group." }, { "info": { "name": "Remove Group Members", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaces/:workspace-id/groups/:group-id/members", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "group-id", "value": "", "type": "path", "description": "ID of the group." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Remove users from the specified group." } ] } ], "bundled": true }