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

​

URL structure

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

​

Supported methods and overview

• GET - retrieves a summary of information about the file name extensions of all files within an organization (specified by orgGroupId).

​

Detailed description

​

Supported roles and conditions

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

​

Required headers

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

​

Returns

• organisationId - The ID of the organization (which should match {orgGroupId} specified in the request’s URL).
• objectsCount - The total number of file objects in the organization (specified by orgGroupId).
• breakdownByExtension - An array containing information about the file name extensions of all files in the organization (specified by orgGroupId). Each element of this array contains information about one of these file name extensions and is represented as an object, containing the following members:
  • extensionType - The extension itself.
  • objectsCount - The number of file objects possessing this file name extension.
  • percentageOfAllObjects - The percentage of this objectsCount value (immediately above) as a proportion of the parent objectsCount value (i.e. for the total number of file objects in the organization).
  Example (response):
  {
      "organisationId": "749418071827214336",
      "objectsCount": "4",
      "extensionsBreakdown": [{
          "extensionType": {
              "value": "jpg"
          },
          "objectsCount": "3",
          "percentageOfAllObjects": 75.0
      }, {
          "extensionType": {
              "value": "pdf"
          },
          "objectsCount": "1",
          "percentageOfAllObjects": 25.0
      }, {
          "extensionType": {
              "i18n": {
                  "code": "server.dashboardservice.extensions.noextension",
                  "arguments": []
              }
          },
          "objectsCount": "0",
          "percentageOfAllObjects": 0.0
      }]
  }