Base APIs

POST base/text-keys

Create a new text key

HTTP method	POST
URI	https://api.rambase.net/base/text-keys
Supported formats	Xml, Html, Json (ex. $format=json)
Successful HTTP status code	201
API resource identifier	6585, 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:

                                        <TextKey>
                                    

<Key

Key

Required/mandatory field

A short description key of what the text contains

>{String}</Key>

<NameSpace

NameSpace

Required/mandatory field

NameSpace

>{String}</NameSpace>

<Text

Text

Required/mandatory field

Text of text key

>{String}</Text>

<Description

Description

Description

This field is optional.

>{String}</Description>

                                        </TextKey>
                                    

{

                                             "textKey": {
                                    

"key

Key

Required/mandatory field

A short description key of what the text contains

": "{String}",

"nameSpace

NameSpace

Required/mandatory field

NameSpace

": "{String}",

"text

Text

Required/mandatory field

Text of text key

": "{String}",

"description

Description

Description

This field is optional.

": "{String}"

}

}

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:

                                        <TextKey>
                                    

<TextKeyId

TextKeyId

Text key identifier

>{Integer}</TextKeyId>

<Status

Status

Text translation status

Possible domain values can be found here

>{Integer}</Status>

<Key

Key

A short description key of what the text contains

>{String}</Key>

<NameSpace

NameSpace

NameSpace

>{String}</NameSpace>

<Text

Text

Text of text key

>{String}</Text>

<Description

Description

Description

<Scope

Scope

Scope of the Duty

>{String}</Scope>

<IsChanged

IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>

<ChangedBy

ChangedBy

EmployeeId of the employee making the change

<UserId

UserId

User identifier

>{Integer}</UserId>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                  </ChangedBy>
                                    

<IsPendingDeployment

IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>

                                             </Description>
                                    

                                        </TextKey>
                                    

{

                                             "textKey": {
                                    

"textKeyId

TextKeyId

Text key identifier

": "{Integer}",

"status

Status

Text translation status

Possible domain values can be found here

": "{Integer}",

"key

Key

A short description key of what the text contains

": "{String}",

"nameSpace

NameSpace

NameSpace

": "{String}",

"text

Text

Text of text key

": "{String}",

"description

Description

Description

": {

"scope

Scope

Scope of the Duty

": "{String}",

"isChanged

IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",

"changedBy

ChangedBy

EmployeeId of the employee making the change

": {

"userId

UserId

User identifier

": "{Integer}",

"userLink

UserLink

User reference

": "{String}"

},

"isPendingDeployment

IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"

}

}

}

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 101079 HTTP 400	Mismatch in size of revision parameters
Error 101551 HTTP 404	Object {0} not found