List jobs

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v2/projects/{projectUid}/jobs \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://cloud.memsource.com/web/api2/v2/projects/{projectUid}/jobs', 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/v2/projects/{projectUid}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "content": [
    {
      "continuous": true,
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateDue": "2023-11-07T05:31:56Z",
      "filename": "<string>",
      "importStatus": {
        "errorMessage": "<string>",
        "status": "RUNNING"
      },
      "imported": true,
      "innerId": "<string>",
      "originalFileDirectory": "<string>",
      "owner": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "role": "SYS_ADMIN",
        "uid": "<string>",
        "userName": "<string>"
      },
      "providers": [
        {
          "type": "<string>",
          "id": "<string>",
          "uid": "<string>"
        }
      ],
      "remoteFile": {
        "encodedFileName": "<string>",
        "encodedFolder": "<string>",
        "humanReadableFileName": "<string>",
        "humanReadableFolder": "<string>"
      },
      "serverTaskId": "<string>",
      "sourceFileUid": "<string>",
      "split": true,
      "status": "NEW",
      "targetLang": "<string>",
      "uid": "<string>",
      "workflowStep": {
        "id": "<string>",
        "name": "<string>",
        "order": 123,
        "workflowLevel": 123
      }
    }
  ],
  "numberOfElements": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "sort": {
    "orders": [
      {
        "direction": "ASC",
        "property": "<string>"
      }
    ]
  },
  "totalElements": 123,
  "totalPages": 123
}

Job

List jobs

API call to return a paginated list of jobs in the given project.

Use the query parameters to further narrow down the searching criteria.

pageNumber - A zero-based parameter indicating the page number you wish to retrieve. The total number of pages is returned in each response in the totalPages field in the top level of the response.
pageSize - A parameter indicating the size of the page you wish to return. This has direct effect on the totalPages retrieved in each response and can hence influence the number of times to iterate over to get all the jobs.
count - When set to true, the response will not contain the list of jobs (the content field) but only the counts of elements and pages. Can be used to quickly retrieve the number of elements and pages to iterate over.
workflowLevel - A non-zero based parameter indicating which workflow steps the returned jobs belong to. If left unspecified, its value is set to 1.
status - A parameter allowing for filtering only for jobs in a specific status.
assignedUser - A parameter allowing for filtering only for jobs assigned to a specific user. The parameter accepts a user ID.
dueInHours - A parameter allowing for filtering only for jobs whose due date is less or equal to the number of hours specified. This does not exclude jobs by status - jobs already DELIVERED, COMPLETED, CANCELLED, DECLINED or REJECTED are still matched. Combine with status (excluding DELIVERED, COMPLETED, CANCELLED, DECLINED and REJECTED) to match the product’s “overdue” definition.
filename - A parameter allowing for filtering only for jobs with a specific file name.
targetLang - A parameter allowing for filtering only for jobs with a specific target language.
assignedVendor - A parameter allowing for filtering only for jobs assigned to a specific vendor. The parameter accepts a user ID.
notReady - A parameter allowing for filtering only jobs that have been imported. When set to true the response will only contain jobs that have not been imported yet. This will also return jobs that have not been imported correctly, e.g. due to an error.
trashed - When set to true, returns only jobs that are currently in the project’s recycle bin (deleted but not yet permanently removed) instead of active jobs. By default (when trashed is not true), trashed jobs are excluded from results regardless of what other filters are applied. A trashed job still counts as an associated job for DELETE /api2/v1/projects//targetLangs, so use this parameter together with targetLang to find the job(s) blocking a target language removal.

For jobs assigned to one user across all projects, use GET /api2/v1/users//jobs instead.

GET

api2

projects

{projectUid}

jobs

List jobs

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v2/projects/{projectUid}/jobs \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://cloud.memsource.com/web/api2/v2/projects/{projectUid}/jobs', 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/v2/projects/{projectUid}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "content": [
    {
      "continuous": true,
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateDue": "2023-11-07T05:31:56Z",
      "filename": "<string>",
      "importStatus": {
        "errorMessage": "<string>",
        "status": "RUNNING"
      },
      "imported": true,
      "innerId": "<string>",
      "originalFileDirectory": "<string>",
      "owner": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "role": "SYS_ADMIN",
        "uid": "<string>",
        "userName": "<string>"
      },
      "providers": [
        {
          "type": "<string>",
          "id": "<string>",
          "uid": "<string>"
        }
      ],
      "remoteFile": {
        "encodedFileName": "<string>",
        "encodedFolder": "<string>",
        "humanReadableFileName": "<string>",
        "humanReadableFolder": "<string>"
      },
      "serverTaskId": "<string>",
      "sourceFileUid": "<string>",
      "split": true,
      "status": "NEW",
      "targetLang": "<string>",
      "uid": "<string>",
      "workflowStep": {
        "id": "<string>",
        "name": "<string>",
        "order": 123,
        "workflowLevel": 123
      }
    }
  ],
  "numberOfElements": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "sort": {
    "orders": [
      {
        "direction": "ASC",
        "property": "<string>"
      }
    ]
  },
  "totalElements": 123,
  "totalPages": 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

Query Parameters

pageNumber

integer<int32>

default:0

Required range: x >= 0

pageSize

integer<int32>

default:50

Page size, accepts values between 1 and 50, default 50

Required range: 1 <= x <= 50

count

boolean

default:false

workflowLevel

integer<int32>

default:1

Required range: 1 <= x <= 15

status

enum<string>[]

Available options:

NEW,

ACCEPTED,

DECLINED,

REJECTED,

DELIVERED,

EMAILED,

COMPLETED,

CANCELLED

assignedUser

integer<int64>

dueInHours

integer<int32>

filename

string

targetLang

string

assignedVendor

integer<int64>

notReady

boolean

trashed

boolean

When true, returns only trashed (recycle bin) jobs for the project instead of active jobs

Response

successful operation

content

object[]

Show child attributes

numberOfElements

integer<int32>

pageNumber

integer<int32>

pageSize

integer<int32>

sort

object

Show child attributes

totalElements

integer<int32>

totalPages

integer<int32>

⌘I

Guides

API Documentation

List jobs

Authorizations

Path Parameters

Query Parameters

Response