Update a dataset
curl --request PATCH \
--url https://api.gwenlake.com/v1/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"alias": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"project_id": "<string>",
"type": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": false
}
],
"keys": [
"<string>"
],
"model": "<string>"
}
'import requests
url = "https://api.gwenlake.com/v1/datasets/{dataset_id}"
payload = {
"name": "<string>",
"slug": "<string>",
"alias": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"project_id": "<string>",
"type": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": False
}
],
"keys": ["<string>"],
"model": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
alias: '<string>',
description: '<string>',
picture: '<string>',
organization_id: '<string>',
parent_id: '<string>',
project_id: '<string>',
type: '<string>',
columns: [{name: '<string>', type: '<string>', required: false}],
keys: ['<string>'],
model: '<string>'
})
};
fetch('https://api.gwenlake.com/v1/datasets/{dataset_id}', 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.gwenlake.com/v1/datasets/{dataset_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'alias' => '<string>',
'description' => '<string>',
'picture' => '<string>',
'organization_id' => '<string>',
'parent_id' => '<string>',
'project_id' => '<string>',
'type' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'required' => false
]
],
'keys' => [
'<string>'
],
'model' => '<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.gwenlake.com/v1/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gwenlake.com/v1/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gwenlake.com/v1/datasets/{dataset_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"object": "dataset",
"slug": "<string>",
"alias": "<string>",
"storage_path": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"parent_id": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "files",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": false
}
],
"keys": [
"<string>"
],
"model": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update a dataset
PATCH
/
datasets
/
{dataset_id}
Update a dataset
curl --request PATCH \
--url https://api.gwenlake.com/v1/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"alias": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"project_id": "<string>",
"type": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": false
}
],
"keys": [
"<string>"
],
"model": "<string>"
}
'import requests
url = "https://api.gwenlake.com/v1/datasets/{dataset_id}"
payload = {
"name": "<string>",
"slug": "<string>",
"alias": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"parent_id": "<string>",
"project_id": "<string>",
"type": "<string>",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": False
}
],
"keys": ["<string>"],
"model": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
alias: '<string>',
description: '<string>',
picture: '<string>',
organization_id: '<string>',
parent_id: '<string>',
project_id: '<string>',
type: '<string>',
columns: [{name: '<string>', type: '<string>', required: false}],
keys: ['<string>'],
model: '<string>'
})
};
fetch('https://api.gwenlake.com/v1/datasets/{dataset_id}', 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.gwenlake.com/v1/datasets/{dataset_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'alias' => '<string>',
'description' => '<string>',
'picture' => '<string>',
'organization_id' => '<string>',
'parent_id' => '<string>',
'project_id' => '<string>',
'type' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'required' => false
]
],
'keys' => [
'<string>'
],
'model' => '<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.gwenlake.com/v1/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gwenlake.com/v1/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gwenlake.com/v1/datasets/{dataset_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"alias\": \"<string>\",\n \"description\": \"<string>\",\n \"picture\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"type\": \"<string>\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": false\n }\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"model\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"object": "dataset",
"slug": "<string>",
"alias": "<string>",
"storage_path": "<string>",
"description": "<string>",
"picture": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"parent_id": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "files",
"columns": [
{
"name": "<string>",
"type": "<string>",
"required": false
}
],
"keys": [
"<string>"
],
"model": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Your Gwenlake API key, sent as Authorization: Bearer <key>.
Headers
Path Parameters
Body
application/json
PATCH body — all fields optional so the alias can be changed alone.
type is not defaulted here: an omitted type leaves it untouched.
Response
Successful Response
Show child attributes
Show child attributes