<access-service>/api/v1/organisations/{orgGroupId}/statistics/items/storage

​

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgGroupId}/statistics/items/storage

​

Supported methods and overview

• GET - retrieves a summary of information about storage requirements and usage for an organisation (specified by orgGroupId).

​

Detailed description

• Storage space (in mebibytes/MiB) currently allocated to this organisation.
• Storage space required for Cocoon Data users (also in MiB), which is based on the sum of all quotas associated with all users in this organisation who have the Originator role.

​

Supported roles and conditions

• Organisation administrator - when this user is a member of the organisation whose ID is specified by {orgGroupId} in the request’s URL.

​

Required headers

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

​

Returns

• organisationQuota - The amount of storage space (in MiB) currently allocated to the organisation (specified by {orgGroupId} in the request’s URL).
• objectStorageRequired - The amount of storage space required for Cocoon Data users (also in MiB), which is based on the sum of all quotas associated with all users in the organisation (specified by orgGroupId) who have the Originator role.
• objectStorageUsed - The amount of storage space (in bytes) currently consumed by Cocoon Data users (i.e. with the Originator role) in the organisation (specified by orgGroupId).
  Example (response):
  {
      "organisationQuota": "4194304",
      "objectStorageRequired": "10240",
      "objectStorageUsed": "67026768"
  }