Delete custom metadata values

Delete custom metadata values for an Asset catalog task record.

DELETE https://{controlplane_path}/api/2/{env_id}/public/catalog/custom-metadata?{uid}
Delete custom metadata values for an Asset catalog task record.

Prerequisites

  • Environment (Org) admin permissions

Path parameters

Parameter Description Required
env_id The environment ID, which is available from the Environment details field in Admin Manager. Yes

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

A list of strings that specify the names of the custom columns to delete:

[
  "customColumn1",
  "customColumn2",
  "customColumn3"
]
Key Type Description
customColumn string The name of a custom column with a value to delete. The column must exist.

Response

A successful response includes a Code 200 OK.

Example

To use the following curl example:
  • In the URI, replace 555d444c777d99e22e9b9e99 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" and "NewKeyy" with the name of the custom columns to delete.
curl -X 'DELETE' \
  'http://elastic.snaplogic.com/api/2/555d444c777d99e22e9b9e99/public/catalog/custom-metadata?uid=MY_ENV%2Fprojects%2FMy-project%2FMy-task' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '[
  "newKey",
  "newKeyy"
]'