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>",
"type": "file",
"format": "parquet"
},
"display_name": "<string>",
"extract_template_name": "<string>",
"inputs": {
"type": "s3",
"data": [
{}
],
"file_path": "<string>"
},
"last_run_at": "2023-11-07T05:31:56Z",
"last_run_status": "PENDING",
"schedule": {
"cron": "<string>",
"enabled": true
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Create Job
POST
/
v2
/
jobs
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>",
"type": "file",
"format": "parquet"
},
"display_name": "<string>",
"extract_template_name": "<string>",
"inputs": {
"type": "s3",
"data": [
{}
],
"file_path": "<string>"
},
"last_run_at": "2023-11-07T05:31:56Z",
"last_run_status": "PENDING",
"schedule": {
"cron": "<string>",
"enabled": true
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Body
application/json
Payload to create a new job.
Response
Successful Response
A configured job: an agent plus its schedule, inputs, and destination.
Was this page helpful?