Sign in

v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Jobs

Create job

Creates a job within Smartling.

post/jobs-api/v3/projects/{projectId}/jobs

Path parameters

projectIdstring required

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

Request body

jobNamestring

The name of the job to create. It must be unique within the Smartling project. jobName is required.

targetLocaleIdsstring[]

The array of localeIds to be used when creating the job. The locales specified must be valid within the Smartling project.

descriptionstring

The description of the job. The description is limited to 8,000 characters.

dueDatestring date-time

The date the job is requested to be completed by.

referenceNumberstring

Customer specific number/identifier for the job.

callbackUrlstring

The URL for Smartling to invoke when the job is completed.

callbackMethodstring

The HTTP method to call (GET|POST) when invoking the callbackUrl.

Example request

{
  "jobName": "This is my job name.",
  "targetLocaleIds": [
    "ru-RU"
  ],
  "description": "This is my job description.",
  "dueDate": "2020-11-21T01:51:17Z",
  "referenceNumber": "referenceNumb1",
  "callbackUrl": "https://myDomain.com",
  "callbackMethod": "GET",
  "customFields": [
    {
      "fieldUid": "3rrwchzmjf24",
      "fieldValue": "Finance Dept"
    }
  ]
}

Response

OK

Example response

{
  "response": {
    "data": {
      "createdDate": "2015-11-21T01:51:17.000Z",
      "dueDate": "2015-11-21T01:51:17.000Z",
      "firstCompletedDate": "2015-11-21T01:51:17.000Z",
      "firstAuthorizedDate": "2015-01-21T01:51:17.000Z",
      "jobNumber": "SMTL-123",
      "jobStatus": "DRAFT | AWAITING_AUTHORIZATION | IN_PROGRESS | COMPLETED | CANCELLED | CLOSED",
      "lastCompletedDate": "2015-11-21T01:51:17.000Z",
      "lastAuthorizedDate": "2015-12-21T01:51:17.000Z",
      "modifiedDate": "2015-11-21T01:51:17.000Z",
      "customFields": [
        {
          "fieldUid": "3rrwchzmjf24",
          "fieldName": "Department Name",
          "fieldValue": "Finance Dept"
        }
      ],
      "referenceNumber": "CustomerReferenceNum1"
    }
  }
}