Business entity schema query parameters

The following table includes query parameters that are specific to business entity schemas. For each parameter, a short description is provided along with possible values. Also listed for each parameter are any other parameters that must be included in order for the given parameter to be used. See below for detailed descriptions of each.

Parameter

Description

Values

Other parameters required
includeLocalizations

Include localization strings in the schema for all localizable strings for the specified installed languages.
  • {language code}
  • {language-region code}
  • *all (all installed languages)

none
inlineTypelists

Include typelist values in the schema.

Boolean

none

includeLocalizations

The includeLocalizations query parameter includes localized versions of all strings in the schema response. Any element that can be localized will include an x-gw-localizations property containing localized versions of the associated schema property. (If no localized version for a given language exists, the value will be provided in the default language.)

The localized languages that are displayed depend on the value assigned to the parameter. You can retrieve localized strings for all installed languages (languages in the LangaugeType typelist) by assigning the *all value to the parameter.

To retrieve localized strings for only specific languages, include the language code as the value. The language code can be in any of the following formats:

  • Language code, such as fr (French).

  • Language and region, such as fr-CA (French, Canada) or fr-FA (French, France).

  • Language and region with either a hyphen or an underscore. Both fr-CA and fr_CA will return French (Canada) localized strings.

Note that the value is case-sensitive; you’ll receive an error if the installed language is en_US and you specify en_us.

Only installed languages can be specified. If you set a value to a language that is not installed you’ll receive an error.

The following examples show different options for calling includeLocalizations:

Retrieve localized values for all installed languages:

GET /common/v1/entity-schemas?includeLocalizations=*all

Retrieve localized values for US English:

GET /common/v1/entity-schemas?includeLocalizations=en_US

Retrieve localized values for all versions of French:

GET /common/v1/entity-schemas?includeLocalizations=fr

Retrieve localized values for English and French (Canada):

GET /common/v1/entity-schemas?includeLocalizations=en,fr_CA

For details on the schema structure, see Localizations.

inlineTypelists

The inlineTypelists query parameter is used to include typelist metadata for each typekey field or term so that typelist metadata doesn’t need to be fetched separately. Set inlineTypelists to true to enable this feature.

  • GET /common/v1/entity-schemas?inlineTypelists=true

See Choice values for more information and schema examples.