Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AclManagementResourceImpl
  • /management/acls
  • /management/acls/{aclId}
  • /management/deleted/acls
  • /management/acls/named/{aclName}
  • /management/acls/{aclId}/acls
  • /management/deleted/acls/{aclId}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • PUT
This is the http implementation of AclManagementService.
ArchiveResourceImpl
  • /archives
  • /archive/{archiveId}
  • /archives/{archive-name}
  • /archive/documents/{archiveId}
  • /archive/folders/{archiveId}
  • /archive/lookup-entries/{archiveId}
  • /archive/{archiveId}/fields
  • /archive/documents/{archiveId}/fields
  • /archive/folders/{archiveId}/fields
  • /archive/lookup-entries/{archiveId}/fields
  • /archive/{archiveId}/fields/{fieldId}
  • /archive/documents/{archiveId}/fields/{fieldId}
  • /archive/folders/{archiveId}/fields/{fieldId}
  • /archive/lookup-entries/{archiveId}/fields/{fieldId}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This is the http implementation of ArchiveService.
ChangePasswordResourceImpl
  • /management/current-user/password
  • PUT
This is the server side implementation of ChangePasswordResource.
DocumentResourceImpl
  • /documents
  • /documents/{documentId}
  • /documents/revisions/{revisionId}
  • /documents/{documentId}/acls
  • /documents/{documentId}/lock
  • /archive/documents/{archiveId}/content
  • /documents/revisions/{revisionId}/index
  • /documents/revisions/{revisionId}/element/{elementId}
  • /documents/revisions/{revisionId}/index/{fieldName}
  • /documents/revisions/{revisionId}/element/{elementId}/children
  • POST
  • GET
  • DELETE GET PUT
  • GET
  • DELETE POST
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • POST
This is the http implementation of DocumentService.
FolderResourceImpl
  • /folders
  • /folders/{folderId}
  • /folders/{folderId}/acls
  • /folders/{folderId}/documents
  • /folders/{folderId}/folders
  • /folders/{folderId}/index
  • /folders/{folderId}/parent
  • /folders/{folderId}/properties
  • /archive/folders/{archiveId}/content
  • /folders/{folderId}/documents/{documentId}
  • /folders/{folderId}/index/{fieldName}
  • POST
  • DELETE GET PUT
  • GET
  • GET PUT
  • GET
  • GET PUT
  • PUT
  • PUT
  • GET
  • DELETE PUT
  • GET
This is the http implementation of FolderService.
GroupManagementResourceImpl
  • /management/groups
  • /management/deleted/groups
  • /management/groups/{groupId}
  • /management/deleted/groups/{groupId}
  • /management/groups/named/{groupName}
  • /management/groups/{groupId}/acls
  • /management/groups/{groupId}/extension
  • /management/groups/{groupId}/nestedgroups
  • /management/groups/{groupId}/nestedusers
  • /management/groups/{groupId}/nestedgroups/{memberId}
  • /management/groups/{groupId}/nestedusers/{memberId}
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
  • DELETE GET PUT
  • GET POST
  • GET POST
  • DELETE
  • DELETE
This is the http implementation of GroupManagementService.
LookupEntryResourceImpl
  • /lookup-entry
  • /lookup-entry/{id}
  • /lookup-entry/{id}/acls
  • /archive/lookup-entries/{archiveId}/content
  • /lookup-entry/{id}/index/{fieldName}
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
This is the http implementation of LookupEntryService.
RecordResourceImpl
  • /records
  • POST
This is the http implementation of RecordService.
RoleManagementResourceImpl
  • /management/roles
  • /management/deleted/roles
  • /management/roles/{roleId}
  • /management/deleted/roles/{roleId}
  • /management/roles/named/{roleName}
  • /management/roles/{roleId}/acls
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
This is the http implementation of RoleManagementService.
TenantManagementResourceImpl
  • /management/tenants
  • /management/deleted/tenants
  • /management/tenants/{tenantId}
  • /management/deleted/tenants/{tenantId}
  • /management/tenants/named/{tenantName}
  • /management/tenants/{tenantId}/extension
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • DELETE GET PUT
This is the http implementation of TenantManagementService.
UserManagementResourceImpl
  • /management/users
  • /management/deleted/users
  • /management/users/current
  • /management/users/current-context
  • /management/users/{userId}
  • /management/deleted/users/{userId}
  • /management/users/named/{userName}
  • /management/users/{userId}/acls
  • /management/users/{userId}/extension
  • /management/users/{userId}/groups
  • /management/users/{userId}/password
  • /management/users/{userId}/password/expiration
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • PUT
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • PUT
  • GET PUT
This is the http implementation of UserManagementService.
WorkflowDefinitionResourceImpl
  • /workflow/definitions
  • /workflow/definitions/{definitionId}
  • /workflow/definitions/{definitionId}/transition
  • GET
  • GET POST
  • GET
This is the http implementation of WorkflowDefinitionService.
WorkflowInboxResourceImpl
  • /workflow/inboxes
  • /workflow/inboxes/groups
  • /workflow/inboxes/organization
  • /workflow/inboxes/personal
  • /workflow/inboxes/substitutes
  • /workflow/inboxes/{inboxId}
  • /workflow/inboxes/personal/items
  • /workflow/inboxes/{inboxId}/items
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This is the http implementation of WorkflowInboxService.
WorkflowProcessResourceImpl
  • /workflow/processes
  • /workflow/processes/{processId}
  • GET
  • DELETE GET
This is the http implementation of WorkflowProcessService.
WorkflowTaskResourceImpl
  • /workflow/tasks/{taskId}
  • /workflow/tasks/{taskId}/comments
  • /workflow/tasks/{taskId}/forward
  • /workflow/tasks/{taskId}/index
  • /workflow/tasks/{taskId}/transitions
  • /workflow/tasks/{taskId}/ownership/acquire
  • /workflow/tasks/{taskId}/ownership/revoke
  • GET
  • GET POST
  • POST
  • GET POST
  • GET
  • PUT
  • PUT
This is the http implementation of WorkflowTaskService.