API Documentation
Toggle TOC panel
<access-service>/api/v1/organisations/{orgGroupId}/users/{userId}/itemCount

URL structure

1 https://access-service.xy-company.com/api/v1/organisations/{orgGroupId}/users/{userId}/itemCount

where {orgGroupId} is the ID of an organization and {userId} is the ID of a Covata user account.

Supported methods and overview

  • GET - retrieves the total number of file objects/Secure Objects currently owned by a Covata user (specified by userId) within an organization (specified by orgGroupId).

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves the total number of file objects/Secure Objects currently owned by a Covata user (specified by userId) within an organization (specified by orgGroupId).

A Covata user's ID can be obtained by calling the GET method of the <access-service>/api/v1/organisations/{orgGroupId}/users API endpoint, which retrieves a list of information associated with existing users in an organization (specified by orgGroupId), which can be filtered through a variety of 'search' criteria.

This endpoint is useful for determining the number of file objects that a Covata user owns, before transferring the ownership of these items over to another user.

Note: Although this endpoint indicates items in its URL, calling it only returns the total number of file objects (i.e. folders/collections are not counted). However, when actually transferring the ownership of items from one Covata user to another, all of the user's items (i.e. all their file objects and folders) are transferred.

Supported roles and conditions

This API endpoint supports requests utilizing Covata user accounts with the following roles (as described in the Organization Administrator's Guide) and conditions:

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

  • Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

A JSON-formatted response containing the following members:

  • count - The total number of file objects currently owned by the Covata user specified by userId in this endpoint's URL.
    Example (response):
    {
    "count": 16
    }