Main Topics - Cocoon Data Documentation

Here is a list of the main topic pages in this guide:

Developer’s Guide
Authentication and authorisation
Working with files and folders (fundamentals)
Retrieving information about items
Sharing items
API Reference Guide
Authentication and authorisation endpoints
<access-service>/api/oauth/authorise
<access-service>/api/oauth/token
Access Service discovery endpoints
<access-service>/api/v1
Key handling endpoints
<access-service>/api/v1/keys
<access-service>/api/v1/keys/{keyId}
<access-service>/api/v1/objects/{objectId}/keys
<access-service>/api/v1/objects/{objectId}/keys/view
<access-service>/api/v1/versions/{versionId}/key
<access-service>/api/v1/versions/{versionId}/viewKey
File handling endpoints
<access-service>/api/v1/organisations/{orgGroupId}/objects
<access-service>/api/v1/objects
<access-service>/api/v1/objects/{objectId}
<access-service>/api/v1/organisations/{orgGroupId}/objects/{objectId}/enable
<access-service>/api/v1/objects/{itemId}/versions
<access-service>/api/v1/objects/{itemId}/versions/{versionId}
Folder handling endpoints
<access-service>/api/v1/organisations/{orgId}/collections
<access-service>/api/v1/collections/{collectionId}
<access-service>/api/v1/collections/{collectionId}/collections
Item handling endpoints
<access-service>/api/v1/organisations/{orgId}/items
<access-service>/api/v1/items/{itemId}
<access-service>/api/v1/items/{itemId}/ancestry
<access-service>/api/v1/items/{itemId}/history
<access-service>/api/v1/items/delta
<access-service>/api/v1/items/{itemId}/unshare
<access-service>/api/v1/collaborations/items/{itemId}
<access-service>/api/v1/organisations/{orgId}/items/transfer
<access-service>/api/v1/organisations/{orgId}/recycle-bin/items
<access-service>/api/v1/recycle-bin/items/{itemId}
<access-service>/api/v1/permissions/sets
User account handling endpoints
<access-service>/api/v1/users/me
<access-service>/api/v1/users/me/expire
<access-service>/api/v1/users/me/applications/approvals
<access-service>/api/v1/users/me/applications/approvals/{approvalId}
<access-service>/api/v1/users/me/contacts
<access-service>/api/v1/users/me/contacts/{contactId}
<access-service>/api/v1/users/me/notifications/email
<access-service>/api/v1/users/{userId}/history
<access-service>/api/v1/organisations/{orgGroupId}/users
<access-service>/api/v1/organisations/{orgGroupId}/users/{userId}
<access-service>/api/v1/organisations/{orgGroupId}/users/{userId}/itemCount
<access-service>/api/v1/organisations/{orgGroupId}/users/import
<access-service>/api/v1/users
<access-service>/api/v1/users/{userId}
<access-service>/api/v1/users/{userId}/unlock
Organisation configuration and information retrieval endpoints
<access-service>/api/v1/organisations/{orgGroupId}
Classification endpoints
<access-service>/api/v1/organisations/{orgId}/labels
<access-service>/api/v1/organisations/{orgId}/labels/{labelId}
<access-service>/api/v1/organisations/{orgId}/labels/{labelId}/priority
Organisation Administration dashboard endpoints
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items/storage
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items/extensions
<access-service>/api/v1/organisations/{orgGroupId}/statistics/plans
<access-service>/api/v1/organisations/{orgGroupId}/statistics/users
User whitelist endpoints
<access-service>/api/v1/organisations/{orgId}/userwhitelist
<access-service>/api/v1/organisations/{orgId}/userwhitelist/{whitelistId}
<access-service>/api/v1/organisations/{orgId}/userwhitelist/check
<access-service>/api/v1/userwhitelist/{objectId}
<access-service>/api/v1/userwhitelist/bulk
User group endpoints
<access-service>/api/v1/organisations/{orgId}/groups
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}/labels
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}/users
Plan endpoints
<access-service>/api/v1/organisations/{orgGroupId}/plans
<access-service>/api/v1/organisations/{orgGroupId}/plans/{planId}
Auditing/reporting endpoints
<access-service>/api/v1/organisations/{organisationId}/audit
<access-service>/api/v1/organisations/{organisationId}/audit/exportReport
SafeShare Administration dashboard endpoints
<access-service>/api/v1/dashboard/quotas
<access-service>/api/v1/dashboard/clients
<access-service>/api/v1/dashboard/ldap
<access-service>/api/v1/dashboard/users/activity
<access-service>/api/v1/dashboard/organisations
Organisation administering endpoints
<access-service>/api/v1/organisations
<access-service>/api/v1/organisations/{organisationId}
<access-service>/api/v1/organisations/{organisationId}/removalRequest
LDAP connection endpoints
<access-service>/api/v1/ldapconnections
<access-service>/api/v1/ldapconnections/{ldapConnectionId}
<access-service>/api/v1/ldapconnections/availability
Client application endpoints
<access-service>/api/v1/clientapps
<access-service>/api/v1/clientapps/{clientInfoId}
<access-service>/api/v1/clientapps/{clientInfoId}/enable
SafeShare Administration configuration endpoints
<access-service>/api/v1/config/server
<access-service>/api/v1/config/server/{configId}
<access-service>/api/v1/config/theme/adminEmail
<access-service>/api/v1/config/theme/adminHelpUrl
<access-service>/api/v1/config/theme/androidAuthenticatorUrl
<access-service>/api/v1/config/theme/applicationName
<access-service>/api/v1/config/theme/companyName
<access-service>/api/v1/config/theme/copyright
<access-service>/api/v1/config/theme/iphoneAuthenticatorUrl
<access-service>/api/v1/config/theme/legalUrl
<access-service>/api/v1/config/theme/orgAdminHelpUrl
<access-service>/api/v1/config/theme/orgRemovalActionDays
<access-service>/api/v1/config/theme/privacyUrl
<access-service>/api/v1/config/theme/supportLink
<access-service>/api/v1/config/theme/versionUrl
<access-service>/api/v1/config/theme/webappHelpUrl
<access-service>/api/v1/config/theme/windowsAuthenticatorUrl
<access-service>/api/v1/config
<access-service>/theme…
Internationalisation (i18n) endpoints
<access-service>/api/v1/i18n/adminpreference
<access-service>/api/v1/i18n/bundles/{localeCode}
<access-service>/api/v1/i18n/bundles/{localeCode}/delete
<access-service>/api/v1/i18n/bundles/{localeCode}/download
<access-service>/api/v1/i18n/bundles/{localeCode}/reset
<access-service>/api/v1/i18n/localedetails
<access-service>/api/v1/i18n/reload
<access-service>/api/v1/i18n/bundles
Content Service discovery endpoints
<content-service>/api/v1
File content handling endpoints
<content-service>/api/v1/objects/{objectId}/contents
<content-service>/api/v1/objects/{objectId}/view
<content-service>/api/v1/objects/{objectId}/versions
<content-service>/api/v1/versions/{versionId}/contents
<content-service>/api/v1/versions/{versionId}/view
Folder content handling endpoints
<content-service>/api/v1/collections/{collectionId}/contents
Getting Support
Important notice