resources/segments/view/import

To import segments to a Word, Excel or Xliff file after offline editing.

URL

(POST) /resources/segments/view/import

PARAMETERS

The message body contains a JSON object:

scope

The scope object. It delimits the total range of segments and related resources that can be operated on.

Mandatory, object
settings
tokenThe token of file uploaded (with media/upload method).Mandatory, string
doCommitBoolean. if updates shall be committed or if we only need the report.Mandatory, bool
writelocked

Boolean. Default is false.

If false then locked segments will not be updated from the imported file.

Even if this is true, the user must have the access right to change locked segments.

Optional, bool?
Mandatory, object


RESULTS

An Asynchronous operation formatted JSON.

When finished the JSON contains :

custom.filenameThe name of file importedstring
custom.filerefThe token of the file uploaded for import.string
custom.report
changesNumber. the total number of changes detected during analyze.int
errorsNumber. the total number of erroneous detected during analyze.int
isFatalBoolean. True if the import there was an error during import process.bool
fatalDetailsOnly if "fatal" is true: informations about the error.string?
fieldChangesList of fields updated.object[]
importConflictsNumber. the total number of conflicted segments.int
importUpdatedNumber. the total number of updated segments.int
nochangesNumber. The total number of segments without modification.int
processedNumber. The total number of segments analyzed during import.int
totalNumber. The total number of segments.int
object

 

 

{
	"trm": {
		"requestid":0,
		"isbatch":false,
		"status":"Finished",
		"statusText":"Finished!"
	},
	"custom":{
		"fileref":"d2f9c5c2371d44eb84fe651885f73948",
		"filename":"export_editortest1_en_es-es.docx",
		"report":{
			"isfatal":false,
			"fatal":null,
			"fatalDetails":null,
			"total":33,
			"processed":33,
			"errors":0,
			"changes":1,
			"fieldChanges":[
				{"type":0,"title":"Spanish (Spain)","count":1}
			],
			"nochanges":32,
			"importExecuted":false,
			"importUpdated":1,
			"importConflicts":0
		}
	}
}

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008