Function getResourceBundle

Get a resource bundle in a specific project.
Resource bundles are also documents which are collections of key message pairs. The locale specific messages can be defined in a single structure. The projects are supported on resource bundles.
Resource bundles are mostly defined with the locale based value sets. The value sets are not restricted to use with locales only though. Any other grouping can also be defined with a resource bundle document. The design also supports custom value sets apart from locales.
A Resource bundle in core may be have changes that aren't yet published, these are stored in a separate variant of the bundle (the 'unpublished' variant). When requesting a bundle for core, the 'published' variant is retrieved, unless there is none (the bundle has never been published yet), in which case the unpublished variant is fetched.

Example

getResourceBundle(environment, xAuthToken, 'vA1b2', '/content/documents/administration/categories')
  .then(response => console.log(response.data))
  .catch(error => console.error(error));
  • getResourceBundle(environment, xAuthToken, path, projectId): AxiosPromise

  • Parameters

    • environment: string

      Environment name: https://{{environment}}.bloomreach.io

    • xAuthToken: string

      BrX API Token

    • path: string

      Path of a resource bundle. This is the absolute path to the resource bundle, including the resource bundle name

    • projectId: string

      Specifies the project content is fetched from

    Returns AxiosPromise

Settings

Member Visibility