Displaying all jobs

post /v1/jobs/list

Retrieves a list of all jobs and their current statuses. With the mapi:jobs:admin_list permission, users may specify a userId to see jobs for that user, or omit the userId to see all jobs that otherwise match the query. Users without the this permission can only list their own jobs.

Request headers

X-XSRF-TOKEN String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: xXSRFTOKEN_example

Cookie String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: cookie_example

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: application/json'
      

          -H
          'X-XSRF-TOKEN: xXSRFTOKEN_example'
          -H
          'Cookie: cookie_example'
      

      'http://localhost/v1/jobs/list'
    

      -d
      '{
  "bucketName" : "bucketName",
  "pageSize" : 0,
  "pageToken" : "pageToken",
  "userId" : {
    "id" : 0
  }
}'
    


      

import http.client

conn = http.client.HTTPConnection("undefinedundefined")

headers = {
    'X-XSRF-TOKEN': "SOME_STRING_VALUE",
    'Cookie': "SOME_STRING_VALUE"
    }

conn.request("POST", "/v1/jobs/list", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("http://undefinedundefined/v1/jobs/list")

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

request = Net::HTTP::Post.new(url)
request["X-XSRF-TOKEN"] = 'SOME_STRING_VALUE'
request["Cookie"] = 'SOME_STRING_VALUE'

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

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://undefinedundefined/v1/jobs/list");
xhr.setRequestHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
xhr.setRequestHeader("Cookie", "SOME_STRING_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.post("http://undefinedundefined/v1/jobs/list")
  .header("X-XSRF-TOKEN", "SOME_STRING_VALUE")
  .header("Cookie", "SOME_STRING_VALUE")
  .asString();

import Foundation

let headers = [
  "X-XSRF-TOKEN": "SOME_STRING_VALUE",
  "Cookie": "SOME_STRING_VALUE"
]

let request = NSMutableURLRequest(url: NSURL(string: "http://undefinedundefined/v1/jobs/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://undefinedundefined/v1/jobs/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Cookie: SOME_STRING_VALUE",
    "X-XSRF-TOKEN: SOME_STRING_VALUE"
  ],
]);

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

curl_close($curl);

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

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://undefinedundefined/v1/jobs/list");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-XSRF-TOKEN: SOME_STRING_VALUE");
headers = curl_slist_append(headers, "Cookie: SOME_STRING_VALUE");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("http://undefinedundefined/v1/jobs/list");
var request = new RestRequest(Method.POST);
request.AddHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
request.AddHeader("Cookie", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

Body parameters

*/*

userIdobject

idintegerrequiredint32

Integer identifier for metadata.

bucketNamestring

List jobs for specified bucket. Null attempts to list jobs for all buckets.

pageSizeinteger

Maximum number of results to request.

pageTokenstring

Page token from previous request to get the next page of results.

REQUEST
[*/* content]

Responses

List of jobs

Body

application/json

jobsarrayrequired

List of jobs

[

jobIdobject

idintegerrequiredint32

Integer identifier for metadata.

jobStatestring (Enum)

The state of the job

Allowed values:"EXAMINING""PROCESSING""EXECUTING""COMPLETE""FAILED""CANCELLED"

jobTypestring (Enum)

Type of Job

Allowed values:"BATCH_REPLICATE""LIFECYCLE_UPDATE""METRIC_RECONCILIATION""TRIGGER_RECONCILIATION"

startTimestringdate-time

The time the job started

completeTimestringdate-time

The time the job completed

jobParamsobject

Arbitrary parameters needed by different Job types

Additional propertiesstring

jobStatsobject

processedintegerint64

failedintegerint64

bucketNamestring

The name of the bucket that the job operates on

]

pageTokenstringrequired

A page token that can be used to get the next page of results

RESPONSE
{
  "jobs": [
    {
      "jobId": {
        "id": 0
      },
      "jobState": "EXAMINING",
      "jobType": "BATCH_REPLICATE",
      "startTime": "2020-01-01T12:00:00Z",
      "completeTime": "2020-01-01T12:00:00Z",
      "jobParams": {
        "additionalProperties": "example"
      },
      "jobStats": {
        "processed": 0,
        "failed": 0
      },
      "bucketName": "example"
    }
  ],
  "pageToken": "example"
}

Invalid request

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{
  "code": "example",
  "message": "example",
  "details": "example"
}

Access was denied due to invalid credentials.