Remove records (bulk)

Remove multiple rows in one call. Body: { modelUuid, ids: [string, ...] }.

DELETE /storage/records/removeBulk

Remove records (bulk)

cURL

curl --request DELETE \
  --url https://api.getcargo.io/v1/storage/records/removeBulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.getcargo.io/v1/storage/records/removeBulk"

payload = {
    "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({modelUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a', ids: ['<string>']})
};

fetch('https://api.getcargo.io/v1/storage/records/removeBulk', 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.getcargo.io/v1/storage/records/removeBulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'modelUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'ids' => [
        '<string>'
    ]
  ]),
  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://api.getcargo.io/v1/storage/records/removeBulk"

	payload := strings.NewReader("{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.getcargo.io/v1/storage/records/removeBulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/storage/records/removeBulk")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ids\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "reason": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Shape: { modelUuid, ids: [string, ...] }.

modelUuid · string<uuid> · required

Target model.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

ids · string[] · required

Record identifiers to remove. Up to 1000 per request.

Required array length: 1 - 1000 elements

Record identifier; set on the payload under the model id column slug.

Minimum string length: 1

Response

200

application/json

Successful response

Remove records (bulk) response

Remove records (bulk) response

Error response body schema (success is 204 with no body).

reason · string · required

Failure reason from record.remove.