Retrieves one or more clipping profiles Metadata.

Request

Request syntax:

GET /clipping-profiles/{Clipping Profile ID}/metadata

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:

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 ClippingProfileIntegration.
created	String	Identifies the date and time (UTC) this integration was create. Syntax: `{YYYY-MM-DDThh:mm:ss.ssssss}Z` Example: 2024-04-04T16:35:46.054Z
lastmod	String	Identifies the date and time (UTC) this integration was create. Syntax: `{YYYY-MM-DDThh:mm:ss.ssssss}Z` Example: 2024-04-04T16:35:46.054Z
default_value	String	Identifies the date and time (UTC) this integration was create. Syntax: `{YYYY-MM-DDThh:mm:ss.ssssss}Z` Example: 2024-04-04T16:35:46.054Z
id	String	Identifies a clipping profile by its system-defined ID
include_free_form	String	Indicates if free form is enabled
include_null	String	Indicates if “No Value” option is enabled
input_type	String	Indicates the type that is being used for the metadata
key	String	The description of this metadata
owner	String	Indicates the system-defined ID for the user that own this clipping profile integration.
profile	String	Indicates the system-defined ID representing the clipping profile
values	List of Lists	Key/Value string pair as lists

Sample Request/Response

The code below (Python 3) shows how to retrieve a clipping profile's 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"
			self.headers = {"Content-Type": "application/json"}

			def run(self):
			"""dummy"""
			self._get_youtube_login_url()

			def _get_youtube_login_url(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.get(
			url,
			params=APIParams(APICredentials()).get_params(query_params),
			headers=self.headers,
			timeout=15
			)

			pp(response.json())

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