curl --request GET \
--url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings \
--header 'Authorization: <api-key>'import requests
url = "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"android": {
"icuSubFilter": true,
"tagRegexp": "<string>"
},
"asciidoc": {
"extractBtnMenuLabels": true,
"extractCustomDocumentAttributeNameRegexp": "<string>",
"htmlInPassthrough": true,
"nontranslatableMonospaceCustomStylesRegexp": "<string>",
"tagRegexp": "<string>"
},
"autodetectMultilingualFiles": true,
"csv": {
"contextKeyColumn": "<string>",
"contextNoteColumns": "<string>",
"delimiter": "<string>",
"delimiterType": "TAB",
"htmlSubFilter": true,
"importColumns": "<string>",
"importRows": "<string>",
"maxLenColumn": "<string>",
"tagRegexp": "<string>"
},
"dita": {
"excludeTags": "<string>",
"extractSeparateSegmentsXpath": "<string>",
"includeTags": "<string>",
"inlineTags": "<string>",
"inlineTagsNonTranslatable": "<string>",
"tagRegexp": "<string>"
},
"doc": {
"altText": true,
"applyTrackChanges": true,
"comments": true,
"headerFooter": true,
"hidden": true,
"hyperlinkTarget": true,
"index": true,
"joinSimilarRuns": true,
"ocrImageText": true,
"other": true,
"properties": true,
"tagRegexp": "<string>",
"targetFont": "<string>"
},
"docBook": {
"excludeTags": "<string>",
"includeTags": "<string>",
"inlineTags": "<string>",
"inlineTagsNonTranslatable": "<string>",
"tagRegexp": "<string>"
},
"fileFormat": "<string>",
"html": {
"breakTagCreatesSegment": true,
"charEntitiesToTags": "<string>",
"escapeDisabled": true,
"excludeElements": "<string>",
"importComments": true,
"importDefaultAttributes": true,
"importDefaultMetaTags": true,
"nonTranslatableInlineElements": "<string>",
"preserveWhitespace": true,
"segmentationBeginTagPlaceholder": "<string>",
"segmentationEndTagPlaceholder": "<string>",
"segmentationSingleTagPlaceholder": "<string>",
"tagRegexp": "<string>",
"translatableAttributes": "<string>",
"translatableInlineElements": "<string>",
"translateMetaTagRegexp": "<string>",
"unknownTagCreatesTag": true,
"updateLang": true
},
"idml": {
"extractCrossReferenceFormats": true,
"extractHiddenConditionalText": true,
"extractHyperlinks": true,
"extractInvisibleLayers": true,
"extractInvisibleObjects": true,
"extractLockedLayers": true,
"extractLockedObjects": true,
"extractMasterSpreads": true,
"extractNotes": true,
"extractVariables": true,
"keepKerning": true,
"keepTracking": true,
"removeXmlElements": true,
"replaceFont": true,
"simplifyCodes": true,
"tagRegexp": "<string>",
"targetFont": "<string>"
},
"inputCharset": "<string>",
"json": {
"contextKeyPath": "<string>",
"contextNotePath": "<string>",
"excludeKeyRegexp": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"includeKeyRegexp": "<string>",
"maxLenPath": "<string>",
"tagRegexp": "<string>"
},
"mac": {
"htmlSubfilter": true,
"icuSubFilter": true,
"tagRegexp": "<string>"
},
"md": {
"customElements": "<string>",
"excludeCodeElements": true,
"extractCodeBlocks": true,
"flavor": "PLAIN",
"hardLineBreaksSegments": true,
"ignoredBlockPrefixes": "<string>",
"notEscapedCharacters": "<string>",
"preserveWhiteSpaces": true,
"processJekyllFrontMatter": true,
"tagRegexp": "<string>"
},
"mif": {
"extractBodyPages": true,
"extractCustomReferencePages": true,
"extractDefaultReferencePages": true,
"extractHiddenCondText": true,
"extractHiddenPages": true,
"extractIndexMarkers": true,
"extractLinks": true,
"extractMasterPages": true,
"extractPgfNumFormat": true,
"extractReferencePages": true,
"extractUsedPgfNumFormat": true,
"extractUsedVariables": true,
"extractUsedXRefDef": true,
"extractVariables": true,
"extractXRefDef": true,
"tagRegexp": "<string>"
},
"multilingualCsv": {
"allTargetColumns": {},
"contextKeyColumns": "<string>",
"contextNoteColumns": "<string>",
"delimiter": "<string>",
"delimiterType": "TAB",
"htmlSubFilter": true,
"importRows": "<string>",
"maxLenColumns": "<string>",
"nonEmptySegmentAction": "NONE",
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceColumns": "<string>",
"tagRegexp": "<string>",
"targetColumns": "<string>"
},
"multilingualXls": {
"contextKeyColumn": "<string>",
"contextNoteColumn": "<string>",
"htmlSubFilter": true,
"importRows": "<string>",
"maxLenColumn": "<string>",
"nonEmptySegmentAction": "NONE",
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceColumn": "<string>",
"tagRegexp": "<string>",
"targetColumns": {}
},
"multilingualXml": {
"contextKeyXPath": "<string>",
"contextNoteXPath": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"inlineElementsNonTranslatableXPath": "<string>",
"maxLenXPath": "<string>",
"nonEmptySegmentAction": "NONE",
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceElementsXPath": "<string>",
"tagRegexp": "<string>",
"targetElementsXPaths": {},
"translatableElementsXPath": "<string>",
"xslFile": "<string>",
"xslUrl": "<string>"
},
"outputCharset": "<string>",
"pdf": {
"filter": "TRANS_PDF",
"ocrMode": "<string>",
"wysiwyg": true
},
"php": {
"htmlSubFilter": true,
"tagRegexp": "<string>"
},
"po": {
"contextKeySuffixType": "MSGCTXT",
"exportConfirmedLocked": "FUZZY",
"exportConfirmedNotLocked": "FUZZY",
"exportMultiline": true,
"exportNotConfirmedLocked": "FUZZY",
"exportNotConfirmedNotLocked": "FUZZY",
"htmlSubFilter": true,
"icuSubFilter": true,
"importSetSegmentConfirmedWhen": "FUZZY",
"importSetSegmentLockedWhen": "FUZZY",
"markupSubFilterNonTranslatable": "<string>",
"markupSubFilterTranslatable": "<string>",
"saveConfirmedSegments": true,
"segment": true,
"tagRegexp": "<string>",
"updateHeader": true
},
"ppt": {
"altText": true,
"hiddenSlides": true,
"masterSlides": true,
"notes": true,
"ocrImageText": true,
"other": true
},
"properties": {
"tagRegexp": "<string>"
},
"psd": {
"extractHiddenLayers": true,
"extractLockedLayers": true,
"tagRegexp": "<string>"
},
"quarkTag": {
"removeKerningTrackingTags": true,
"tagRegexp": "<string>"
},
"resx": {
"htmlSubFilter": true,
"tagRegexp": "<string>"
},
"sdlXlf": {
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsLockedRules": "<string>",
"saveConfirmedSegments": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>"
},
"segRule": {
"filename": "<string>",
"id": "<string>",
"language": "<string>",
"name": "<string>",
"primary": true,
"uid": "<string>"
},
"targetLength": true,
"targetLengthMax": 123,
"targetLengthPercent": true,
"targetLengthPercentValue": 123,
"targetSegRule": {
"filename": "<string>",
"id": "<string>",
"language": "<string>",
"name": "<string>",
"primary": true,
"uid": "<string>"
},
"tmMatch": {
"contextType": "AUTO",
"ignoreTagMetadata": true,
"metadataPriority": {
"prioritizedFields": [
{
"type": "CLIENT"
}
]
},
"penalizeMultiContextMatch": true,
"prevOrNextSegment": true
},
"ttx": {
"saveConfirmedSegments": true
},
"txt": {
"contextKey": "<string>",
"regexpCapturingGroups": true,
"tagRegexp": "<string>",
"translatableTextRegexp": "<string>"
},
"xlf": {
"contextType": "<string>",
"copySourceToTargetIfNotImported": true,
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsConfirmedXPath": "<string>",
"importAsLockedRules": "<string>",
"importAsLockedXPath": "<string>",
"importNotes": true,
"importXPath": "<string>",
"lineBreakTags": true,
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"saveConfirmedSegments": true,
"segmentation": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>",
"updateTargetLanguage": true,
"xslFile": "<string>",
"xslUrl": "<string>"
},
"xlf2": {
"contextKeyXPath": "<string>",
"copySourceToTargetIfNotImported": true,
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsLockedRules": "<string>",
"importNotes": true,
"lineBreakTags": true,
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"respectTranslateAttr": true,
"saveConfirmedSegments": true,
"segmentation": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>",
"updateTargetLanguage": true,
"xslFile": "<string>",
"xslUrl": "<string>"
},
"xls": {
"cellFlow": "DownRight",
"comments": true,
"hidden": true,
"htmlSubfilter": true,
"other": true,
"sheetNames": true,
"specifiedColumns": "<string>",
"tagRegexp": "<string>"
},
"xml": {
"assistantProfile": "<string>",
"contextKeyXPath": "<string>",
"contextNoteXpath": "<string>",
"entities": true,
"excludeAttributesPlain": "<string>",
"excludeElementsPlain": "<string>",
"expandEntities": true,
"htmlSubfilterElementsPlain": "<string>",
"htmlSubfilterElementsXpath": "<string>",
"icuSubFilter": true,
"importComments": true,
"includeAttributesPlain": "<string>",
"includeElementsPlain": "<string>",
"includeXPath": "<string>",
"inlineElementsAutoPlain": true,
"inlineElementsAutoXPath": true,
"inlineElementsNonTranslatablePlain": "<string>",
"inlineElementsNonTranslatableXPath": "<string>",
"inlineElementsPlain": "<string>",
"inlineElementsXpath": "<string>",
"lockAttributesPlain": "<string>",
"lockElementsPlain": "<string>",
"lockXPath": "<string>",
"maxLenXPath": "<string>",
"preserveCharEntities": "<string>",
"preserveWhitespaceXPath": "<string>",
"rulesFormat": "PLAIN",
"segmentation": true,
"segmentationExclude": true,
"segmentationExcludedElementsXpath": "<string>",
"tagRegexp": "<string>",
"xslFile": "<string>",
"xslUrl": "<string>"
},
"yaml": {
"contextKeyPath": "<string>",
"contextPath": "<string>",
"excludeValueRegexp": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"includeKeyRegexp": "<string>",
"indentEmptyLinesInString": true,
"localeFormat": "MEMSOURCE",
"markdownSubfilter": true,
"tagRegexp": "<string>",
"updateRootElementLang": true
},
"zipCharset": "<string>"
}Get import settings for job
Returns the job-level import settings currently applied to this already-imported job. This is distinct from the organization-level import settings templates managed via the import settings API (/api2/v1/importSettings). Use together with the edit job import settings endpoint to change these settings before a reimport of the job’s source file.
curl --request GET \
--url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings \
--header 'Authorization: <api-key>'import requests
url = "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"android": {
"icuSubFilter": true,
"tagRegexp": "<string>"
},
"asciidoc": {
"extractBtnMenuLabels": true,
"extractCustomDocumentAttributeNameRegexp": "<string>",
"htmlInPassthrough": true,
"nontranslatableMonospaceCustomStylesRegexp": "<string>",
"tagRegexp": "<string>"
},
"autodetectMultilingualFiles": true,
"csv": {
"contextKeyColumn": "<string>",
"contextNoteColumns": "<string>",
"delimiter": "<string>",
"delimiterType": "TAB",
"htmlSubFilter": true,
"importColumns": "<string>",
"importRows": "<string>",
"maxLenColumn": "<string>",
"tagRegexp": "<string>"
},
"dita": {
"excludeTags": "<string>",
"extractSeparateSegmentsXpath": "<string>",
"includeTags": "<string>",
"inlineTags": "<string>",
"inlineTagsNonTranslatable": "<string>",
"tagRegexp": "<string>"
},
"doc": {
"altText": true,
"applyTrackChanges": true,
"comments": true,
"headerFooter": true,
"hidden": true,
"hyperlinkTarget": true,
"index": true,
"joinSimilarRuns": true,
"ocrImageText": true,
"other": true,
"properties": true,
"tagRegexp": "<string>",
"targetFont": "<string>"
},
"docBook": {
"excludeTags": "<string>",
"includeTags": "<string>",
"inlineTags": "<string>",
"inlineTagsNonTranslatable": "<string>",
"tagRegexp": "<string>"
},
"fileFormat": "<string>",
"html": {
"breakTagCreatesSegment": true,
"charEntitiesToTags": "<string>",
"escapeDisabled": true,
"excludeElements": "<string>",
"importComments": true,
"importDefaultAttributes": true,
"importDefaultMetaTags": true,
"nonTranslatableInlineElements": "<string>",
"preserveWhitespace": true,
"segmentationBeginTagPlaceholder": "<string>",
"segmentationEndTagPlaceholder": "<string>",
"segmentationSingleTagPlaceholder": "<string>",
"tagRegexp": "<string>",
"translatableAttributes": "<string>",
"translatableInlineElements": "<string>",
"translateMetaTagRegexp": "<string>",
"unknownTagCreatesTag": true,
"updateLang": true
},
"idml": {
"extractCrossReferenceFormats": true,
"extractHiddenConditionalText": true,
"extractHyperlinks": true,
"extractInvisibleLayers": true,
"extractInvisibleObjects": true,
"extractLockedLayers": true,
"extractLockedObjects": true,
"extractMasterSpreads": true,
"extractNotes": true,
"extractVariables": true,
"keepKerning": true,
"keepTracking": true,
"removeXmlElements": true,
"replaceFont": true,
"simplifyCodes": true,
"tagRegexp": "<string>",
"targetFont": "<string>"
},
"inputCharset": "<string>",
"json": {
"contextKeyPath": "<string>",
"contextNotePath": "<string>",
"excludeKeyRegexp": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"includeKeyRegexp": "<string>",
"maxLenPath": "<string>",
"tagRegexp": "<string>"
},
"mac": {
"htmlSubfilter": true,
"icuSubFilter": true,
"tagRegexp": "<string>"
},
"md": {
"customElements": "<string>",
"excludeCodeElements": true,
"extractCodeBlocks": true,
"flavor": "PLAIN",
"hardLineBreaksSegments": true,
"ignoredBlockPrefixes": "<string>",
"notEscapedCharacters": "<string>",
"preserveWhiteSpaces": true,
"processJekyllFrontMatter": true,
"tagRegexp": "<string>"
},
"mif": {
"extractBodyPages": true,
"extractCustomReferencePages": true,
"extractDefaultReferencePages": true,
"extractHiddenCondText": true,
"extractHiddenPages": true,
"extractIndexMarkers": true,
"extractLinks": true,
"extractMasterPages": true,
"extractPgfNumFormat": true,
"extractReferencePages": true,
"extractUsedPgfNumFormat": true,
"extractUsedVariables": true,
"extractUsedXRefDef": true,
"extractVariables": true,
"extractXRefDef": true,
"tagRegexp": "<string>"
},
"multilingualCsv": {
"allTargetColumns": {},
"contextKeyColumns": "<string>",
"contextNoteColumns": "<string>",
"delimiter": "<string>",
"delimiterType": "TAB",
"htmlSubFilter": true,
"importRows": "<string>",
"maxLenColumns": "<string>",
"nonEmptySegmentAction": "NONE",
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceColumns": "<string>",
"tagRegexp": "<string>",
"targetColumns": "<string>"
},
"multilingualXls": {
"contextKeyColumn": "<string>",
"contextNoteColumn": "<string>",
"htmlSubFilter": true,
"importRows": "<string>",
"maxLenColumn": "<string>",
"nonEmptySegmentAction": "NONE",
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceColumn": "<string>",
"tagRegexp": "<string>",
"targetColumns": {}
},
"multilingualXml": {
"contextKeyXPath": "<string>",
"contextNoteXPath": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"inlineElementsNonTranslatableXPath": "<string>",
"maxLenXPath": "<string>",
"nonEmptySegmentAction": "NONE",
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"saveConfirmedSegmentsToTm": true,
"segmentation": true,
"sourceElementsXPath": "<string>",
"tagRegexp": "<string>",
"targetElementsXPaths": {},
"translatableElementsXPath": "<string>",
"xslFile": "<string>",
"xslUrl": "<string>"
},
"outputCharset": "<string>",
"pdf": {
"filter": "TRANS_PDF",
"ocrMode": "<string>",
"wysiwyg": true
},
"php": {
"htmlSubFilter": true,
"tagRegexp": "<string>"
},
"po": {
"contextKeySuffixType": "MSGCTXT",
"exportConfirmedLocked": "FUZZY",
"exportConfirmedNotLocked": "FUZZY",
"exportMultiline": true,
"exportNotConfirmedLocked": "FUZZY",
"exportNotConfirmedNotLocked": "FUZZY",
"htmlSubFilter": true,
"icuSubFilter": true,
"importSetSegmentConfirmedWhen": "FUZZY",
"importSetSegmentLockedWhen": "FUZZY",
"markupSubFilterNonTranslatable": "<string>",
"markupSubFilterTranslatable": "<string>",
"saveConfirmedSegments": true,
"segment": true,
"tagRegexp": "<string>",
"updateHeader": true
},
"ppt": {
"altText": true,
"hiddenSlides": true,
"masterSlides": true,
"notes": true,
"ocrImageText": true,
"other": true
},
"properties": {
"tagRegexp": "<string>"
},
"psd": {
"extractHiddenLayers": true,
"extractLockedLayers": true,
"tagRegexp": "<string>"
},
"quarkTag": {
"removeKerningTrackingTags": true,
"tagRegexp": "<string>"
},
"resx": {
"htmlSubFilter": true,
"tagRegexp": "<string>"
},
"sdlXlf": {
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsLockedRules": "<string>",
"saveConfirmedSegments": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>"
},
"segRule": {
"filename": "<string>",
"id": "<string>",
"language": "<string>",
"name": "<string>",
"primary": true,
"uid": "<string>"
},
"targetLength": true,
"targetLengthMax": 123,
"targetLengthPercent": true,
"targetLengthPercentValue": 123,
"targetSegRule": {
"filename": "<string>",
"id": "<string>",
"language": "<string>",
"name": "<string>",
"primary": true,
"uid": "<string>"
},
"tmMatch": {
"contextType": "AUTO",
"ignoreTagMetadata": true,
"metadataPriority": {
"prioritizedFields": [
{
"type": "CLIENT"
}
]
},
"penalizeMultiContextMatch": true,
"prevOrNextSegment": true
},
"ttx": {
"saveConfirmedSegments": true
},
"txt": {
"contextKey": "<string>",
"regexpCapturingGroups": true,
"tagRegexp": "<string>",
"translatableTextRegexp": "<string>"
},
"xlf": {
"contextType": "<string>",
"copySourceToTargetIfNotImported": true,
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsConfirmedXPath": "<string>",
"importAsLockedRules": "<string>",
"importAsLockedXPath": "<string>",
"importNotes": true,
"importXPath": "<string>",
"lineBreakTags": true,
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"saveConfirmedSegments": true,
"segmentation": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>",
"updateTargetLanguage": true,
"xslFile": "<string>",
"xslUrl": "<string>"
},
"xlf2": {
"contextKeyXPath": "<string>",
"copySourceToTargetIfNotImported": true,
"exportAttrsWhenConfirmedAndLocked": "<string>",
"exportAttrsWhenConfirmedAndNotLocked": "<string>",
"exportAttrsWhenNotConfirmedAndLocked": "<string>",
"exportAttrsWhenNotConfirmedAndNotLocked": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"importAsConfirmedRules": "<string>",
"importAsLockedRules": "<string>",
"importNotes": true,
"lineBreakTags": true,
"preserveCharEntities": "<string>",
"preserveWhitespace": true,
"respectTranslateAttr": true,
"saveConfirmedSegments": true,
"segmentation": true,
"skipImportRules": "<string>",
"tagRegexp": "<string>",
"updateTargetLanguage": true,
"xslFile": "<string>",
"xslUrl": "<string>"
},
"xls": {
"cellFlow": "DownRight",
"comments": true,
"hidden": true,
"htmlSubfilter": true,
"other": true,
"sheetNames": true,
"specifiedColumns": "<string>",
"tagRegexp": "<string>"
},
"xml": {
"assistantProfile": "<string>",
"contextKeyXPath": "<string>",
"contextNoteXpath": "<string>",
"entities": true,
"excludeAttributesPlain": "<string>",
"excludeElementsPlain": "<string>",
"expandEntities": true,
"htmlSubfilterElementsPlain": "<string>",
"htmlSubfilterElementsXpath": "<string>",
"icuSubFilter": true,
"importComments": true,
"includeAttributesPlain": "<string>",
"includeElementsPlain": "<string>",
"includeXPath": "<string>",
"inlineElementsAutoPlain": true,
"inlineElementsAutoXPath": true,
"inlineElementsNonTranslatablePlain": "<string>",
"inlineElementsNonTranslatableXPath": "<string>",
"inlineElementsPlain": "<string>",
"inlineElementsXpath": "<string>",
"lockAttributesPlain": "<string>",
"lockElementsPlain": "<string>",
"lockXPath": "<string>",
"maxLenXPath": "<string>",
"preserveCharEntities": "<string>",
"preserveWhitespaceXPath": "<string>",
"rulesFormat": "PLAIN",
"segmentation": true,
"segmentationExclude": true,
"segmentationExcludedElementsXpath": "<string>",
"tagRegexp": "<string>",
"xslFile": "<string>",
"xslUrl": "<string>"
},
"yaml": {
"contextKeyPath": "<string>",
"contextPath": "<string>",
"excludeValueRegexp": "<string>",
"htmlSubFilter": true,
"icuSubFilter": true,
"includeKeyRegexp": "<string>",
"indentEmptyLinesInString": true,
"localeFormat": "MEMSOURCE",
"markdownSubfilter": true,
"tagRegexp": "<string>",
"updateRootElementLang": true
},
"zipCharset": "<string>"
}Authorizations
Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Adobe InDesign (IDML) file import settings.
Show child attributes
Show child attributes
JSON import settings. contextNotePath, maxLenPath and contextKeyPath use a placeholder path syntax (e.g. ../@context2, @maxlength, ../@context1) to point at a sibling key holding the note/max-length/context-key value for a translatable key: ../ steps up to the translatable key's parent object, then @name addresses the sibling key name there. maxLenPath differs from the other two: its referenced key sits alongside the translatable value itself, not alongside the translatable key one level up, since a max length constrains the value rather than the key.
Configuring contextNotePath/contextKeyPath does NOT automatically exclude the referenced key from translation - it must also be matched by excludeKeyRegexp (or left unmatched by includeKeyRegexp), otherwise it is additionally imported as its own translatable segment.
excludeKeyRegexp/includeKeyRegexp match the full path to a key (e.g. [2]/parent/child/key), not just its bare name - the same slash-separated, [N]-indexed path syntax as contextNotePath/maxLenPath/contextKeyPath, and as the XML file format's contextNoteXpath/maxLenXPath/contextKeyXPath settings.
Example: given
[
{ "key": "Home" },
{ "key": "About" },
{ "parent": { "child": {
"key": "Hello world", "context1": "greeting_id",
"context2": "Shown on the homepage banner", "maxlength": "40"
} } }
]
with contextKeyPath=../@context1, contextNotePath=../@context2, maxLenPath=@maxlength and excludeKeyRegexp=.*/(context1|context2|maxlength)$: [0]/key ("Home") and [1]/key ("About") import as plain segments; [2]/parent/child/key ("Hello world") imports with context key greeting_id, context note Shown on the homepage banner and max length 40; [2]/parent/child/context1, .../context2 and .../maxlength are excluded from translation by excludeKeyRegexp - without it they would additionally be imported as their own translatable segments.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
TXT import settings. Segmentation is fixed at one segment per physical line and cannot be configured via any field of this object.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?