Skip to main content

workflow/{id}/traces

Retrieves traces for a complete job workflow. A workflow may englobe one or more jobs.

The current user must have management level access rights (qualified internal users only).

With Codyt workflows are based on workflow profiles. With Standard, workflows are constructed from job dependencies.

NOT IMPLEMENTED

URL

(GET) /workflow/{id}/traces

PARAMETERS

URL parameters are:

id

The id which can be any of:

  • s + Standard job id
  • c + Codyt job id
  • w + Codyt workflow id

 

string, Mandatory
includejobs

Default: false.

If true then the jobs results property is populated.

bool, Optional


RESULTS

The resulting JSON object has these properties:

count

Total number of traces.

int
items

Array with the list of traces, see below.

object[]
persons

An object containing the persons referred to by the traces uid property. Note:

  • Excludes persons that the user cannot see. There is an access right to prevent a user from viewing user and company names.

See Persons List (Object) for details.

object
jobsAn object with all referenced jobs.object
canAdd

If true then user can add new comments

bool

 

Each trace has these properties:

ctyAlways "job"string
traceidThe ID of the trace. The format is "s229" + creation date, "s9938" + creation datestring
txtOptional message with the trace. Typically used with traces that are messages.string
locThe locale to which the comment is attached. This can be a source or target locale.string
loctThe language name.string
dtThe date of the trace.datetime
uidThe user who triggered this event. Null if the user was deleted.int?
tskThe task code to which this event is attached: RV, TR, PROOFstring
tsktThe task name.string
status

The job status at the time. Numeric status, see Job Status

int
statustThe job status title.string
jid

The string job id to which this trace refers.

string
editTrue if the user is allowed to edit or delete the item. False, if no change is permitted.bool

 

The jobs object is a dictionary where the key is the string job id and the value an object as below:

idThe globally unique ID of the job (which encodes jobid + iscodyt)string
jobidThe numeric job id (unique for Standard and Codyt respectively)int
iscodytTrue: A Codyt job. False: A standard job.bool
referenceThe reference of the job. With Codyt jobs this is the job's document name.string
taskThe task code of the job (TR, RV...)string
tasktThe task title (Translation, Revision...)string
src / srctSource language code and namestring
trg / trgtTarget language code and namestring
branch / brancht

Branch language code and name. In general the branch locale is identical to the target locale.

It may be different where a workflow involves a back translation or translation into pivot languages.

string
statusThe job status as a number. See Job Statusint
statustThe job status name.string
assignment

Assignment details, see Job Assignment Details

Example:

 

"assignment" : {
     "mode" : 0,
     "modet" "Fixed assignment" ,
     "cid" : 334,
     "cname" "Ultra Translations" ,
     "uid" null ,
     "uname" null ,
     "wasAccepted" true
   }
object

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.