<access-service>/api/v1/organisations/{orgId}/labels/{labelId}

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgId}/labels/{labelId}

where {orgId} is the ID of an organization and {labelId} is the ID of one of this organization's classifications.

Supported methods and overview

• GET - used to retrieve information about an organization's classification, based on the classification's ID.
• DELETE - used to delete an organization's classification.

Note: Both of these methods take no parameters.

Detailed description

This API endpoint serves a number of purposes:

• Retrieves information about an organization's classification, using the classification's ID. A classification's ID can be obtained by calling the GET method of the <access-service>/api/v1/organisations/{orgId}/labels API endpoint, which retrieves a list of information for all classifications in an organization.
  Tip: All information (except the description member) returned in the response from a GET method call to this API endpoint is also returned in the response from a GET method call to the <access-service>/api/v1/organisations/{orgId}/labels endpoint. Therefore, if you do not require a classification's description when retrieving information about the classification, there is no need to call the GET method on this API endpoint.
• Deletes a classification from an organization.
  Important: Deleting a classification also removes:
  • this classification from all new and existing file objects it had been applied to and more importantly,
  • removes all current collaborators from these file objects.

Be aware that by design and for security reasons, it is not possible to edit any aspect of a classification.

Supported roles

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

• Organization administrator, Originator, Collaborator, Ad hoc - using the GET method, if this user is a member of the organization specified by the {orgId} of the request's URL.
• Organization administrator - using the DELETE method, if this user is a member of the organization specified by the {orgId} of the request's URL.
• Safe Share administrator - using the GET method.

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns from a GET request

A JSON-formatted response containing the following members:

• id - .
• name - .
• description - .

• priority - .

  Example (response from ...):

Returns from a DELETE request

If the request succeeded, then an HTTP response status 200 OK is returned.