Removes a specified clipping profile from the system.
Request
Request syntax:
DELETE /clipping-profiles/{Clipping Profile ID}
Request URL variable:
Define the following variable when submitting the above request:
VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). | 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. |
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 ClippingProfile. |
message | String | Returns Deleted. |
Sample Request/Response
Call the clipping_profile_delete module (Python 3) to delete a clipping profile. This module imports names from the api_auth module.
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
for key, value in source_list.items():
setattr(self, key, value)
self.host = "https://services.uplynk.com"
self.headers = {"Content-Type": "application/json"}
def run(self):
"""dummy"""
self._get_profile_by_id()
def _get_profile_by_id(self):
"""dummy"""
url = f"{self.host}/api/v4/clipping-profiles/{self.profile_id}"
query_params = {}
response = requests.get(
url,
params=APIParams(APICredentials()).get_params(query_params),
headers=self.headers,
timeout=15
)
pp(response.json())
class_variables = {"profile_id": "be1af15490e24399bb6c4f2a36384d66"}
ClippingProfiles(class_variables).run()
Response:
{
{'@id': '/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66',
'@links': {'integrations': {'description': 'Get associated list of '
'integrations for this clipping '
'profile',
'href': '/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/integrations'},
'metadata': {'description': 'Get associated list of metadata for '
'this clipping profile',
'href': '/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/metadata'}},
'@type': 'ClippingProfile',
'default_drm': True,
'default_intro': None,
'default_library': None,
'default_outro': None,
'default_overlay': None,
'default_studio_drm': True,
'desc': 'My First Clipping Profile',
'id': 'be1af15490e24399bb6c4f2a36384d66',
'integrations': [],
'metadata': [],
'show_ext_id': True}