​

ves-io-schema-shape-data_delivery-CustomAPI-GetDataDictionary

Published April 5, 2023 | Last modified June 26, 2025

Examples of performing data_delivery CustomAPI GetDataDictionary

Usecase:

Get Data dictionary

Request:

Request using vesctl:

vesctl request rpc data_delivery.CustomAPI.GetDataDictionary -i request.yaml --uri /public/namespaces/system/datadictionary/dataset --http-method GET

where file request.yaml has following contents:

dataset: di_advanced
Copied!

vesctl yaml response:

featureList:
- dataFormat: string
  description: Test description
  featureName: Test Feature
  isNewField: true
  required: true
Copied!

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build336959812_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/data-intelligence/namespaces/system/datadictionary/dataset?dataset=di_advanced'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 219
Content-Type: application/json
Date: Thu, 26 Jun 2025 23:56:08 GMT
Vary: Accept-Encoding

{
  "feature_list": [
    {
      "feature_name": "Test Feature",
      "data_format": "string",
      "required": true,
      "notes": "",
      "is_new_field": true,
      "description": "Test description"
    }
  ]
}
Copied!
On this page: