Add a trigger
curl --request POST \
--url https://api.extole.io/v6/jobs/{jobId}/triggers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"directory_path": "directory_path",
"enabled": true,
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"sftp_destination_id": "sftp_destination_id",
"trigger_type": "FILE_NAME_MATCHES"
}
'import requests
url = "https://api.extole.io/v6/jobs/{jobId}/triggers"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"directory_path": "directory_path",
"enabled": True,
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"sftp_destination_id": "sftp_destination_id",
"trigger_type": "FILE_NAME_MATCHES"
}
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']}],
directory_path: 'directory_path',
enabled: true,
match_type: 'EXACT',
parent_job_id: 'parent_job_id',
pattern: 'pattern',
sftp_destination_id: 'sftp_destination_id',
trigger_type: 'FILE_NAME_MATCHES'
})
};
fetch('https://api.extole.io/v6/jobs/{jobId}/triggers', 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}/triggers",
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'
]
]
],
'directory_path' => 'directory_path',
'enabled' => true,
'match_type' => 'EXACT',
'parent_job_id' => 'parent_job_id',
'pattern' => 'pattern',
'sftp_destination_id' => 'sftp_destination_id',
'trigger_type' => 'FILE_NAME_MATCHES'
]),
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}/triggers"
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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\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}/triggers")
.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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/jobs/{jobId}/triggers")
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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n}"
response = http.request(request)
puts response.read_body{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"id": "<string>",
"parent_job_id": "<string>",
"trigger_type": "FILE_NAME_MATCHES",
"directory_path": "<string>",
"match_type": "EXACT",
"pattern": "<string>",
"sftp_destination_id": "<string>"
}Batch Jobs
Add a trigger
Adds a trigger to the specified job. A trigger added under unattached is stored without a job and does not fire until it is attached to a job.
POST
https://api.extole.io
/
v6
/
jobs
/
{jobId}
/
triggers
Add a trigger
curl --request POST \
--url https://api.extole.io/v6/jobs/{jobId}/triggers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"directory_path": "directory_path",
"enabled": true,
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"sftp_destination_id": "sftp_destination_id",
"trigger_type": "FILE_NAME_MATCHES"
}
'import requests
url = "https://api.extole.io/v6/jobs/{jobId}/triggers"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"directory_path": "directory_path",
"enabled": True,
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"sftp_destination_id": "sftp_destination_id",
"trigger_type": "FILE_NAME_MATCHES"
}
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']}],
directory_path: 'directory_path',
enabled: true,
match_type: 'EXACT',
parent_job_id: 'parent_job_id',
pattern: 'pattern',
sftp_destination_id: 'sftp_destination_id',
trigger_type: 'FILE_NAME_MATCHES'
})
};
fetch('https://api.extole.io/v6/jobs/{jobId}/triggers', 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}/triggers",
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'
]
]
],
'directory_path' => 'directory_path',
'enabled' => true,
'match_type' => 'EXACT',
'parent_job_id' => 'parent_job_id',
'pattern' => 'pattern',
'sftp_destination_id' => 'sftp_destination_id',
'trigger_type' => 'FILE_NAME_MATCHES'
]),
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}/triggers"
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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\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}/triggers")
.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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/jobs/{jobId}/triggers")
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 \"directory_path\": \"directory_path\",\n \"enabled\": true,\n \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"sftp_destination_id\": \"sftp_destination_id\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n}"
response = http.request(request)
puts response.read_body{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"id": "<string>",
"parent_job_id": "<string>",
"trigger_type": "FILE_NAME_MATCHES",
"directory_path": "<string>",
"match_type": "EXACT",
"pattern": "<string>",
"sftp_destination_id": "<string>"
}Authorizations
HEADERQUERYCOOKIE
Path Parameters
The unique identifier of the job that owns the trigger. Use the reserved value unattached to address triggers that are not attached to any job, which happens when a component defines a trigger whose parent_job_id expression evaluates to nothing.
Body
application/json
- Option 1
- Option 2
Available options:
FILE_NAME_MATCHES match_type
Static Value · enum<string>Buildtime - Handlebars · stringBuildtime - Javascript · string
required
How the pattern is matched against filenames. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
Available options:
EXACT, REGEX Filename pattern to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
Show child attributes
Show child attributes
Whether this trigger takes part in deciding when the job runs. A disabled trigger is ignored when a file arrives. A literal value or a buildtime expression resolved from component references when the trigger is saved; defaults to true when omitted on create. Buildtime expressions use JobBuildtimeContext.
Id of the job this trigger belongs to. A literal job id or a buildtime expression resolved from component references when the trigger is saved; when omitted the trigger belongs to the job in the request path. Buildtime expressions use JobBuildtimeContext.
Optional directory path prefix to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
sftp_destination_id
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
Optional SFTP destination id to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
Response
Successful response
- Option 1
- Option 2
Stored trigger definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.
Show child attributes
Show child attributes
enabled
Static Value · booleanBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Whether this trigger takes part in deciding when the job runs, as the buildtime expression or literal that was saved. Buildtime expressions use JobBuildtimeContext.
Unique id of the trigger.
parent_job_id
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Id of the job this trigger belongs to, as the buildtime expression or literal that was saved. Buildtime expressions use JobBuildtimeContext.
Available options:
FILE_NAME_MATCHES directory_path
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Optional directory path prefix to match. Buildtime expressions use JobBuildtimeContext.
match_type
Static Value · enum<string>Buildtime - Handlebars · stringBuildtime - Javascript · string
required
How the pattern is matched against filenames. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
Available options:
EXACT, REGEX Filename pattern to match. A literal value or a buildtime expression resolved from component references when the trigger is saved. Buildtime expressions use JobBuildtimeContext.
sftp_destination_id
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Optional SFTP destination id to match. Buildtime expressions use JobBuildtimeContext.
Was this page helpful?