GET Job - TextKing/textking-api GitHub Wiki

GET /project/{projectId}/job/{jobId}

Request: GET /project/{projectId}/job/{jobId}

Returns a single job with the given ID for a specific project.

Job states

A job can be in one of the following states.

Name Description
new The job has been created and the corresponding project is no yet started.
translation-pending The job is being translated.
translation-delivered The translation has been delivered and is available for download.
revision-requested You have requested a revision of the delivered translation.
completed The translated job has been accepted by you and is completed.
canceled The job has been canceled.

Request headers

Header Description
Authorization oAuth 2 authentication header
Accept application/json or application/xml

Response status codes

HTTP status Description
200 Ok Successful request.
400 Bad Request Either the job ID or the project ID is not a valid UUID.
404 Not Found The job or project with the given ID does not exist.

Example

Load the job with the ID d0c30471-7c70-45d4-bcc1-a7773cb352b for the project with the ID bc141454-5949-401b-9c05-7591ee2f562:

GET /v1/project/bc141454-5949-401b-9c05-7591ee2f562/job/d0c30471-7c70-45d4-bcc1-a7773cb352b HTTP/1.1
Host: api.textking.com
Accept: application/json
Authorization: Bearer youraccesstoken

Response:

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8

{
    "id": "d0c30471-7c70-45d4-bcc1-a7773cb352bd",
    "number": "EN1216947-01",
    "name": "Alice-de.docx German > English",
    "source_language": "de",
    "target_language": "en",
    "quality": "translation",
    "topic": "49353ab0-fdbf-4e1c-a063-cdf4aad98782",
    "briefing": null,
    "state": "translation-delivered",
    "words": 2,
    "net_price": 0.22,
    "currency": "EUR",
    "is_active": true,
    "links": [
        {
            "rel": "self",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd"
        },
        {
            "rel": "urn:textking:project",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624"
        },
        {
            "rel": "urn:textking:document",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/document"
        },
        {
            "rel": "urn:textking:translation",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/translation/7"
        },
        {
            "rel": "urn:textking:topic",
            "href": "https://api.textking.com/v1/topic/49353ab0-fdbf-4e1c-a063-cdf4aad98782"
        },
        {
            "rel": "urn:textking:callbacks",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/callbacks"
        }
    ]
}
⚠️ **GitHub.com Fallback** ⚠️