OpenAPI definition

Localization

Endpoint:/

(BETA) Languages with translations in the organization.

GET

/api/v1/actions/organization/localization/statistics

(BETA) Lists the languages that have at least one translation, separately for each kind of translation.

(BETA) Languages with translations in the organization. › Responses

dataobject · required
Translations of labels in the logical data model. locales lists the languages with at least one label translation, sorted. Language tags do not include extensions.
metadataobject · required
Translations of titles, descriptions, tags and free-form texts of workspace objects. locales lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.

(BETA) Languages used in the organization.

GET

/api/v1/actions/organization/localization/usage

(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. defaults holds the value a workspace gets when it and its parents set nothing.

(BETA) Languages used in the organization. › Responses

defaultsobject · required
valuesobject[] · required

(BETA) Users who set a language themselves.

GET

/api/v1/actions/organization/localization/usage/users

(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty value= means no filter. No value selects the usage entry without a language.

(BETA) Users who set a language themselves. › query Parameters

valuestring
Language tag that the user sets.
namestring
Filter by user name, email or login (user ID). Note that the filter is case insensitive.
settingstring · enum
One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
Enum values:
LOCALE
METADATA_LOCALE
DATA_LOCALE
sourcestring · enum
Where the value comes from.
Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.
Enum values:
USER
WORKSPACE
PARENT
ORGANIZATION
ENVIRONMENT
DEFAULT
pageinteger · int32
Zero-based page index (0..N)
Default: 0
sizeinteger · int32
The size of the page to be returned.
Default: 20

(BETA) Users who set a language themselves. › Responses

totalCountinteger · int32 · required
The total number of users that match the filters.
usersobject[] · required

(BETA) Workspaces that use a language.

GET

/api/v1/actions/organization/localization/usage/workspaces

(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty value= means no filter. No value selects the usage entry without a language.

(BETA) Workspaces that use a language. › query Parameters

valuestring
Language tag that the workspace gets.
namestring
Filter by workspace name. Note that the filter is case insensitive.
settingstring · enum
One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
Enum values:
LOCALE
METADATA_LOCALE
DATA_LOCALE
sourcestring · enum
Where the value comes from.
Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.
Enum values:
USER
WORKSPACE
PARENT
ORGANIZATION
ENVIRONMENT
DEFAULT
pageinteger · int32
Zero-based page index (0..N)
Default: 0
sizeinteger · int32
The size of the page to be returned.
Default: 20

(BETA) Workspaces that use a language. › Responses

totalCountinteger · int32 · required
The total number of workspaces that match the filters.
workspacesobject[] · required

(BETA) Languages with translations in the workspace.

GET

/api/v1/actions/workspaces/{workspaceId}/localization/statistics

(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.

(BETA) Languages with translations in the workspace. › path Parameters

workspaceIdstring · required

(BETA) Languages with translations in the workspace. › Responses

dataobject · required
Translations of labels in the logical data model. locales lists the languages with at least one label translation, sorted. Language tags do not include extensions.
metadataobject · required
Translations of titles, descriptions, tags and free-form texts of workspace objects. locales lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.

(BETA) Languages used in the workspace.

GET

/api/v1/actions/workspaces/{workspaceId}/localization/usage

(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.

(BETA) Languages used in the workspace. › path Parameters

workspaceIdstring · required

(BETA) Languages used in the workspace. › Responses

settingsobject · required
The value for each of the display, metadata and data language settings, with its source.
valuesobject[] · required

(BETA) Workspace members who get a language.

GET

/api/v1/actions/workspaces/{workspaceId}/localization/usage/users

(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty value= means no filter. No value selects the usage entry without a language.

(BETA) Workspace members who get a language. › path Parameters

workspaceIdstring · required

(BETA) Workspace members who get a language. › query Parameters

valuestring
Language tag that the user gets.
namestring
Filter by user name, email or login (user ID). Note that the filter is case insensitive.
settingstring · enum
One of LOCALE, METADATA_LOCALE and DATA_LOCALE.
Enum values:
LOCALE
METADATA_LOCALE
DATA_LOCALE
sourcestring · enum
Where the value comes from.
Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.
Enum values:
USER
WORKSPACE
PARENT
ORGANIZATION
ENVIRONMENT
DEFAULT
pageinteger · int32
Zero-based page index (0..N)
Default: 0
sizeinteger · int32
The size of the page to be returned.
Default: 20

(BETA) Workspace members who get a language. › Responses

totalCountinteger · int32 · required
The total number of users that match the filters.
usersobject[] · required

Metadata Synchronization API tokens