Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
charts
/
{id}
PATCH /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
chart = Charts.retrieve("2dde4b53-a577-424b-bbaa-18ac32eca8a9")
chart.description = "Updated: Bar chart showing top-selling games by release year"
chart.chartType = "Bar"
updated = Charts.update(chart)

print(f"Updated to version {updated.version}")

{
  "id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "name": "114",
  "displayName": "# of Games That Hit 100k in Sales By Release Year",
  "fullyQualifiedName": "sample_superset.114",
  "description": "Updated: Bar chart showing top-selling games by release year",
  "chartType": "Bar",
  "version": 0.2,
  "updatedAt": 1769982666218,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/explore/?slice_id=114",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Update a Chart

Update a chart’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

​
Update by ID

​
id
string
required
UUID of the chart to update.

​
Update by Name

Use PATCH /v1/charts/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the chart (e.g., sample_superset.114).

​
Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
chartType
string
Updated chart type: Line, Bar, Area, Pie, Scatter, Table, Histogram, Other.
​
sourceUrl
string
Updated source URL.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
domain
string
Updated domain FQN.
​
extension
object
Updated custom property values.
PATCH /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
chart = Charts.retrieve("2dde4b53-a577-424b-bbaa-18ac32eca8a9")
chart.description = "Updated: Bar chart showing top-selling games by release year"
chart.chartType = "Bar"
updated = Charts.update(chart)

print(f"Updated to version {updated.version}")

{
  "id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "name": "114",
  "displayName": "# of Games That Hit 100k in Sales By Release Year",
  "fullyQualifiedName": "sample_superset.114",
  "description": "Updated: Bar chart showing top-selling games by release year",
  "chartType": "Bar",
  "version": 0.2,
  "updatedAt": 1769982666218,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/explore/?slice_id=114",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

Returns the updated chart object with the new version number.

​
Response

​
id
string
Unique identifier for the chart (UUID format).
​
name
string
Chart name.
​
fullyQualifiedName
string
Fully qualified name in format service.chartName.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this chart
404NOT_FOUNDChart with given ID or FQN does not exist
409CONFLICTConcurrent modification detected