Datasets API - Get Metadata - RequestedParts

abhishekraghuraman
abhishekraghuraman Member
in Datasets

The documentation for the dataset-get-metadata endpoint here indicates that the "requestedParts" parameter can be used to specify which parts of the metadata are needed in the response. However, the documentation does not indicate list of accepted values. The sample request below also indicates a different param named "part". Can someone confirm the accepted list of values for this parameter?

I'm looking to retrieve both columns metadata and beast-mode calculation field metadata with this call.

Tagged:

Answers

  • brycec
    brycec Coach

    For that endpoint, I've always used the parameter includeAllDetails=true, instead of the parts that documentation mentions. However, that endpoint doesn't return columns or Beast Modes. For columns, use this endpoint: api/query/v1/datasources/<dataset_id>/schema/indexed?includeHidden=true. For Beast Modes, use this endpoint: api/query/v1/functions/search as a POST request with the following body:

    {
    
    "name": "",
    
    "filters": [
    
        {
    
            "field": "dataset",
    
            "idList": [
    
                "<dataset_id>"
    
            ]
    
        },
    
        {
    
            "field": "notvariable"
    
        }
    
    ],
    
    "sort": {
    
        "field": "name",
    
        "ascending": true
    
    },
    
    "limit": 5000,
    
    "offset": 0
    
}

    Was this comment helpful? Click Agree or Like below.
    Did this comment solve your problem? Accept it as the solution!

Categories