Sign in
StringDefinitions

Get a paged response of Global String Definitions.

No Documentation Found.

get/api/v2/StringDefinitions/{ID}

Path parameters

IDstring required

Query parameters

includeTranslationsboolean

Optional. Indicates whether to include the StringTranslations for the StringDefinition. Defaults to false.

includeDeletedLanguagesboolean

Optional. Indicates whether to include languages marked as deleted. includeTranslations must be true. Defaults to false.

languageIdsstring

Optional. A comma-delimited list of language ids. Only StringTranslation objects with a matching language id will be returned. Optional. By default all locales are returned. includeTranslations must be true. The StringDefinition is still returned even if the filtered translations list is empty.

Response

OK

Idstring

The identifier for the string. Read Only.

DescriptionForTranslatorstring required

The description of the string to be translated.

ParameterCountinteger

The number of parameters expected for the string.

Timestampstring byte

A value indicating the last modification of this string. Read Only.

DoNotTranslateboolean

True if the string should not be translated. False by default.

Changes