Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje01 MAR 20232023 Springcreated


...

Result Example
As of Version2023 Spring

Request Method

GET

Response Format

JSON

Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service

Description


Excerpt

Retrieve the specified metric for the specified tenant.



>> Metrics

Following values are available for the metric path parameter:

  • storage - The endpoint retrieves the dynamically calculated binary storage used by the specified tenant.
  • objectCount (as of 2023 Summer) - The endpoint retrieves the number of DMS objects within the specified tenant.

Request ExampleExamples

(A) /api/system/tenants/yuuvistest/metrics/storage

(B) /api/system/tenants/yuuvistest/metrics/objectCount

Result Examples

(A)

Code Block
{
  "objects": [
    {
      "properties": {
        "system:tenant": {
          "value": "yuuvistest"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "121 MB",
          "value": 127508469
        }
      }
    }
  ],
  "numItems": 1,
  "hasMoreItems": false,
  "totalNumItems": 1
}

(B)

Code Block
{
    "objects": [{
            "properties": {
                "system:tenant": {
                    "value": "yuuvistest"
                }
            },
            "options": {
                "objectCount": {
                    "totalFolderCount": 97,
                    "totalObjectCount": 1733
                }
            }
        }
    ],
    "numItems": 1,
    "hasMoreItems": false,
    "totalNumItems": 1
}