Metadata

The Report Metadata API provides access to report meta-data like filter names, types, optionality, etc.

The developer can access the report meta-data using URL - http://<instanceurl>/oms/api/v1/report/{ResourceName}/meta, where {ResourceName} is the name used to create the report API.

No input is needed to invoke the metadata API. Sample response:

{
    "retrievals": [
        {
            "name": "TestModel.TestString",
            "sortable": false,
            "type": "STRING",
            "sampleValue": "sampleValue"
        },
        {
            "name": "TestModel.TestFloat",
            "sortable": false,
            "type": "FLOAT",
            "sampleValue": 123.4000015258789
        },
        {
            "name": "TestModel.TestDouble",
            "sortable": false,
            "type": "DOUBLE",
            "sampleValue": 123.4
        },
        {
            "name": "PTA.TestModel.TestLongField(DPA)",
            "sortable": false,
            "type": "LONG",
            "sampleValue": 12345
        },
        {
            "name": "TestModel.TestLongFieldB(DPB)",
            "sortable": false,
            "type": "LONG",
            "sampleValue": 12345
        },
        {
            "name": "TestModel.SiteName(SPT)",
            "sortable": false,
            "type": "STRING",
            "sampleValue": "sampleValue"
        },
        {
            "name": "PTA.TestModel.TestSiteAlias(EPT)",
            "sortable": false,
            "type": "STRING",
            "sampleValue": "sampleValue"
        }
    ],
    "pageSize": 50,
    "filters": [
        {
            "name": "TestModel.TestString",
            "type": "STRING",
            "sampleValue": "sampleValue",
            "required": false
        },
        {
            "name": "TestModel.TestLongField",
            "type": "LONG",
            "sampleValue": 12345,
            "required": false
        }
    ]
}     