Update custom metadata values
Update custom metadata values for an Asset catalog task record.
PATCH https://{controlplane_path}/api/1/rest/public/catalog/{env_org}/custom-metadata?{uid}
Update custom metadata values for an Asset catalog task record.
Prerequisites
- Environment (Org) admin permissions
Path parameters
Key | Description |
---|---|
controlplane_path |
Required. The path to the SnapLogic control plane:
elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic . For
example:
|
env_org |
Required. The name of the SnapLogic environment/Org.
For example, My-Dev-Env |
Query parameters
Parameter | Description | Required |
---|---|---|
uid |
The task ID in the form of path/task_name, where the path includes environment-name, project-space, and project-name. For example, MY-ENV/projects/My-project/My-task. | Yes |
Request body
An array of name-value pairs that specify the custom field and values to update:
Important: If the request contains multiple values for the same column, the API
uses the last key-value pair and ignores the rest.
{
"customCol1": "value",
"customCol2": "value",
"customCol3": "value"
}
Key | Type | Description |
---|---|---|
customCol |
string |
The name of a custom column. The column must exist. |
value |
string |
The custom value to update. |
Response
A successful response includes a Code 200 OK
and the updated values:
{
"customCol1": "value",
"customCol2": "value",
"customCol3": "value"
}
Example
To use the following
curl
example: - In the URI, replace My-Dev-Env with your environment ID.
- Replace the query
uid
parameter MY-ENV/projects/My-project/My-task with the path to your task. Encode the slashes in the query parameter path. - In the request body, replace
"NewKey":"678"
and"my_custom_id":"different"
with your custom column names and values.
curl -X 'PATCH' \
'http://elastic.snaplogic.com/api/1/rest/public/catalog/My-Dev-Env/custom-metadata?uid=MY-ENV%2Fprojects%2FMy-project%2FMy-task' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"NewKey": "678",
"my_custom_id": "different"
}'
The response includes the new values:
{
"NewKey": "678",
"my_custom_id": "different"
}