...
- Any missing translations?
- Any translations in red/error status?
- Was a QA check done (after the job was started)?
- Are there QA errors left?
URL
(GET) /jobs/{id}/terms/checklistPARAMETERS
URL parameters are:
id | The job ID. Also see jobs/{id}/summary | string, Mandatory |
RESULTS
The resulting JSON object has these properties:
| pass | True: The checklist lets user proceed with the "next" step. For example, a user can only complete a job if the value is true. | bool |
| isok | True: The checklist rules are all error/warning free. Note that even if this property is false, the value for pass may be true. | bool |
| items | The list of all checklist items. Each item has a title, description and implements a validation rule:
| object[] |
...
Each checklist item has these properties:
...
| Rule evaluation | ||
| pass | User can proceed (if rule evaluates successfully or the rule is not mandatory) True: The checklist lets user proceed with the "next" step. False: The problem must be resolved before proceeding. Example: Checks if the user can complete a job. | bool |
| ok | Rule evaluates to success. True: Rule did not yield problems: Result is either Success or Information. False: Rule resulted with a problem. | bool |
| result | The evaluation result of the rule, any of:
| string |
| msg | Optional message attached to the evaluation result. Usually contains error messages. | string? |
| Rule properties | ||
| title | Title of checklist item or rule | string |
| desc | Description of the rule | string |
| mandatory | True if the rule must evaluate to success in order to let the user proceed. | bool |
| rule | Internal ID of the rule | string |
...
EXAMPLES
A job that still requires some cleanup to do before it can be completed by the user:
| Code Block |
|---|
{
"pass": true,
"ok": false,
"items": [
{
"pass": true,
"rule": "j_trans",
"title": "Translations done",
"desc": "Looks for missing translations or translations flagged as erroneous.",
"mandatory": false,
"result": "Error",
"ok": false,
"msg": "A total of 1 translations are missing. Flag these with green status if blank on purpose."
},
{
"pass": true,
"rule": "j_qa",
"title": "Quality assurance check",
"desc": "Validates that a QA check was done prior to submitting a job.",
"mandatory": false,
"result": "Error",
"ok": false,
"msg": "Please run a QA."
}
]
} |
...
This job asks the user to run a QA, however the QA is not mandatory (pass is true):
| Code Block |
|---|
{
"pass": true,
"ok": false,
"items": [
{
"pass": true,
"rule": "j_trans",
"title": "Translations done",
"desc": "Looks for missing translations or translations flagged as erroneous.",
"mandatory": false,
"result": "Success",
"ok": true,
"msg": null
},
{
"pass": true,
"rule": "j_qa",
"title": "Quality assurance check",
"desc": "Validates that a QA check was done prior to submitting a job.",
"mandatory": false,
"result": "Error",
"ok": false,
"msg": "Please run a QA for this job. None has been done yet."
}
]
} |
...