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

URL structure

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

where {localeCode} is a supported locale code.

Supported methods and overview

  • PUT - resets a locale from a custom internationalization (i18n) bundle (specified by {localCode} and which had been uploaded to the Cocoon Data Platform's Access Service) back to its built in version.

Note: This method takes no parameters.

Detailed description

This API endpoint resets a locale from a custom i18n bundle (specified by {localCode} and which had been uploaded to the Cocoon Data Platform's Access Service) back to its built in version.

Notes:

  • This endpoint can only be called on locales with existing i18n bundles that are built in to the Cocoon Data Platform.
  • Any Cocoon Data users utilizing the locale of this custom i18n bundle (which they would have chosen through SafeShare) will automatically be reverted to use the existing i18n bundle of the same locale, when the bundle is reset.

Supported roles

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

The Cocoon Data Platform's resources available to a Cocoon Data 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

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