> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.umnai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.umnai.com/_mcp/server.

# Jobs

An onboarding job runs an onboarding configuration against a datasource.

Jobs are asynchronous. Create a job, then retrieve it to monitor status, progress, current stage, and the dataset produced by the run.

## Create an initial job

An initial onboarding job creates a new dataset.

### Request

POST [https://api.hi.umnai.com/data-processing-onboarding-jobs](https://api.hi.umnai.com/data-processing-onboarding-jobs)

```curl Create initial onboarding job
curl -X POST https://api.hi.umnai.com/data-processing-onboarding-jobs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "job_type": "INITIAL",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "dataset_name": "Sample Dataset",
  "datasource_id": "1ea7e575defdf6bc3f26a3f127e98170",
  "name": "Sample Initial Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}'
```

```python Create initial onboarding job
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs"

payload = {
    "job_type": "INITIAL",
    "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
    "dataset_name": "Sample Dataset",
    "datasource_id": "1ea7e575defdf6bc3f26a3f127e98170",
    "name": "Sample Initial Onboarding Job",
    "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create initial onboarding job
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"job_type":"INITIAL","data_processing_configuration_id":"3dd973d3fda8604fba040381bfcaab29","dataset_name":"Sample Dataset","datasource_id":"1ea7e575defdf6bc3f26a3f127e98170","name":"Sample Initial Onboarding Job","compute_configuration_id":"351df95006b1350e597762a1d58e9319"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Create initial onboarding job
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs"

	payload := strings.NewReader("{\n  \"job_type\": \"INITIAL\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"dataset_name\": \"Sample Dataset\",\n  \"datasource_id\": \"1ea7e575defdf6bc3f26a3f127e98170\",\n  \"name\": \"Sample Initial Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}")

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Create initial onboarding job
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job_type\": \"INITIAL\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"dataset_name\": \"Sample Dataset\",\n  \"datasource_id\": \"1ea7e575defdf6bc3f26a3f127e98170\",\n  \"name\": \"Sample Initial Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}"

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

```java Create initial onboarding job
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.hi.umnai.com/data-processing-onboarding-jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job_type\": \"INITIAL\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"dataset_name\": \"Sample Dataset\",\n  \"datasource_id\": \"1ea7e575defdf6bc3f26a3f127e98170\",\n  \"name\": \"Sample Initial Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}")
  .asString();
```

```php Create initial onboarding job
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.hi.umnai.com/data-processing-onboarding-jobs', [
  'body' => '{
  "job_type": "INITIAL",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "dataset_name": "Sample Dataset",
  "datasource_id": "1ea7e575defdf6bc3f26a3f127e98170",
  "name": "Sample Initial Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Create initial onboarding job
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"job_type\": \"INITIAL\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"dataset_name\": \"Sample Dataset\",\n  \"datasource_id\": \"1ea7e575defdf6bc3f26a3f127e98170\",\n  \"name\": \"Sample Initial Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create initial onboarding job
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "job_type": "INITIAL",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "dataset_name": "Sample Dataset",
  "datasource_id": "1ea7e575defdf6bc3f26a3f127e98170",
  "name": "Sample Initial Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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

dataTask.resume()
```

### Response (201)

```json
{
  "job_type": "INITIAL",
  "data_processing_configuration": {
    "id": "3dd973d3fda8604fba040381bfcaab29",
    "name": "Sample Onboarding Configuration"
  },
  "datasource": {
    "id": "1ea7e575defdf6bc3f26a3f127e98170",
    "name": "Sample Datasource"
  },
  "dataset": {
    "id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
    "name": "Sample Dataset"
  },
  "id": "7c2e73157a35658c245511bcf2a95195",
  "name": "Sample Initial Onboarding Job",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "compute_configuration": {
    "id": "351df95006b1350e597762a1d58e9319",
    "name": "Sample Compute Configuration"
  },
  "status": "STARTING",
  "maximum_runtime_seconds": 3600,
  "created_at": "2026-03-15T10:15:30.000000Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z",
  "stage": "initializing",
  "progress": 0,
  "stage_progress": 0
}
```

The job references the datasource, onboarding configuration, and processing compute configuration. It also names the dataset that will be created.

## Create an incremental job

An incremental onboarding job adds new data to an existing dataset.

### Request

POST [https://api.hi.umnai.com/data-processing-onboarding-jobs](https://api.hi.umnai.com/data-processing-onboarding-jobs)

```curl Create incremental onboarding job
curl -X POST https://api.hi.umnai.com/data-processing-onboarding-jobs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "job_type": "INCREMENT",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "datasource_id": "3914cecdf57d2eade4435a94f82faf4e",
  "dataset_id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
  "increment_label": "March update",
  "name": "Sample Incremental Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}'
