Patch job

curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateDue": "2023-11-07T05:31:56Z",
  "providers": [
    {
      "type": "<string>",
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}"

payload = {
    "dateDue": "2023-11-07T05:31:56Z",
    "providers": [
        {
            "type": "<string>",
            "id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dateDue: '2023-11-07T05:31:56Z',
    providers: [{type: '<string>', id: '<string>'}]
  })
};

fetch('https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'dateDue' => '2023-11-07T05:31:56Z',
    'providers' => [
        [
                'type' => '<string>',
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}"

	payload := strings.NewReader("{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "beginIndex": 123,
  "continuous": true,
  "continuousJobInfo": {
    "dateUpdated": "2023-11-07T05:31:56Z"
  },
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateDue": "2023-11-07T05:31:56Z",
  "endIndex": 123,
  "filename": "<string>",
  "importStatus": {
    "errorMessage": "<string>"
  },
  "imported": true,
  "innerId": "<string>",
  "isParentJobSplit": true,
  "jobReference": {
    "filename": "<string>",
    "uid": "<string>"
  },
  "lastWorkflowLevel": 123,
  "originalFileDirectory": "<string>",
  "project": {
    "name": "<string>",
    "uid": "<string>"
  },
  "providers": [
    {
      "type": "<string>",
      "id": "<string>",
      "uid": "<string>"
    }
  ],
  "serverTaskId": "<string>",
  "sourceLang": "<string>",
  "targetLang": "<string>",
  "uid": "<string>",
  "updateSourceDate": "2023-11-07T05:31:56Z",
  "updateTargetDate": "2023-11-07T05:31:56Z",
  "wordsCount": 123,
  "workUnit": {},
  "workflowLevel": 123,
  "workflowStep": {
    "id": "<string>",
    "name": "<string>",
    "order": 123,
    "workflowLevel": 123
  }
}

Job

Patch job

This API call allows for partial updates to jobs, modifying specific fields without overwriting those not included in the update request.

Differing from Edit job, this call employs a PATCH method, updating only the provided fields without altering others. It’s beneficial when editing a subset of supported fields is required.

The call supports the editing of status, due date, and providers. When editing providers, it’s essential to submit both the ID of the provider and its type (either VENDOR or USER).

The response will provide a subset of information from Get job.

PATCH

api2

projects

{projectUid}

jobs

{jobUid}

Patch job

curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateDue": "2023-11-07T05:31:56Z",
  "providers": [
    {
      "type": "<string>",
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}"

payload = {
    "dateDue": "2023-11-07T05:31:56Z",
    "providers": [
        {
            "type": "<string>",
            "id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dateDue: '2023-11-07T05:31:56Z',
    providers: [{type: '<string>', id: '<string>'}]
  })
};

fetch('https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'dateDue' => '2023-11-07T05:31:56Z',
    'providers' => [
        [
                'type' => '<string>',
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}"

	payload := strings.NewReader("{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/{jobUid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "beginIndex": 123,
  "continuous": true,
  "continuousJobInfo": {
    "dateUpdated": "2023-11-07T05:31:56Z"
  },
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateDue": "2023-11-07T05:31:56Z",
  "endIndex": 123,
  "filename": "<string>",
  "importStatus": {
    "errorMessage": "<string>"
  },
  "imported": true,
  "innerId": "<string>",
  "isParentJobSplit": true,
  "jobReference": {
    "filename": "<string>",
    "uid": "<string>"
  },
  "lastWorkflowLevel": 123,
  "originalFileDirectory": "<string>",
  "project": {
    "name": "<string>",
    "uid": "<string>"
  },
  "providers": [
    {
      "type": "<string>",
      "id": "<string>",
      "uid": "<string>"
    }
  ],
  "serverTaskId": "<string>",
  "sourceLang": "<string>",
  "targetLang": "<string>",
  "uid": "<string>",
  "updateSourceDate": "2023-11-07T05:31:56Z",
  "updateTargetDate": "2023-11-07T05:31:56Z",
  "wordsCount": 123,
  "workUnit": {},
  "workflowLevel": 123,
  "workflowStep": {
    "id": "<string>",
    "name": "<string>",
    "order": 123,
    "workflowLevel": 123
  }
}

Authorizations

Authorization

string

header

required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

projectUid

string

required

Project UID

jobUid

string

required

Job UID

Body

application/json

Subset of job fields to update

dateDue

string<date-time>

providers

object[]

Show child attributes

status

enum<string>

Available options:

NEW,

ACCEPTED,

DECLINED,

REJECTED,

DELIVERED,

EMAILED,

COMPLETED,

CANCELLED

Response

beginIndex

integer<int32>

Index of the first segment of this part within the original job

continuous

boolean

When true, this is a continuous job

continuousJobInfo

object

Show child attributes

dateCreated

string<date-time>

Date and time the job was created

dateDue

string<date-time>

Due date of the job; null if not set

endIndex

integer<int32>

Index of the last segment of this part within the original job

filename

string

Original filename of the job

importStatus

object

Show child attributes

imported

boolean

When true, the file has been imported successfully

innerId

string

InnerId is a sequential number of a job in a project. Jobs created from the same file share the same innerId across workflow steps.

isParentJobSplit

boolean

Whether the job originates from a split

jobReference

object

Show child attributes

lastWorkflowLevel

integer<int32>

Highest workflow step level in the project

originalFileDirectory

string

Directory path of the original source file

project

object

Show child attributes

providers

object[]

Providers assigned to the job; empty for callers without linguist visibility

Show child attributes

serverTaskId

string

Identifier of the server-side import task

sourceLang

string

Source language code

status

enum<string>

Current status of the job

Available options:

NEW,

ACCEPTED,

DECLINED,

REJECTED,

DELIVERED,

EMAILED,

COMPLETED,

CANCELLED

targetLang

string

Target language code

uid

string

Unique identifier used in API paths

updateSourceDate

string<date-time>

Date and time the source was last updated; null if never updated

updateTargetDate

string<date-time>

Date and time the target was last updated; null if never updated

wordsCount

integer<int32>

Number of words in the job

workUnit

object

workflowLevel

integer<int32>

Workflow step level of this job (1-based)

workflowStep

object

Show child attributes

Edit job Copy Source to Target job

⌘I

Guides

API Documentation

Patch job

Authorizations

Path Parameters

Body

Response