Retrieves a list of clipping profiles.
Request
Request syntax:
GET /clipping-profiles
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 Collection. |
| items | List of dictionaries | Contains a list of clipping profile configurations. |
| total_items | Integer | Indicates the total number of clipping profile configurations. |
items list
| Name | Data Type | Description |
|---|---|---|
| @id | String | Indicates the relative path to an endpoint that returns this clipping profile configuration. |
| @type | String | Returns ClippingProfile. |
| default_drm | Boolean | Require a token for playback on new clips |
| default_studio_drm | Boolean | Enable Studio DRM for playbackon 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
Call the clipping_profiles_get module (Python 3) to create 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):
self.host = "https://services.uplynk.com"
self.headers = {"Content-Type": "application/json"}
def run(self):
"""dummy"""
self._get_all_clipping_profiles()
def _get_all_clipping_profiles(self):
"""dummy"""
url = f"{self.host}/api/v4/clipping-profiles"
query_params = {}
response = requests.get(
url,
params=APIParams(APICredentials()).get_params(query_params),
headers=self.headers,
timeout=15
)
pp(response.json())
ClippingProfiles().run()
Response:
{
"@id": "/api/v4/clipping-profiles",
"@type": "Collection",
"items": [
{
"@id": "/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66",
"@type": "ClippingProfile",
"id": "be1af15490e24399bb6c4f2a36384d66",
"desc": "My First Clipping Profile",
"show_ext_id": True,
"default_drm": True,
"default_overlay": None,
"default_intro": None,
"default_outro": None,
"default_library": None,
"default_studio_drm": True,
"integrations": [],
"metadata": [],
}
],
"total_items": 1,
"search_version": 3,
}