Vertaalproject maken

Een POST-methode waarmee u een vertaalproject kunt maken door de vereiste projectdetails te accepteren.

Aanvraag-URL

http://<aem-guides-server>:<port-number>/bin/guides/v1/translation/project/create

Type aanvraag

POST

Parameters aanvragen

Naam
Type
Beschrijving
type
String
newTranslationProject, xliffTranslationProject, newMultiLingualTranslationProject, addToExistingProject, newScopingTranslationProject
versionDetails, versionSelector
String
Basislijn, nieuwste versie, versionAsOfDate
language
String
Door komma's gescheiden talen "de", "fr"
map.id
String
GUID van de bronkaart die moet worden vertaald
map.path
String
Pad van de te vertalen bronkaart
referenceType
String
Indirect, Direct
fileType
String
Kaart, Onderwerp, andere
documentState
String
kan een van de lijsten zijn die door het profiel van de gebruiker op de kaart worden toegewezen
translationStatus
String
Niet-gesynchroniseerd, In synchroon, Bijgewerkt, Verouderd, In uitvoering, Kopie ontbreekt, GEEN, N.v.t.
NOTE
U kunt map.id of map.path gebruiken bij het maken van een vertaalproject.

Voorbeeld aanvragen

{
  "title": "Test Project 1 on Dec 5",
  "type": "newTranslationProject",
  "translationDetails": {
    "map": {
      "id": "GUID-06527014-062d-46dc-8fea-48b4b4497c51-en",
      "path": "/content/dam/ajay-test/lang/en/m2.ditamap"
    },
    "languages": ["de"],
    "versionDetails": {
      "versionSelector": "latestVersion"
    }
  },
  "filterDetails": [
    { "name": "referenceType", "values": [] },
    { "name": "fileType", "values": [] },
    { "name": "documentState", "values": [] },
    { "name": "translationStatus", "values": [] }
   ]

Responswaarden

{
  "executionId": "5c13c571-3407-46d5-8f45-50ea9e05a212",
  "path": "/content/projects/test_project_1_ondec5"
}

Codes van de Reactie

  • 200 succesvol
  • 400 Ongeldige invoer
  • 401 Onbevoegde toegang
  • 500 interne serverfout

Voorbeeldverzoeken

Toevoegen aan bestaand project

{
  "title": "Add to existing Project",
  "type": "addToExistingProject",
  "path": "/content/projects/test_project_1_existing",
  "translationDetails": {
    "map": {
      "id": "GUID-06527014-062d-46dc-8fea-48b4b4497c51-en"
    },
    "languages": ["de"],
    "versionDetails": {
      "versionSelector": "versionAsOfDate",
      "version": "2025-12-05T10:30:00+01:30"
    }
  },
  "filterDetails": [
    { "name": "referenceType", "values": [] },
    { "name": "fileType", "values": [] },
    { "name": "documentState", "values": [] },
    { "name": "translationStatus", "values": [] }
  ]
}

Toevoegen aan bestaand project met basislijn

{
  "title": "Add to existin project Project with baseline",
  "type": "addToExistingProject",
  "path": "/content/projects/existing_project_path",
  "translationDetails": {
    "map": {
      "id": "GUID-06527014-062d-46dc-8fea-48b4b4497c51-en"
    },
    "languages": ["de"],
    "versionDetails": {
      "versionSelector": "baseline",
      "version": "test1"
    }
  },
  "filterDetails": [
    { "name": "referenceType", "values": ["Direct"] },
    { "name": "fileType", "values": [] },
    { "name": "documentState", "values": [] },
    { "name": "translationStatus", "values": [] }
  ]
}

Status van creatie van vertaalproject

Een GET API die de vertaalstatus voor een nieuw vertaalproject bijhoudt.

Aanvraag-URL

http://<aem-guides-server>:<port-number>/bin/guides/v1/translation/project/creationstatus

Type aanvraag

GET

Parameters aanvragen

Naam
Type
Beschrijving
path
String
Pad van het project
languageStatusMap
String
Retourneert voor elke aangevraagde taal de voltooiingsstatus: Bezig, Voltooid, Mislukt, Overgeslagen

Voorbeeld aanvragen

{
  "path": "/content/projects/test_project_1_ondec5",
  "languageStatusMap": {
    "de": "Completed"
  }
}
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178