11 KiB
description, readTime, pageClass
| description | readTime | pageClass |
|---|---|---|
| REST documentation on the Translations collection in Directus. | 3 min read | page-reference |
Custom Translations
The Translations Object
id uuid
Primary key of the translations
key string
The translation key.
language string
The language of the translation.
value string
The translation value.
{
"data": {
"id": "c4346aa4-81a8-4885-b3a8-f647e4f6f769",
"key": "Test",
"language": "en-US",
"value": "Test"
}
}
List Translations
List all translations that exist in Directus.
Request
GET /translations
SEARCH /translations
If using SEARCH you can provide a query object as the body of your request.
import { createDirectus, rest, readTranslations } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(readTranslations(query_object));
Query Parameters
Supports all global query parameters.
Response
An array of up to limit translation objects. If no items are available, data will be an empty array.
Example
GET /translations
SEARCH /translations
import { createDirectus, rest, readTranslations } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
readTranslations({
fields: ['*'],
})
);
Retrieve a Translation
List an existing translation by primary key.
Request
GET /translations/:id
import { createDirectus, rest, readTranslation } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(readTranslation(translation_id, query_object));
Query Parameters
Supports all global query parameters.
Response
Returns the requested translation object.
Example
GET /translations/2fc325fb-299b-4d20-a9e7-a34349dee8b2
import { createDirectus, rest, readTranslation } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
readTranslation('7b8c250a-6864-480f-b230-a4035d155123', {
fields: ['*'],
})
);
Create a Translation
Create a new translation.
Request
POST /translations
Provide a translation object as the body of your request.
import { createDirectus, rest, createTranslation } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(createTranslation(translation_object));
Query Parameters
Supports all global query parameters.
Request Body
A partial translation object.
Response
Returns the translation object for the created translation.
Example
POST /translations
{
"key": "Test",
"language": "en-US",
"value": "My Test"
}
import { createDirectus, rest, createTranslation } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
createTranslation({
language: 'fr_FR',
key: 'test',
value: 'test',
})
);
Create Multiple Translations
Create multiple new translation.
Request
POST /translations
Provide an array of translation objects as the body of your request.
import { createDirectus, rest, createTranslations } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(createTranslations(translation_object_array));
Query Parameters
Supports all global query parameters.
Request Body
An array of partial translation object.
Response
Returns the translation object for the created translation.
Example
POST /translations
[
{
"key": "translation.key",
"language": "en-US",
"value": "My Translation"
},
{
"key": "translation.key",
"language": "en-GB",
"value": "Another Translation"
}
]
import { createDirectus, rest, createTranslations } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
createTranslations([
{
language: 'fr-FR',
key: 'test',
value: 'test',
},
{
language: 'it-IT',
key: 'test_2',
value: 'test_2',
},
])
);
Update a Translation
Update an existing translation.
Request
PATCH /translations/:id
Provide a partial translation object as the body of your request.
import { createDirectus, rest, updateTranslation } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(updateTranslation(translation_id, partial_translation_object));
Query Parameters
Supports all global query parameters.
Request Body
A partial translation object.
Response
Returns the translation object for the updated translation.
Example
PATCH /translations/2fc325fb-299b-4d20-a9e7-a34349dee8b2
{
"value": "My Updated Translations"
}
import { createDirectus, rest, updateTranslation } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
updateTranslation('74f2aa3e-ad5c-424a-9ace-adab5ecb0fca', {
value: 'this is the new value',
})
);
Update Multiple Translations
Update multiple existing translations.
Request
PATCH /translations
{
"keys": translation_id_array,
"data": partial_translation_object
}
import { createDirectus, rest, updateTranslations } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(updateTranslations(translation_id_array, partial_translation_object));
Query Parameters
Supports all global query parameters.
Request Body
keys Required
Array of primary keys of the translations you'd like to update.
data Required
Any of translation object's properties.
Response
Returns the translation objects for the updated translations.
Example
PATCH /translations
{
"keys": ["3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc", "7259bfa8-3786-45c6-8c08-cc688e7ba229"],
"data": {
"value": "Test Value"
}
}
import { createDirectus, rest, updateTranslations } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
updateTranslations(['91be30ed-4f4e-481f-84be-860e0c25b035', '74f2aa3e-ad5c-424a-9ace-adab5ecb0fcajj'], {
value: 'this is the new value',
})
);
Delete a Translation
Delete an existing translation.
Request
DELETE /translations/:id
import { createDirectus, rest, deleteTranslation } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(deleteTranslation(translation_id));
Response
Empty body.
Example
DELETE /translations/12204ee2-2c82-4d9a-b044-2f4842a11dba
import { createDirectus, rest, deleteTranslation } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(deleteTranslation('91be30ed-4f4e-481f-84be-860e0c25b035'));
Delete Multiple Translations
Delete multiple existing translations.
Request
DELETE /translations
Provide an array of translation IDs as the body of your request.
import { createDirectus, rest, deleteTranslations } from '@directus/sdk';
const client = createDirectus('directus_project_url').with(rest());
const result = await client.request(deleteTranslations(translation_id_array));
Request Body
An array of translations primary keys
Response
Empty body.
Example
DELETE /translations
["25821236-8c2a-4f89-8fdc-c7d01f35877d", "02b9486e-4273-4fd5-b94b-e18fd923d1ed", "7d62f1e9-a83f-407b-84f8-1c184f014501"]
import { createDirectus, rest, deleteTranslations } from '@directus/sdk';
const client = createDirectus('https://directus.example.com').with(rest());
const result = await client.request(
deleteTranslations([
'25821236-8c2a-4f89-8fdc-c7d01f35877d',
'02b9486e-4273-4fd5-b94b-e18fd923d1ed',
'7d62f1e9-a83f-407b-84f8-1c184f014501',
])
);