> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Check data meta data

POST https://device.example.com:443/cluster1/vos-api/configure/v1/validate_data_metadata
Content-Type: application/json

Check if missing data meta data in source.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/configure-source/check-data-meta-data

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.configure.model.source.DataGrooming.

- `ccConversionMode` (enum, optional) — Prefered Closed Caption type
  - Allowed values: `AUTO`, `EIA608`, `CEA708`
- `st2038Tracks` (list of com.harmonicinc.vos.app.configure.model.source.St2038Track, optional) — ANC data tracks in ST-2038 PID
- `teletextSubtitleMode` (enum, optional) — Teletext subtitle parsing mode
  - Allowed values: `EBU_TELETEXT`, `CAVENA_P31`
- `tracks` (list of com.harmonicinc.vos.app.configure.model.source.DataTrack, optional) — Essential metadata of data tracks

## Response

### 200

Success

### 201

Created

## Errors

### 400 Bad Request Error

Missing grooming info

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Types

### com.harmonicinc.vos.app.configure.model.source.St2038Track

- `labels` (list of string, optional) — Labels identifier of the data stream
- `lineNumber` (list of integer, optional) — Specifies the line(s) where the data is embedded
- `scte104OverrideDidSdid` (enum, optional) — When STBmode == STBP_MBR_DPI_PROPRIETARY, SCTE-104 will be decoded from VANC packets with DID == 0x45 and SDID 0x01, INSTEAD of the SCTE-104 standard DID == 0x41 and SDID 0x07
  - Allowed values: `e_41_07`, `e_45_01`
- `sourceFormat` (enum, optional) — Format of the ANC data
  - Allowed values: `SCTE_104`, `OP_47`, `SMPTE_2031`, `AFD`, `VITC`, `CLOSED_CAPTION`
- `teletextDescriptions` (list of com.harmonicinc.vos.app.configure.model.source.TeletextDescription, optional) — Descriptions of teletext components in source
- `teletextMode` (enum, optional) — Specifies which teletext mode is used
  - Allowed values: `NORMAL`, `LOW_DELAY`

### com.harmonicinc.vos.app.configure.model.source.DataTrack

- `countryCode` (string, optional) — Optional Country Code to append to the Language Code
- `dataTrackStreamType` (integer, optional) — Type of the data stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types
- `dpiPidIndex` (integer, optional) — This parameter enables out-of-band SCTE-104, and provides the associated dpi_pid_index. When out-of-band SCTE-104 is enabled, in-band input SCTE-35 messages are discarded
- `dtmfSettings` (com.harmonicinc.vos.app.configure.model.source.DtmfSettings, optional)
- `labels` (list of string, optional) — Labels identifier of the data stream
- `ocrConversionBackgroundColor` (string, optional) — Specifies DVB Subtitles background color for OCR conversion
- `pid` (integer, optional) — PID of the stream
- `ptsSettings` (com.harmonicinc.vos.app.configure.model.source.PtsSettings, optional)
- `skipProcessing` (boolean, optional) — Indicate this data stream will not be processed and will not be mux.
- `streamName` (string, optional) — Custom stream name
- `teletextToDvbSubsSetting` (com.harmonicinc.vos.app.configure.model.source.TeletextToDvbSubsSetting, optional)

### com.harmonicinc.vos.app.configure.model.source.TeletextDescription

- `teletextHexPageNum` (string, required) — Teletext page number in hexadecimal format. Range: Hex 0x100 - 0x8FF
- `language` (enum, optional) — Teletext language. default:English
  - Allowed values: `ENG`, `DEU`, `SWE`, `FIN`, `HUN`, `ITA`, `FRA`, `POR`, `SPA`, `CES`, `SLK`, `POL`, `TUR`, `SRP`, `HRV`, `SLV`, `RON`, `EST`, `LAV`, `LIT`, `RUS`, `BUL`, `UKR`, `ELL`, `ARA`, `HEB`
- `teletextType` (integer, optional) — Teletext type. Initial Teletext page, Teletext Subtitle Page, Additional Information Page, Hearing Impaired, Program Schdule Page

### com.harmonicinc.vos.app.configure.model.source.DtmfSettings

- `audioSourceLabel` (string, required) — Label of audio track carrying the DTMF signal
- `profiles` (list of com.harmonicinc.vos.app.configure.model.source.DtmfProfile, required) — List of DTMF profiles (min. 1, max. 6)

### com.harmonicinc.vos.app.configure.model.source.PtsSettings

- `mode` (enum, required) — e_PASSTHROUGH (default) or e_GENERATE. When e_GENERATE is selected, the input PTS is discarded, and the output PTS is automatically generated.
  - Allowed values: `e_PASSTHROUGH`, `e_GENERATE`
- `delayAdjustment` (integer, optional) — Specifies the data delay in millisecond in order to synchronize with the video stream, range -1250ms to 15000ms, default 0. Applicable to each mode.

### com.harmonicinc.vos.app.configure.model.source.TeletextToDvbSubsSetting

- `ancillaryPageId` (integer, required) — Ancillary Page Id, default: 0, range: 0-255
- `font` (string, required) — Font name, default: DejaVuSans.ttf. Value is the file name including dot-extension. Special case 'dejavu' mapped to 'DejaVuSans.ttf' internally.
- `forceDDS` (boolean, required) — Force DDS, default: false
- `language` (string, required) — Language, default:English
- `latency` (integer, required) — Latency in ms, default: 500, range: 40-1000 ms
- `pageId` (integer, required) — Page Id, default: 0, range: 0-255
- `pageNumber` (integer, required) — Page Number, default: 256, range: 256 - 2201, For reference in Hex 0x100 - 0x899
- `teletextTimeout` (integer, required) — Teletext Timeout in ms, default: 10, range: 0-9999 ms
- `transparencyLevel` (integer, required) — Transparency Level, default: 0, range: 0-100

### com.harmonicinc.vos.app.configure.model.source.DtmfProfile

- `command` (string, required) — 6-character command string built from the character set [0-9,*,#].
- `duration` (integer, required) — For duration-based splice points, duration time in milliseconds.
- `preRollTime` (integer, required) — For normal splices points, pre-roll time in milliseconds, within range [4000, 25000], default: 4000.
- `spliceMode` (enum, required) — Splice mode: NO_DURATION, AUTO_RETURN, NO_AUTO_RETURN
  - Allowed values: `NO_DURATION`, `AUTO_RETURN`, `NO_AUTO_RETURN`
- `spliceType` (enum, required) — Splice type: START_NORMAL, START_IMMEDIATE, END_NORMAL, END_IMMEDIATE
  - Allowed values: `START_NORMAL`, `START_IMMEDIATE`, `END_NORMAL`, `END_IMMEDIATE`

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/validate_data_metadata")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```