```

```python Create incremental onboarding job
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs"

payload = {
    "job_type": "INCREMENT",
    "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
    "datasource_id": "3914cecdf57d2eade4435a94f82faf4e",
    "dataset_id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
    "increment_label": "March update",
    "name": "Sample Incremental Onboarding Job",
    "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create incremental onboarding job
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"job_type":"INCREMENT","data_processing_configuration_id":"3dd973d3fda8604fba040381bfcaab29","datasource_id":"3914cecdf57d2eade4435a94f82faf4e","dataset_id":"3c4d09e4ef50b370ae0efacdb43ec2dd","increment_label":"March update","name":"Sample Incremental Onboarding Job","compute_configuration_id":"351df95006b1350e597762a1d58e9319"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Create incremental onboarding job
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs"

	payload := strings.NewReader("{\n  \"job_type\": \"INCREMENT\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"datasource_id\": \"3914cecdf57d2eade4435a94f82faf4e\",\n  \"dataset_id\": \"3c4d09e4ef50b370ae0efacdb43ec2dd\",\n  \"increment_label\": \"March update\",\n  \"name\": \"Sample Incremental Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}")

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Create incremental onboarding job
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job_type\": \"INCREMENT\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"datasource_id\": \"3914cecdf57d2eade4435a94f82faf4e\",\n  \"dataset_id\": \"3c4d09e4ef50b370ae0efacdb43ec2dd\",\n  \"increment_label\": \"March update\",\n  \"name\": \"Sample Incremental Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}"

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

```java Create incremental onboarding job
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.hi.umnai.com/data-processing-onboarding-jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job_type\": \"INCREMENT\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"datasource_id\": \"3914cecdf57d2eade4435a94f82faf4e\",\n  \"dataset_id\": \"3c4d09e4ef50b370ae0efacdb43ec2dd\",\n  \"increment_label\": \"March update\",\n  \"name\": \"Sample Incremental Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}")
  .asString();
```

```php Create incremental onboarding job
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.hi.umnai.com/data-processing-onboarding-jobs', [
  'body' => '{
  "job_type": "INCREMENT",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "datasource_id": "3914cecdf57d2eade4435a94f82faf4e",
  "dataset_id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
  "increment_label": "March update",
  "name": "Sample Incremental Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Create incremental onboarding job
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"job_type\": \"INCREMENT\",\n  \"data_processing_configuration_id\": \"3dd973d3fda8604fba040381bfcaab29\",\n  \"datasource_id\": \"3914cecdf57d2eade4435a94f82faf4e\",\n  \"dataset_id\": \"3c4d09e4ef50b370ae0efacdb43ec2dd\",\n  \"increment_label\": \"March update\",\n  \"name\": \"Sample Incremental Onboarding Job\",\n  \"compute_configuration_id\": \"351df95006b1350e597762a1d58e9319\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create incremental onboarding job
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "job_type": "INCREMENT",
  "data_processing_configuration_id": "3dd973d3fda8604fba040381bfcaab29",
  "datasource_id": "3914cecdf57d2eade4435a94f82faf4e",
  "dataset_id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
  "increment_label": "March update",
  "name": "Sample Incremental Onboarding Job",
  "compute_configuration_id": "351df95006b1350e597762a1d58e9319"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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

dataTask.resume()
```

### Response (201)

```json
{
  "job_type": "INCREMENT",
  "data_processing_configuration": {
    "id": "3dd973d3fda8604fba040381bfcaab29",
    "name": "Sample Onboarding Configuration"
  },
  "datasource": {
    "id": "3914cecdf57d2eade4435a94f82faf4e",
    "name": "Sample Incremental Datasource"
  },
  "dataset": {
    "id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
    "name": "Sample Dataset"
  },
  "increment_label": "March update",
  "id": "8b1130720f054149ac83bca083f8d216",
  "name": "Sample Incremental Onboarding Job",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "compute_configuration": {
    "id": "351df95006b1350e597762a1d58e9319",
    "name": "Sample Compute Configuration"
  },
  "status": "STARTING",
  "maximum_runtime_seconds": 3600,
  "created_at": "2026-03-16T10:15:30.000000Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-16T10:15:30.000000Z",
  "stage": "initializing",
  "progress": 0,
  "stage_progress": 0
}
```

Incremental jobs use a newer datasource and can include an `increment_label` to identify the update.

## Monitor jobs

Retrieve jobs to monitor onboarding progress or inspect previous runs.

### Request

GET [https://api.hi.umnai.com/data-processing-onboarding-jobs](https://api.hi.umnai.com/data-processing-onboarding-jobs)

```curl
curl https://api.hi.umnai.com/data-processing-onboarding-jobs \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hi.umnai.com/data-processing-onboarding-jobs")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hi.umnai.com/data-processing-onboarding-jobs', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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 as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (200)

```json
{
  "data": [
    {
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
      "name": "Sample Organisation",
      "status": "ACTIVE",
      "created_at": "2026-03-11T16:04:19.749000Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}
```

To inspect a specific job, retrieve it by `id`.

### Request

GET [https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId}](https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId})

```curl
curl https://api.hi.umnai.com/data-processing-onboarding-jobs/{dataProcessingOnboardingJobId} \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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 as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Response (200)

```json
{
  "data": [
    {
      "id": "ea8b745ead39ec442fc3b4fba359bf98",
      "name": "Sample Organisation",
      "status": "ACTIVE",
      "created_at": "2026-03-11T16:04:19.749000Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}
```

Job responses include the job status, overall progress, current stage, and stage progress.

| Status       | Meaning                                         |
| ------------ | ----------------------------------------------- |
| `STARTING`   | The job has been created and is being prepared. |
| `RUNNING`    | The job is processing data.                     |
| `FINALIZING` | The job is completing final processing steps.   |
| `COMPLETED`  | The job finished successfully.                  |
| `FAILED`     | The job stopped because of an error.            |
| `STOPPED`    | The job was stopped before completion.          |

### Initial job stages

An initial onboarding job can move through these stages:

* Data validation
* Masking
* Analysis
* Statistics
* Preprocessing
* Sharding
* Transformation
* Initialisation
* Persistence
* Teardown

### Incremental job stages

An incremental onboarding job can move through these stages:

* Masking
* Analysis
* Statistics
* Preprocessing
* Sharding
* Transformation
* Metadata
* Persistence
* Teardown

The masking stage is only used when unseen category handling is enabled.

## Update a job

Update an onboarding job when you need to rename it.

### Request

PATCH [https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId}](https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId})

```curl
curl -X PATCH https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "New Sample Onboarding Job"
}'
```

```python
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId"

payload = { "name": "New Sample Onboarding Job" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"New Sample Onboarding Job"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId"

	payload := strings.NewReader("{\n  \"name\": \"New Sample Onboarding Job\"\n}")

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"New Sample Onboarding Job\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"New Sample Onboarding Job\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId', [
  'body' => '{
  "name": "New Sample Onboarding Job"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"New Sample Onboarding Job\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["name": "New Sample Onboarding Job"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs/:dataProcessingOnboardingJobId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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

dataTask.resume()
```

### Response (200)

```json
{
  "job_type": "INITIAL",
  "data_processing_configuration": {
    "id": "3dd973d3fda8604fba040381bfcaab29",
    "name": "Sample Onboarding Configuration"
  },
  "datasource": {
    "id": "1ea7e575defdf6bc3f26a3f127e98170",
    "name": "Sample Datasource"
  },
  "dataset": {
    "id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
    "name": "Sample Dataset"
  },
  "id": "7c2e73157a35658c245511bcf2a95195",
  "name": "New Sample Onboarding Job",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "compute_configuration": {
    "id": "351df95006b1350e597762a1d58e9319",
    "name": "Sample Compute Configuration"
  },
  "status": "STARTING",
  "maximum_runtime_seconds": 1,
  "created_at": "2026-03-15T10:15:30.000000Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-15T10:15:30.000000Z",
  "stage": "sample_stage",
  "progress": 0.5,
  "stage_progress": 0.5
}
```

## Delete a job

Delete an onboarding job when it should no longer be kept.

### Request

DELETE [https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId}](https://api.hi.umnai.com/data-processing-onboarding-jobs/\{dataProcessingOnboardingJobId})

```curl
curl -X DELETE https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId \
     -H "Authorization: Bearer <token>"
```

```python
import requests

url = "https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.delete("https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hi.umnai.com/data-processing-onboarding-jobs/dataProcessingOnboardingJobId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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 as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```