Each report contains number of report columns which have been crawled and profiled. This service deals with Report Columns related APIs.
1. Get Report Column by Report Id and Report Column name
This method returns Report Column by given Report and Report Column Name.
Mandatory Field: reportColumnName, reportId.
|
Method |
Url |
Parameter |
|
getReportColumnbyReportIdandColumnName |
/api/reportcolumn |
{reportColumnName},{reportId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"ReportColumn": {
"chartChildId": 1,
"chartId": 1002,
"childName": "SentimentGap_Coulmn1",
"businessGlossaryId": 0,
"description": "SentimentGap_Coulmn1",
"lastmoddate": 1579861342000,
"columnScore": 0,
"useScore": 6,
"displayEligible": 0,
"columnLength": 0,
"minval": null,
"maxval": null,
"nullCount": 0,
"distinctCount": 0,
"typeStats": null,
"topValues": null,
"mask": 0,
"restricted": 0,
"columnPosition": 0,
"lastMetaSyncDate": 1579861397000,
"active": 1,
"inaudit": 0,
"childType": "UFIELD",
"isInProject": null
}
}
}
2. Save Report Column
This method is deprecated. To create Report Column, you should use crawlers in OvalEdge application.
Save Report Column method creates a new Report Column with the given input through the Request Body.
Mandatory Field: businessDescription, connectionId, connectionName, domainName, globalDomain, glossaryName, reportID, reportName, technicalDescription, tagName.
| Method | URL |
| saveReportColumn | /api/reportcolumn |
Request Body
{
"active": 0, *
"columnDescription": "string",
"columnId": 0,
"columnName": "string",*
"columnType": "string",*
"reportId": 0 *
}
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"ReportColumn": {
"chartChildId": 4,
"chartId": 1002,
"childName": "SampleColumn",
"businessGlossaryId": null,
"description": "SampleColumnDescription",
"lastmoddate": null,
"columnScore": 0,
"useScore": 0,
"displayEligible": 0,
"columnLength": 0,
"minval": null,
"maxval": null,
"nullCount": 0,
"distinctCount": 0,
"typeStats": null,
"topValues": null,
"mask": 0,
"restricted": 0,
"columnPosition": 0,
"lastMetaSyncDate": null,
"active": 1,
"inaudit": 0,
"childType": "UFIELD",
"isInProject": null
}
}
}
3. Get Report Column by Id
This method returns the Report Column with the input Id if exists.
Mandatory Field: reportColumnId.
| Method | URL | Parameter |
| getReportColumnbyId | /api/reportcolumn/{reportColumnId} | {reportColumnId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"ReportColumn": {
"chartChildId": 2,
"chartId": 1002,
"childName": "SentimentGap_Column2",
"businessGlossaryId": 0,
"description": "SentimentGap_Column2",
"lastmoddate": 1579861458000,
"columnScore": 0,
"useScore": 6,
"displayEligible": 0,
"columnLength": 0,
"minval": null,
"maxval": null,
"nullCount": 0,
"distinctCount": 0,
"typeStats": null,
"topValues": null,
"mask": 0,
"restricted": 0,
"columnPosition": 0,
"lastMetaSyncDate": 1579861499000,
"active": 1,
"inaudit": 0,
"childType": "UFIELD",
"isInProject": null
}
}
}
4. Delete Report Column
This methods delete Report Column with the given input Id.
Mandatory Field: reportColumnId.
| Method | URL | Parameter |
| deleteReportColumn | /api/reportcolumn/{reportColumnId} | {reportColumnId} |
Response
{
"status": true,
"statusCode": "ReportColumn with id 4 is deleted",
"statusMsg": "",
"response": {}
}