Cancel an async Request

POST

api

requests

{id}

cancel

Cancel an async Request

curl --request POST \
  --url https://api.nitsor.com/api/v1/requests/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nitsor.com/api/v1/requests/{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.nitsor.com/api/v1/requests/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.nitsor.com/api/v1/requests/{id}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/requests/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "operationId": "<string>",
  "operation": "import",
  "createdAt": "2023-11-07T05:31:56Z",
  "principalId": "<string>",
  "cancellable": true,
  "counts": {
    "submitted": 1,
    "pending": 1,
    "succeeded": 1,
    "failed": 1,
    "rejected": 1,
    "cancelled": 1
  },
  "reportRef": {
    "kind": "retained"
  },
  "revision": 2,
  "state": "queued",
  "progress": 0.5,
  "startedAt": "2023-11-07T05:31:56Z",
  "target": {
    "kind": "<string>",
    "id": "<string>"
  },
  "actualCost": {
    "amount": 1,
    "currency": "<string>"
  },
  "retry": {
    "attempt": 1,
    "maxAttempts": 2
  },
  "cancelRequestedAt": "2023-11-07T05:31:56Z",
  "resultRefs": [
    {
      "kind": "<string>",
      "id": "<string>"
    }
  ]
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Path Parameters

string

required

The Request's operationId.

Required string length: 1 - 200

Response

Cancel an async Request

Option 1
Option 2
Option 3
Option 4
Option 5

operationId

string

required

Required string length: 1 - 200

operation

enum<string>

required

Available options:

import,

export,

model-run,

report,

prediction-import,

dataset-version,

source-representation

createdAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

principalId

string

required

Required string length: 1 - 200

cancellable

boolean

required

counts

object

required

submitted equals the sum of pending, succeeded, failed, rejected and cancelled.

Show child attributes

reportRef

object

required

Option 1
Option 2

Show child attributes

revision

integer

required

Required range: x >= 1

state

string

required

Allowed value: "queued"

progress

number

Required range: 0 <= x <= 1

startedAt

string<date-time>

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

target

object

Show child attributes

actualCost

object

Show child attributes

retry

object

attempt never exceeds maxAttempts when a bound is declared.

Show child attributes

cancelRequestedAt

string<date-time>

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

resultRefs

object[]

Show child attributes

Cancel an async Request

curl --request POST \
  --url https://api.nitsor.com/api/v1/requests/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nitsor.com/api/v1/requests/{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.nitsor.com/api/v1/requests/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.nitsor.com/api/v1/requests/{id}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/requests/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "operationId": "<string>",
  "operation": "import",
  "createdAt": "2023-11-07T05:31:56Z",
  "principalId": "<string>",
  "cancellable": true,
  "counts": {
    "submitted": 1,
    "pending": 1,
    "succeeded": 1,
    "failed": 1,
    "rejected": 1,
    "cancelled": 1
  },
  "reportRef": {
    "kind": "retained"
  },
  "revision": 2,
  "state": "queued",
  "progress": 0.5,
  "startedAt": "2023-11-07T05:31:56Z",
  "target": {
    "kind": "<string>",
    "id": "<string>"
  },
  "actualCost": {
    "amount": 1,
    "currency": "<string>"
  },
  "retry": {
    "attempt": 1,
    "maxAttempts": 2
  },
  "cancelRequestedAt": "2023-11-07T05:31:56Z",
  "resultRefs": [
    {
      "kind": "<string>",
      "id": "<string>"
    }
  ]
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Reference

API operations

Cancel an async Request

Authorizations

Path Parameters

Response