Retrieves details of a specific clipping profile.

Request

Request syntax:

GET /clipping-profiles/{Clipping Profile 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.

Response

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

@id	String	Indicates the relative path to an endpoint that returns this rule
@type	String	Returns ClippingProfile
default_drm	Boolean	Require a token for playback on new clips
default_studio_drm	Boolean	Enable Studio DRM for playback on all new clips
default_overlay	String	This will be a GUID that represents an overlay that has been added to the profile
default_intro	String	This will be a GUID that represents an asset
default_outro	String	This will be a GUID that represents an asset
default_library	String	This will be a GUID that represents a Library. This is used in CMS to display a shorter list of assets when trying to decide what intro/outro bumper to use
desc	String	The description of this profile
id	String	Identifies a clipping profile by its system-defined ID
integrations	Array of Objects	Contains a list of Clipping Profile Integrations. Currently, only YouTube is allowed. See the endpoint for getting a clipping profile integration
metadata	Array of Objects	Contains a list of Clipping Profile Metadata that can be used with the Clipping Profile Integrations metamap property
show_ext_id	Boolean	Enable this to show the External ID option in the Clipping Tool

Sample Request/Response

The code below (Python 3) shows how to retrieve a clipping profile.

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

			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}