API

Base APIs

POST base/formula-definitions/{formulaDefinitionId}/translations

Create a new translation for the given resource

HTTP method POST
URI https://api.rambase.net/base/formula-definitions/{formulaDefinitionId}/translations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {formulaDefinitionId} Formula identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2527, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Translation>
2
     <Language
Language

Required/mandatory field

Language of the translation

Applicable domain values can be found here

>{String}</Language>
3
     <Title
Title

Required/mandatory field

Translation of the title

>{String}</Title>
4
     <Description
Description

Translation of the description

This field is optional.

>{String}</Description>
5
     <Parameters
Parameters

This field is optional.

>
6
          <Parameter
Parameter

This field is optional.

>
7
               <ParameterId
ParameterId

Parameter identifier

This field is optional.

>{Integer}</ParameterId>
8
               <Title
Title

Translation of the title

This field is optional.

>{String}</Title>
9
               <Description
Description

Translation of the description

This field is optional.

>{String}</Description>
10
          </Parameter>
11
     </Parameters>
12
</Translation>
1
{
2
     "translation": {
3
          "language
Language

Required/mandatory field

Language of the translation

Applicable domain values can be found here

": "{String}",
4
          "title
Title

Required/mandatory field

Translation of the title

": "{String}",
5
          "description
Description

Translation of the description

This field is optional.

": "{String}",
6
          "parameters
Parameters

This field is optional.

": [
7
               {
8
                    "parameterId
ParameterId

Parameter identifier

This field is optional.

": "{Integer}",
9
                    "title
Title

Translation of the title

This field is optional.

": "{String}",
10
                    "description
Description

Translation of the description

This field is optional.

": "{String}"
11
               }
12
          ]
13
     }
14
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Translation>
2
     <TranslationId
TranslationId

Translation identifier

>{Integer}</TranslationId>
3
     <Language
Language

Language of the translation

Possible domain values can be found here

>{String}</Language>
4
     <Title
Title

Translation of the title

>{String}</Title>
5
     <Description
Description

Translation of the description

>{String}</Description>
6
     <Parameters>
7
          <Parameter>
8
               <ParameterId
ParameterId

Parameter identifier

>{Integer}</ParameterId>
9
               <Key
Key

Key that is used in formula and replaced with the value of the parameter

>{String}</Key>
10
               <Title
Title

Translation of the title

>{String}</Title>
11
               <Description
Description

Translation of the description

>{String}</Description>
12
          </Parameter>
13
     </Parameters>
14
</Translation>
1
{
2
     "translation": {
3
          "translationId
TranslationId

Translation identifier

": "{Integer}",
4
          "language
Language

Language of the translation

Possible domain values can be found here

": "{String}",
5
          "title
Title

Translation of the title

": "{String}",
6
          "description
Description

Translation of the description

": "{String}",
7
          "parameters": [
8
               {
9
                    "parameterId
ParameterId

Parameter identifier

": "{Integer}",
10
                    "key
Key

Key that is used in formula and replaced with the value of the parameter

": "{String}",
11
                    "title
Title

Translation of the title

": "{String}",
12
                    "description
Description

Translation of the description

": "{String}"
13
               }
14
          ]
15
     }
16
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102752 HTTP 404 Translation not found
Error 102704 HTTP 404 Formula parameter was not found
Error 102754 HTTP 400 A translation already exists for the chosen language
Error 102753 HTTP 400 Translated title is required