Dataminer wb return Parameter description

235 views
1
0 Comments

Hi all

I need to know if there is a way via dataminer web services to fetch the parameter description, I'm trying with the "GetAlarms" by using the filter object with the value "description" in the Columns array, but it didn't return nothing
I don't get if I'm using something wrong or I need to use another wb

Wout Mahieu [SLC] [DevOps Catalyst] Answered question

1 Answer

1
11.73K 9 Comments

Hi Marco,

You can get info about a parameter by using the GetParameter request in the JSON APIs. The response will contain all the info about the parameter: ID, name, description, ... . Note that ParameterName matches with the <Description> tag in the protocol.

Update:

This can also be retrieved along with the alarms using 'https://DMAIP/API/v1/Json.asmx/GetAlarms" with the following request body:

{
    "connection": "CONNECTION ID",
    "filter": {
        "__type": "Skyline.DataMiner.Web.Common.v1.DMAAlarmFilterV2",
        "FullAlarmTree": false,
        "InfoEvents": false,
        "Masked": false,
        "FilterItem": {
            "Match": true,
            "__type": "Skyline.DataMiner.Web.Common.v1.DMAAlarmFilterConstant"
        },
        "SortAscending": false,
        "SortBy": [
            "TimeOfArrival"
        ],
        "Limit": 100,
        "Search": null,
        "History": false,
        "Columns": [
            "Parameter"
        ]     }
}

Note that other filters can also be applied, the 'Parameter' column is the important property here.

Wout Mahieu [SLC] [DevOps Catalyst] Posted new comment
Marco Di Blasi commented

Hi Wout, thanks a lot for the answer, and sorry for the delay
Regarding what you say, the problem I need to retrive the information in one single call, this is why I tried to use the columns option to add more information, if I have to invoke the GetParameter API for each Alarm I need to inspect it will take too much
Wout Mahieu [SLC] [DevOps Catalyst] commented

If you are trying to retrieve the parameter via the "GetAlarms" call, you can use the value "Parameter" in the Columns of the filter. This will include the parameter name of the alarm in the response.
Marco Di Blasi commented

Hi Wout, do you have an example? I'm trying with the following filter, but without any luck
"filter": {
"History":false,
"InfoEvents": true,
"Columns": ["parameter"]
}

I was looking at at the list in this doc, but I neither see "parameter" as a valid value https://docs.dataminer.services/develop/webservices/WS_v1/WS_CustomDataTypes_v1/DMAAlarmFilterV2.html
Wout Mahieu [SLC] [DevOps Catalyst] commented

I have updated my answer with an example filter you can use. I will also make sure that the docs are updated to include all relevant columns.
Marco Di Blasi commented

Hi Wout, thanks a lot for the example, I'll try it!
Show 4 more comments
You are viewing 1 out of 1 answers, click here to view all answers.