PATCH /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts
configure(
host="https://your-company.open-metadata.org/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}")
import static org.openmetadata.sdk.fluent.Charts.*;
// Retrieve, modify, and update
var chart = Charts.retrieve("2dde4b53-a577-424b-bbaa-18ac32eca8a9");
chart.setDescription("Updated: Bar chart showing top-selling games by release year");
var updated = Charts.update(chart);
# Update by ID
curl -X PATCH "{base_url}/api/v1/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/charts/name/sample_superset.114" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
{
"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 chart properties using JSON Patch
PATCH
/
v1
/
charts
/
{id}
PATCH /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts
configure(
host="https://your-company.open-metadata.org/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}")
import static org.openmetadata.sdk.fluent.Charts.*;
// Retrieve, modify, and update
var chart = Charts.retrieve("2dde4b53-a577-424b-bbaa-18ac32eca8a9");
chart.setDescription("Updated: Bar chart showing top-selling games by release year");
var updated = Charts.update(chart);
# Update by ID
curl -X PATCH "{base_url}/api/v1/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/charts/name/sample_superset.114" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
{
"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
string
required
UUID of the chart to update.
Update by Name
UsePATCH /v1/charts/name/{fqn} to update by fully qualified name.
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.string
Updated description in Markdown format.
string
Updated display name.
string
Updated chart type:
Line, Bar, Area, Pie, Scatter, Table, Histogram, Other.string
Updated source URL.
array
array
string
Updated domain FQN.
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.open-metadata.org/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}")
import static org.openmetadata.sdk.fluent.Charts.*;
// Retrieve, modify, and update
var chart = Charts.retrieve("2dde4b53-a577-424b-bbaa-18ac32eca8a9");
chart.setDescription("Updated: Bar chart showing top-selling games by release year");
var updated = Charts.update(chart);
# Update by ID
curl -X PATCH "{base_url}/api/v1/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/charts/name/sample_superset.114" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated: Bar chart showing top-selling games by release year"}
]'
{
"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
string
Unique identifier for the chart (UUID format).
string
Chart name.
string
Fully qualified name in format
service.chartName.string
Updated description.
number
Incremented version number.
Error Handling
| Code | Error Type | Description |
|---|---|---|
400 | BAD_REQUEST | Invalid JSON patch or malformed request |
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to update this chart |
404 | NOT_FOUND | Chart with given ID or FQN does not exist |
409 | CONFLICT | Concurrent modification detected |
Was this page helpful?
⌘I