Resource: Translation

About this resource

Representation of a translation.

Properties

Property	Description	Type
createdOn	Gets the creation datetime in UTC time.	datetime
id	Gets or sets the translation identifier.	guid
localizedValues	A collection of TranslationItem entities.	TranslationItemCollection
modifiedOn	Gets the last modification datetime in UTC time.	datetime
module	Gets or sets the module name for this translation.	string
name	Gets or sets the name of the element that should be translated.	string
studio	Gets or sets the studio name for this translation.	string
tag	Gets or sets the value for the Tag of this object. The value of this property should be valid Xml. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-translation' and the value 'Tag' to your request.	string

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.
GET	modifiedby	select-Translation: modifiedby	User	Gets or sets the user that last modified this resource.
GET	createdby	select-Translation: createdby	User	Gets or sets the user that created this resource.

Actions

Method

Action

Description

Response codes

PUT /translation/{translationId}

edit

Edits an existing translation.

204	Request completed successfully
400	Bad request (in general)
403	Insufficient permissions
404	Translation not found

DELETE /translation/{translationId}

delete

Deletes an existing translation.

204	Request completed successfully
403	Insufficient permissions
404	Translation not found

Examples

Reading a translation

GET /translation/e5a5f7bb73924bfb9fa0a8b100af8e6f HTTP/1.1

If the translation was not found, the API call will fail with a 404 Not found HTTP status code.

{
	"id": "e5a5f7bb73924bfb9fa0a8b100af8e6f",
	"studio": "studio name",
	"module": "module name",
	"name": "element name",
	"tag": null,
	"localizedValues": [
		{
			"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
			"value": "translation value"
		}
	],
	"modifiedOn": "2018-03-28T10:39:10.933Z",
	"createdOn": "2018-03-28T10:39:10.873Z"
}

Reading a translation using a key

GET /translation?studio={studioName}&module={moduleName}&name={elementName} HTTP/1.1

If the translation was not found, the API call will fail with a 404 Not found HTTP status code.

{
	"id": "e5a5f7bb73924bfb9fa0a8b100af8e6f",
	"studio": "studio name",
	"module": "module name",
	"name": "element name",
	"tag": null,
	"localizedValues": [
		{
			"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
			"value": "translation value"
		}
	],
	"modifiedOn": "2018-03-28T10:39:10.933Z",
	"createdOn": "2018-03-28T10:39:10.873Z"
}

Editing a translation

PUT /translation/e5a5f7bb73924bfb9fa0a8b100af8e6f
{
	"studio": "studio name",
	"module": "module name",
	"name": "element name",
	"tag": "<xml>some tag</xml>",
	"localizedValues": [
		{
			"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
			"value": "new translation value"
		}
	]
}

Deleting a translation

DELETE /translation/e5a5f7bb73924bfb9fa0a8b100af8e6f