API Documentation
Toggle TOC panel
<access-service>/api/v1/i18n/bundles/{localeCode}/delete

URL structure

1 https://access-service.xy-company.com/api/v1/i18n/bundles/{localeCode}/delete

where {localeCode} is a supported locale code.

Supported methods and overview

  • DELETE - deletes a custom internationalisation (i18n) bundle (specified by localeCode) which had been uploaded to the Covata Platform's Access Service.

Note: This method takes no parameters.

Detailed description

This API endpoint is used to delete a custom i18n bundle (specified by {localCode}) which had been uploaded to the Covata Platform's Access Service.

Notes:

  • This endpoint can only be called on locales without existing i18n bundles that are built in to the Covata Platform.
  • Any Covata users utilising the locale of this custom i18n bundle (which they would have chosen through SafeShare) will automatically be reverted to use the SafeShare administrator's default locale, when the bundle is deleted.

Supported roles

This API endpoint supports the following Covata user roles (as described in the SafeShare Administrator's Guide):

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:

  • Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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