Autocomplete columns

Get column autocomplete suggestions

POST /storage/columns/autocomplete

Autocomplete columns

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/storage/columns/autocomplete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "column": {
    "slug": "<string>",
    "label": "<string>",
    "kind": "<string>",
    "originalSlug": "<string>",
    "properties": [
      "<string>"
    ],
    "description": "<string>"
  },
  "query": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/storage/columns/autocomplete"

payload = {
    "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column": {
        "slug": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "originalSlug": "<string>",
        "properties": ["<string>"],
        "description": "<string>"
    },
    "query": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    modelUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    column: {
      slug: '<string>',
      label: '<string>',
      kind: '<string>',
      originalSlug: '<string>',
      properties: ['<string>'],
      description: '<string>'
    },
    query: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/storage/columns/autocomplete', 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/columns/autocomplete",
  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([
    'modelUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'column' => [
        'slug' => '<string>',
        'label' => '<string>',
        'kind' => '<string>',
        'originalSlug' => '<string>',
        'properties' => [
                '<string>'
        ],
        'description' => '<string>'
    ],
    'query' => '<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/columns/autocomplete"

	payload := strings.NewReader("{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column\": {\n    \"slug\": \"<string>\",\n    \"label\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"originalSlug\": \"<string>\",\n    \"properties\": [\n      \"<string>\"\n    ],\n    \"description\": \"<string>\"\n  },\n  \"query\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.getcargo.io/v1/storage/columns/autocomplete")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column\": {\n    \"slug\": \"<string>\",\n    \"label\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"originalSlug\": \"<string>\",\n    \"properties\": [\n      \"<string>\"\n    ],\n    \"description\": \"<string>\"\n  },\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/storage/columns/autocomplete")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column\": {\n    \"slug\": \"<string>\",\n    \"label\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"originalSlug\": \"<string>\",\n    \"properties\": [\n      \"<string>\"\n    ],\n    \"description\": \"<string>\"\n  },\n  \"query\": \"<string>\"\n}"

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

200

{
  "outcome": "<string>",
  "results": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request body schema.

modelUuid · string<uuid> · required

Model identifier.

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})$

column · Column · object · required

Column definition.

Column

Column

Column

Column

Column

Show child attributes

query · string

Search query to filter autocomplete results.

Response

200

application/json

Successful response

outcome · string · required

Autocomplete outcome.

Allowed value: "autocompleted"

results · Results · object[] · required

Autocomplete results.

Show child attributes