Delete Clipping Profile Metadata

Request

Request syntax:

DELETE /clipping-profiles/Clipping Profile ID/metadata/Metadata ID

Request URL variable:

Define the following variable when submitting the above request:

Variable	Description
Clipping Profile ID Required	Identifies a clipping profile by its system-defined or external ID. Use the Get Multiple Clipping Profiles endpoint to retrieve a list of clipping profiles and their IDs.
Metadata ID Required	Identifies a clipping profile metadata ID by its system-defined ID

Response

A successful request returns a 200 OK response that contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to the requested endpoint.
@type	String	Returns ClippingProfileMetadata.
message	String	Returns Deleted

Sample Request/Response

The code below (Python 3) shows how to delete clipping profile metadata.

This code imports names from the api_auth module for V4 APIs (see below).

Request:

			from pprint import PrettyPrinter
			import requests
			from api_auth import APICredentials, APIParams

			pp = PrettyPrinter().pprint

			class ClippingProfiles:
			"""Class Description"""
			def __init__(self, source_list):
			"""dummy"""
			self.profile_id = None
			self.metadata_id = None

			for key, value in source_list.items():
			setattr(self, key, value)

			self.host = "https://services.uplynk.com"

			def run(self):
			"""run description"""
			self._delete_metadata()

			def _delete_metadata(self):
			"""dummy"""

			end_point = f"/api/v4/clipping-profiles/{self.profile_id}/metadata/{self.metadata_id}"
			url = f"{self.host}{end_point}"
			query_params = {}

			response = requests.delete(
			url,
			params=APIParams(APICredentials()).get_params(query_params),
			timeout=15
			)

			pp(response.json())

			class_variables = {
			"profile_id": "be1af15490e24399bb6c4f2a36384d66",
			"metadata_id": "704d17c332624569b3a6414a3422fdd1"
			}
			ClippingProfiles(class_variables).run()

Response:

			{
			"@id": "/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/metadata/704d17c332624569b3a6414a3422fdd1",
			"@type": "ClippingProfileMetadata",
			"message": "Deleted"
			}