Add a task

Add a task

curl --request POST \
  --url https://api.extole.io/v6/jobs/{jobId}/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "expected_headers": [
    "expected_header"
  ],
  "match_mode": "EXACT_SET",
  "on_mismatch": "FAIL",
  "order": 1,
  "parent_job_id": "parent_job_id",
  "task_type": "FILE_HEADER_VALIDATOR"
}
'

import requests

url = "https://api.extole.io/v6/jobs/{jobId}/tasks"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "expected_headers": ["expected_header"],
    "match_mode": "EXACT_SET",
    "on_mismatch": "FAIL",
    "order": 1,
    "parent_job_id": "parent_job_id",
    "task_type": "FILE_HEADER_VALIDATOR"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    expected_headers: ['expected_header'],
    match_mode: 'EXACT_SET',
    on_mismatch: 'FAIL',
    order: 1,
    parent_job_id: 'parent_job_id',
    task_type: 'FILE_HEADER_VALIDATOR'
  })
};

fetch('https://api.extole.io/v6/jobs/{jobId}/tasks', 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://api.extole.io/v6/jobs/{jobId}/tasks",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'expected_headers' => [
        'expected_header'
    ],
    'match_mode' => 'EXACT_SET',
    'on_mismatch' => 'FAIL',
    'order' => 1,
    'parent_job_id' => 'parent_job_id',
    'task_type' => 'FILE_HEADER_VALIDATOR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.extole.io/v6/jobs/{jobId}/tasks"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://api.extole.io/v6/jobs/{jobId}/tasks")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs/{jobId}/tasks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}"

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "order": 123,
  "parent_job_id": "<string>",
  "task_type": "FILE_HEADER_VALIDATOR",
  "expected_headers": [
    "<string>"
  ],
  "match_mode": "EXACT_SET",
  "on_mismatch": "FAIL"
}

POST

jobs

{jobId}

tasks

Add a task

curl --request POST \
  --url https://api.extole.io/v6/jobs/{jobId}/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "expected_headers": [
    "expected_header"
  ],
  "match_mode": "EXACT_SET",
  "on_mismatch": "FAIL",
  "order": 1,
  "parent_job_id": "parent_job_id",
  "task_type": "FILE_HEADER_VALIDATOR"
}
'

import requests

url = "https://api.extole.io/v6/jobs/{jobId}/tasks"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "expected_headers": ["expected_header"],
    "match_mode": "EXACT_SET",
    "on_mismatch": "FAIL",
    "order": 1,
    "parent_job_id": "parent_job_id",
    "task_type": "FILE_HEADER_VALIDATOR"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    expected_headers: ['expected_header'],
    match_mode: 'EXACT_SET',
    on_mismatch: 'FAIL',
    order: 1,
    parent_job_id: 'parent_job_id',
    task_type: 'FILE_HEADER_VALIDATOR'
  })
};

fetch('https://api.extole.io/v6/jobs/{jobId}/tasks', 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://api.extole.io/v6/jobs/{jobId}/tasks",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'expected_headers' => [
        'expected_header'
    ],
    'match_mode' => 'EXACT_SET',
    'on_mismatch' => 'FAIL',
    'order' => 1,
    'parent_job_id' => 'parent_job_id',
    'task_type' => 'FILE_HEADER_VALIDATOR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.extole.io/v6/jobs/{jobId}/tasks"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://api.extole.io/v6/jobs/{jobId}/tasks")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs/{jobId}/tasks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"expected_headers\": [\n    \"expected_header\"\n  ],\n  \"match_mode\": \"EXACT_SET\",\n  \"on_mismatch\": \"FAIL\",\n  \"order\": 1,\n  \"parent_job_id\": \"parent_job_id\",\n  \"task_type\": \"FILE_HEADER_VALIDATOR\"\n}"

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "order": 123,
  "parent_job_id": "<string>",
  "task_type": "FILE_HEADER_VALIDATOR",
  "expected_headers": [
    "<string>"
  ],
  "match_mode": "EXACT_SET",
  "on_mismatch": "FAIL"
}

Authorizations

Authorization

string

header

required

Path Parameters

jobId

string

required

The unique identifier of the job that owns the task. Use the reserved value unattached to address tasks that are not attached to any job, which happens when a component defines a task whose parent_job_id expression evaluates to nothing.

Body

application/json

Option 1
Option 2
Option 3

task_type

enum<string>

required

Available options:

FILE_HEADER_VALIDATOR

expected_headers

required

Headers the validated file is expected to contain. A literal value or a buildtime expression resolved from component references when the task is saved. Buildtime expressions use JobBuildtimeContext.

Headers the validated file is expected to contain. A literal value or a buildtime expression resolved from component references when the task is saved.

match_mode

enum<string>

required

Available options:

EXACT_SET,

ORDERED,

SUBSET

on_mismatch

required

Action taken when the headers do not match. A literal value or a buildtime expression resolved from component references when the task is saved. Buildtime expressions use JobBuildtimeContext.

Available options:

FAIL,

WARN

component_ids

string[]

component_references

object[]

Show child attributes

order

Position of this task in its job's ordered task list. A literal integer or a buildtime expression resolved from component references when the task is saved; when omitted the task is appended after the existing tasks. Buildtime expressions use JobBuildtimeContext.

parent_job_id

Id of the job this task belongs to. A literal job id or a buildtime expression resolved from component references when the task is saved; when omitted the task belongs to the job in the request path. Buildtime expressions use JobBuildtimeContext.

Response

Successful response

Option 1
Option 2
Option 3

Stored task definition. Field order is unevaluated and appears in buildtime-evaluatable form.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

string

required

read-only

Unique id of the task.

order

required

Position of this task in the job, as the buildtime expression or literal that was saved. Re-evaluated on campaign publish to determine the task's resolved execution order. Buildtime expressions use JobBuildtimeContext.

parent_job_id

required

Id of the job this task belongs to, as the buildtime expression or literal that was saved. Buildtime expressions use JobBuildtimeContext.

task_type

enum<string>

required

Available options:

FILE_HEADER_VALIDATOR

expected_headers

required

Headers the validated file is expected to contain. A literal value or a buildtime expression resolved from component references when the task is saved. Buildtime expressions use JobBuildtimeContext.

Headers the validated file is expected to contain. A literal value or a buildtime expression resolved from component references when the task is saved.

match_mode

enum<string>

required

Available options:

EXACT_SET,

ORDERED,

SUBSET

on_mismatch

required

Action taken when the headers do not match. A literal value or a buildtime expression resolved from component references when the task is saved. Buildtime expressions use JobBuildtimeContext.

Available options:

FAIL,

WARN

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Authorizations

Path Parameters

Body

Response