jobs/{id}/summary

id

The job ID. Formats used are:

• "c{number}" : A Codyt job. Examples: c3302, c102...

• "s{number}" : A Standard job. Examples: s223, s994

Mandatory

id

The globally unique string ID of the job, such as "c2002" or "s773"

string

jobid

The numeric job id (unique for Standard and Codyt respectively)

int

iscodyt

True: A Codyt job. False: A standard job.

bool

reference

The reference of the job. With Codyt jobs this is the job's document name.

string

src / srct

Source language code and name

string

trg / trgt

Target language code and name

string

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

task / taskt

Type of task with code and title.

pname

The reference of the project.

string

pid

The project id.

int

status

The job status as a number. See Job Status

int

statust

The job status name.

string

hasPredecessor

True if this job has a predecessor in the workflow

bool

assignment

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

Example:

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

deadline

Deadline

datetime?

dtstart

Date when the job started (typically when moved to in progress status).

datetime?

dtend

Date when the job was finished (when moved to completed or above status).

datetime?

dtcassign

Date when the company was assigned.

datetime?

dtpassign

Date 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:

{
    "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[]

readOnly

For 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

uicontrols

An object that includes additional parameters per actions' "uicontrol" value. These are properties required to render the action specific UI.

object

mode

0 = fixed assignment mode, 1 = open job proposal, 2 = crowd sourcing mode

int 

modet

 The name of the mode. Example: "Fixed assignment"

 string

cid

Null or the ID of the assigned company.

Note that if mode = 1, a job is still a proposal and never assigned yet.

If mode = 2, the job is not assigned neither since multiple people can work at the same time.

int?

cname

Null or the name of the assigned company.

string?

uid

Null or the ID of the assigned person. If this value is set then "cid" is set as well.

Note that a job can be assigned to just a company without specifying a specific user. The exception is, of course, if a job is assigned to an in-house worker.

int?

uname

Null or the name of the assigned person.

To get full person details, use: persons/{uid}

string?

wasAccepted

When a job is assigned by a manager, this property is false. It is set to true as soon as the assigned company or person takes action such as: Accept job, Accept job proposal, Change status to In Progress, etc.

This flag is a useful indication for the manager as well as the assigned worker.

bool

id

The ID of the action. When you want to apply an action you will need to supply this ID.

string

title

The name or title of the action.

string

desc

Null or a description of the action.

string?

isinfo

True if this item is only there to show some information. No button.

This is for example used when there is no action available to the user and we want to inform the user why there is no action at this point in time.

bool

isprimary

True if this action should be shown prominently. Typically all primary actions should be immediately accessible through buttons and without opening a combo etc.

False if this action is less important and can be hidden in an "Actions" drop down.

bool

affectsRights

Indicates if applying the action will change the accessibility of the job.

For example, changing the status of a job requires reloading editing access rights with parameter "loadRightsFromCache" = true in the editor initialisation method: resources/segments/view/properties

One of the actions giving "false" for this property is the one to submit a message with the job.

style

A color style for actions. For example, cancellation may be colored "red", job acceptance be colored "green" and so on.

Possible values are:

• Default - Regular color (black)

• Green - Actions like for accepting new jobs or completing work

• Orange - Actions such as refusals

• Red - Actions such as cancellations

• Gray - Actions that are less used such as re-assigning to a colleague

string

uicontrol

This defines what you need to show to the user together with the title and description of the action:

• None - A simple button to run the action

• Terms - Show terms & conditions (either link to read or also the checkbox - depending on other properties)

• KeepJobOpen - Control to ask if the current job shall be left open when sending back to previous job

• AssignWithinCompany - Exposes control to let user choose another person within his/her company

• WorkCompleted - Check if all work is done (stats, no errors, etc.).

NOTE: If isinfo is true then uicontrol will be

string

mustNotify

If true, a notification will be sent always. The user has no possibility to untick the notify checkbox.

Any unticking will be overridden server side.

bool

None

Always null

object

Terms

Contains properties:

• termsShow: True if you need to render a checkbox to accept terms & conditions + a link to view the terms. If false then this panel is not shown.

To fetch terms & conditions use this API: jobs/{id}/terms/preview (without setting the cid/pid parameters)

object

KeepJobOpen

Always null.

Render a checkbox, unticked by default, and ask the user if the job shall be kept open when sending back work to the preceding job in the workflow.

object

AssignWithinCompany

Always null.

Use API to get list of colleagues of the current user.

object

WorkCompleted

Contains properties:

• canSkip: If true, the user can complete the job even if the stats are "bad" (QA errors...). True if user has advanced management rights.

To evaluate if the job has problems, use this API method:

jobs/{id}/terms/checklist

If the pass result is false, the job cannot be completed - Unless canSkip above is true.

Users with advanced access rights can override blocking situations:

NONE

Your user profile does not allow changing job status

Please notify your manager of completion or for problems by email. You can close this popup.

FIXED_ACCEPT_INACTIVE

Accept a Job that's not ready to be started – Still inactive

The job has not been made active by the project manager. The job will be marked as Accepted.

FIXED_ACCEPT_INPROGRESS

Start work now!

The job will be marked as In Progress.

FIXED_ACCEPT_PROPOSAL

Accept proposal

You have received this job proposal. Click to accept the job.

FIXED_DECLINE_PROPOSAL

Decline proposal

You cannot take on this job. Click to decline the job proposal.

OPENING_ACCEPT_INACTIVE

Yes, I want to reserve this upcoming job!

This job is still inactive but you can already reserve it now. This will put your name on the job.

OPENING_ACCEPT_ACTIVE

Yes, I can take on this job!

This will put your name on the job and you will have exclusive access.

OPENING_DECLINE

Unfortunately, I have to decline this proposal.

This will remove the job opening from your job list.

CROWD_ACCEPT_INPROGRESS

Yes, I can contribute to this crowd sourced job!

This will start the job and you and others can contribute freely and simultaneously. Crowd jobs are not assigned exclusively.

CROWD_DECLINE

Unfortunately, I have to decline this invitation

This will remove the job from your job list.

COMPLETE

Work done, all OK

I approve the work and mark it as completed.

REASSIGN_PERSON

Assign to someone in my company

Choose a colleague.

DROP_PERSON_ME

Leave job to someone else in my company

I cannot take on or continue with this job! Remove my name from the job.

DROP_COMPANY_MINE

My company cannot take on this job

Refuse job and return it back to the client!

SEND_BACK

There are problems! Send back to previous work step.

I will wait until the previous worker has done any outstanding corrections.

MESSAGE

Send a message

(No description provided)

PROJECT_CLOSED

This job cannot be changed. The parent project is closed.

Contact your manager to enquire on more information.

NOACTION_INACTIVE

The current task is still inactive. It can be started once active.

Simply close this popup.

NOACTION_INACCESSIBLE_NOT_MINE

The current task is not yours.

Simply close this popup.

NOACTION_INACCESSIBLE

The current task cannot be changed for the time being

Simply close this popup.

NOACTION_JOBOPENINGRESTR

We are very sorry but you cannot take on this job. You are already assigned another job in the same workflow.

Simply close this popup.

CANNOT_COMPLETE_QA_NOT_RUN

The current task cannot be completed because QA has not been run after the last segment edit or there are segments in red.

Simply close this popup.