Cancel a running SimplePipeline
curl --request POST \
--url https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancelimport requests
url = "https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel', 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.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
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.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"status": "pending",
"id": "<string>",
"project_id": "<string>",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config_path": "<string>",
"is_terminal": true,
"is_failed": true,
"user_id": "<string>",
"name": "<string>",
"description": "<string>",
"job_id": "<string>",
"error": "<string>",
"error_code": "CONFIGURATION_ERROR",
"created_by_email": "<string>",
"result": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}simple_pipeline
Cancel a running SimplePipeline
Cancel a running SimplePipeline.
Cancel a running SimplePipeline
curl --request POST \
--url https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancelimport requests
url = "https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel', 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.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
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.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"status": "pending",
"id": "<string>",
"project_id": "<string>",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config_path": "<string>",
"is_terminal": true,
"is_failed": true,
"user_id": "<string>",
"name": "<string>",
"description": "<string>",
"job_id": "<string>",
"error": "<string>",
"error_code": "CONFIGURATION_ERROR",
"created_by_email": "<string>",
"result": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Response
Successful Response
Full model for detail responses and DB records.
Available options:
pending, running, completed, failed, canceled Whether the pipeline has settled and will not transition again.
Whether the pipeline settled on anything other than success.
Derived as terminal-minus-success, so a new non-success terminal status is classified without editing this method.
Machine-readable error codes for jobs.
Available options:
CONFIGURATION_ERROR, MODEL_ERROR, SOLVER_ERROR, EXECUTION_TIMEOUT, SUBMISSION_FAILED, INTERNAL_ERROR Was this page helpful?