Versions Compared

Key

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

...

idThe globally unique string ID of the job, such as "c2002" or "s773"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
src / srctSource language code and namestring
trg / trgtTarget language code and namestring
branch / branchtBranch 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
task / tasktType of task with code and title. 
pnameThe reference of the project.string
pidThe project id.int
statusThe job status as a number. See Job Statusint
statustThe job status name.string
hasPredecessorTrue if this job has a predecessor in the workflowbool
   
assignment

A node containing details on the current job assignment, see further down.

Example:

Code Block
"assignment": {
    "mode": 0,
    "modet": "Fixed assignment",
    "cid": 334,
    "cname": "Ultra Translations",
    "uid": null,
    "uname": null,
    "wasAccepted": true
  }
 
   
deadlineDeadlinedatetime?
dtstartDate when the job started (typically when moved to in progress status).datetime?
dtendDate when the job was finished (when moved to completed or above status).datetime?
dtcassignDate when the company was assigned.datetime?
dtpassignDate when the person was assigned.datetime?
   
actions

An array of available actions, see below.

If no action is available to the user, the array is empty.

Example:

Code Block
{
    "id": "OPENING_ACCEPT_INACTIVE",
    "title": "Yes, I want to reserve this upcoming job!",
    "desc": "This job is still inactive but you can already reserve it now.",
    "isinfo": false,
    "isprimary": true,
    "affectsRights": true,
    "style": "Green",
    "uicontrol": "TermsShowLink"
  }
object[]
readOnlyFor information. If false then the job is totally locked for any change. This is for example the case if the parent project has been closed.bool
uicontrolsAn object that includes additional parameters per actions' "uicontrol" value. These are properties required to render the action specific UI.object

...