Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL:

/editor/task/[ID]

Available Methods:

GET / POST / PUT / DELETE

Specialities:

Since on a POST request the import data is given, the POST must be transmitted as “multipart/form-data”.

POST creates the Task, but does not and start the import process, unless . Unless autoStartImport is set to true 0, then the task is uploaded but the import starts on calling or a separate URL is called. See below.

By setting the userState to the value “edit” the task is registered as to be edited by the current user.

Setting it back to the userState “open” means that the the task is open again for all users.

forced DELETE: if the ACL right "taskForceDelete" (resource "backend") is set to a role, users of that role can use the "force" switch to delete tasks locked by other users.
This makes sense in some environments where translate5 task administration is done via API only. A DELETE call would then look like: DELETE /editor/task/123?force=1

Special Task Import URLs

URL to start the import of the uploaded task:

/editor/task/[ID]/import/ →   [ID] is the id of the task, the taskGuid is currently not supported


Special Task Export URLs

URL to get the edited task data in a ZIP container:

/editor/task/export/id/[ID]/

As above, but with diff tags:

/editor/task/export/id/[ID]/diff/1

MQM Statistic Export:

/editor/qmstatistics/index/taskGuid/[GUID]/?type=[TYPE]

...

Name

Type

Info

id

int

GET only

taskGuid

string

GET only

entityVersion

integer

GET only, set by server

taskNr

string

 

foreignIdstringoptional, is a 120 character long freetext field, not shown in the GUI. Can be used in installations where translate5 is used embedded only, to track the taskId of the management system for example.

taskName

string

 

foreignNamestringoptional, is a 255 character long, see foreignId.

sourceLang

string/integer

POST accepts: integers (internal ID), rfc5646 string values, LCIDs (must be prefixed with "lcid-" for example lcid-1031 ), GET returns always the internally used language Id

targetLang

string/integer

POST accepts: integers (internal ID), rfc5646 string values, LCIDs (must be prefixed with "lcid-" for example lcid-1031 ), GET returns always the internally used language Id

relaisLang

string/integer

POST accepts: integers (internal ID), rfc5646 string values, LCIDs (must be prefixed with "lcid-" for example lcid-1031 ), GET returns always the internally used language Id

locked

date

GET only

lockingUser

string

GET only

lockingUsername

string

GET only

lockedInternalSessionUniqIdstringGET only

state

string

POST: can be omitted, is set automatically to "import"
PUT: "end" to end a task, "open" to reopen an ended task.

GET: returns the current state of the task
import  → task is still importing data
error → task import produced and error and task is not usable
end → task is ended by a user
open → task is usable by users
unconfirmed → task is unconfirmed, can not be edited, must be confirmed (status open) first

workflow

string

The name of the workflow used in the task

workflowStepintegerThe workflow step nr
workflowStepNamestringThe name of the current workflow step

pmGuid

string

 

pmName

string

 

wordCount

integer

 

targetDeliveryDate

date

 

realDeliveryDate

date

 

referenceFiles

boolean

GET only

terminologie

boolean

GET only

orderdate

date

 

edit100PercentMatch

boolean

POST only

lockLocked

boolean

POST only

enableSourceEditing

boolean

POST only

autoStartImportboolean

POST only, optional, defaults to falsetrue. set it to true false to prevent an automatic start import automaticallyof the import - for additional configuration, preprocessing before the real import.

qmSubEnabled

boolean

GET only

qmSubFlags

auto

GET only

qmSubSeverities

auto

GET only

userState

string

As defined by the workflow.

userRole

string

GET only

userStep

string

GET only

segmentFieldsautoGET only, list with associated segment fields
userPrefsautoGET only, list with associated default user preferences

users

auto

GET only, list with associated users

tmmtsauto

userCount

integer

GET only

fileCountintegerGET only
exportRunningstringGET only

defaultSegmentLayout

boolean

GET only

importUpload

HTTP Upload

POST only

...