Jobs

Get progress of file within job

Changed on

This shows the progress of a file within a job.

get/jobs-api/v3/projects/{projectId}/jobs/{translationJobUid}/file/progress

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Unique identifier of a Smartling project — 9 lowercase alphanumeric characters.

Example:84c012a33

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

translationJobUidstring required

Translation job unique identifier — 12 lowercase alphanumeric characters.

Example:j45v1uvsi3tx

Query parameters

fileUristring required

URI path of a source file within a Smartling project.

Example:/content/en/home.json

Response

OK

Example response

{
  "response": {
    "data": {
      "contentProgressReport": [
        {
          "targetLocaleId": "fr-FR",
          "workflowProgressReportList": [
            {
              "workflowStepSummaryReportItemList": [
                {
                  "workflowStepUid": "7564fc097a85"
                }
              ],
              "workflowUid": "5449a8595ae4"
            }
          ]
        }
      ],
      "progress": {
        "percentComplete": 52,
        "totalWordCount": 192
      }
    }
  }
}

Changes

    • breaking

      added the pattern ^[a-z0-9]{12}$ to the path request parameter translationJobUid

    • breaking

      added the pattern ^[a-z0-9]{9}$ to the path request parameter projectId

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      the ///// response's property pattern ^[a-z]{2}(-[A-Z]{2})?$ was added for the status

    • info

      the ///////// response's property pattern ^[a-z0-9]{12}$ was added for the status

    • info

      the /////// response's property pattern ^[a-z0-9]{12}$ was added for the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status