curl --request POST \
--url https://sdk.nimbleway.com/v2/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"extract_template_name": "<string>",
"name": "<string>",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"inputs": {
"data": [
{}
],
"file_path": "<string>"
},
"schedule": {
"cron": "<string>",
"enabled": true
}
}
'import requests
url = "https://sdk.nimbleway.com/v2/jobs"
payload = {
"extract_template_name": "<string>",
"name": "<string>",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"inputs": {
"data": [{}],
"file_path": "<string>"
},
"schedule": {
"cron": "<string>",
"enabled": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
extract_template_name: '<string>',
name: '<string>',
description: '<string>',
destination: {path: '<string>', format: 'parquet'},
display_name: '<string>',
inputs: {data: [{}], file_path: '<string>'},
schedule: {cron: '<string>', enabled: true}
})
};
fetch('https://sdk.nimbleway.com/v2/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://sdk.nimbleway.com/v2/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'extract_template_name' => '<string>',
'name' => '<string>',
'description' => '<string>',
'destination' => [
'path' => '<string>',
'format' => 'parquet'
],
'display_name' => '<string>',
'inputs' => [
'data' => [
[
]
],
'file_path' => '<string>'
],
'schedule' => [
'cron' => '<string>',
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sdk.nimbleway.com/v2/jobs"
payload := strings.NewReader("{\n \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\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(string(body))
}HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/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 \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"extract_template_name": "<string>",
"inputs": {
"data": [
{}
],
"file_path": "<string>"
},
"last_run_at": "2023-11-07T05:31:56Z",
"schedule": {
"cron": "<string>",
"enabled": true
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Create Job
curl --request POST \
--url https://sdk.nimbleway.com/v2/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"extract_template_name": "<string>",
"name": "<string>",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"inputs": {
"data": [
{}
],
"file_path": "<string>"
},
"schedule": {
"cron": "<string>",
"enabled": true
}
}
'import requests
url = "https://sdk.nimbleway.com/v2/jobs"
payload = {
"extract_template_name": "<string>",
"name": "<string>",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"inputs": {
"data": [{}],
"file_path": "<string>"
},
"schedule": {
"cron": "<string>",
"enabled": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
extract_template_name: '<string>',
name: '<string>',
description: '<string>',
destination: {path: '<string>', format: 'parquet'},
display_name: '<string>',
inputs: {data: [{}], file_path: '<string>'},
schedule: {cron: '<string>', enabled: true}
})
};
fetch('https://sdk.nimbleway.com/v2/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://sdk.nimbleway.com/v2/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'extract_template_name' => '<string>',
'name' => '<string>',
'description' => '<string>',
'destination' => [
'path' => '<string>',
'format' => 'parquet'
],
'display_name' => '<string>',
'inputs' => [
'data' => [
[
]
],
'file_path' => '<string>'
],
'schedule' => [
'cron' => '<string>',
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sdk.nimbleway.com/v2/jobs"
payload := strings.NewReader("{\n \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\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(string(body))
}HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/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 \"extract_template_name\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"path\": \"<string>\",\n \"format\": \"parquet\"\n },\n \"display_name\": \"<string>\",\n \"inputs\": {\n \"data\": [\n {}\n ],\n \"file_path\": \"<string>\"\n },\n \"schedule\": {\n \"cron\": \"<string>\",\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"destination": {
"path": "<string>",
"format": "parquet"
},
"display_name": "<string>",
"extract_template_name": "<string>",
"inputs": {
"data": [
{}
],
"file_path": "<string>"
},
"last_run_at": "2023-11-07T05:31:56Z",
"schedule": {
"cron": "<string>",
"enabled": true
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Payload to create a new job.
Name of the extract template to run.
Job name.
Free-text description of the job.
Where the job writes its results.
Show child attributes
Show child attributes
Human-friendly job name shown in the UI.
Input data configuration for the job.
Show child attributes
Show child attributes
Cron schedule controlling automatic runs.
Show child attributes
Show child attributes
Response
Successful Response
A configured job: an agent plus its schedule, inputs, and destination.
Unique job identifier (job_).
^job_[1-9][0-9]*$Job name.
When the job was created.
Free-text description of the job.
Where the job writes its results.
Show child attributes
Show child attributes
Human-friendly job name shown in the UI.
Name of the extract template this job runs.
Input data configuration for the job.
Show child attributes
Show child attributes
Timestamp of the most recent run.
Status of the most recent run.
PENDING, RUNNING, SUCCESS, FAILED, CANCELLED, TIMEOUT, WARNING Cron schedule controlling automatic runs.
Show child attributes
Show child attributes
When the job was last updated.
Was this page helpful?