Skip to content

Locale

Hantera och hämta översättningar för olika textsträngar som används över Amili-plattformen. Varje locale-post innehåller översättningar för flera språk och kan associeras med specifika applikationer.

Tillgängliga Endpoints

MethodEndpointBeskrivning
GET/localesHämta en lista över locale-poster
GET/locales/{id}Hämta en specifik locale-post

Exempel Request

Nedan är ett exempel på att hämta en specifik locale-post. Andra operationer följer liknande request/response-mönster med samma datastruktur.

URL: GET /locales/61b21dc50e8820cff2c5d888

Headers:

x-api-key: {your_access_token}

Response Code: 200 OK

Response Body:

json
{
  "_id": "61b21dc50e8820cff2c5d888",
  "application": "ada_agreement",
  "locale_tag": "common__case_cancel",
  "description": "",
  "translations": {
    "en": {
      "translation": "Revoked case",
      "comment": ""
    },
    "sv": {
      "translation": "Återkallat ärende",
      "comment": ""
    }
  },
  "machine_translations": {
    "fi": {
      "translation": "Peruutettu tapaus",
      "comment": "language: finnish"
    },
    "da": {
      "translation": "Ophævet sag",
      "comment": "language: danish"
    }
  },
  "_updated": "Tue, 04 Jan 2022 14:54:05 GMT",
  "_created": "Thu, 09 Dec 2021 15:16:21 GMT",
  "translation_pending": false,
  "_etag": "05bd52bbdd9946cd878520e64647b118"
}

Response Properties

PropertyTypObligatoriskBeskrivning
_idstringJaUnik identifierare för locale-post
applicationstringJaApplikationsidentifierare (t.ex. "ada_agreement")*
locale_tagstringJaUnik tagg som identifierar översättningssträngen
descriptionstringNejValfri beskrivning av översättningens användning
translationsobjectJaManuella översättningar på olika språk
machine_translationsobjectNejAutomatiskt genererade översättningar
translation_pendingbooleanJaOm översättningsuppdateringar väntar
_createdstringJaSkapandetidsstämpel
_updatedstringJaSenaste uppdateringstidsstämpel
_etagstringJaEntity tag för samtidighetskontroll

Translation Properties

PropertyTypObligatoriskBeskrivning
translationstringJaDen översatta texten
commentstringNejValfri kommentar om översättningen

*) För komplett lista över värden och detaljer, se Locale