Virima API Specification - ReportPresentationService Services

The requests documented in this section are directed to ReportPresentationService resources, which represent .

Contents

1 editReportPresentation POST Interface
2 getReportPresentation POST Interface
3 saveDuration POST Interface
4 generateReportPresentation POST Interface

editReportPresentation POST Interface

Method: POST

Relative URL: report-presentation/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
repPresentation	ReportPresentation

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITREPORTPRESENTATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "reportId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "title":"?",
   "typeOfGraph":"?",
   "xAxis":"?",
   "yAxis":"?",
   "duration":"?",
   "cannedProperty":"?",
   "presentByGroup":"?",
   "series":"?",
   "selectAll":?,
   "isDisplayInDashboard":?,
   "tableName":"?",
   "entity":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getReportPresentation POST Interface

Method: POST

Relative URL: report-presentation/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reportId	ID

Response Structure:

Field Name	Type	Description
repPresentation	ReportPresentation

Example Request:

GETREPORTPRESENTATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "flag":?
}

Example Response:

{
   "id":2147483647,
   "reportId": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "title":"?",
   "typeOfGraph":"?",
   "xAxis":"?",
   "yAxis":"?",
   "duration":"?",
   "cannedProperty":"?",
   "presentByGroup":"?",
   "series":"?",
   "selectAll":?,
   "isDisplayInDashboard":?,
   "tableName":"?",
   "entity":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

saveDuration POST Interface

Method: POST

Relative URL: report-presentation/save-duration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ReportPresentation

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEDURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "reportId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "title":"?",
   "typeOfGraph":"?",
   "xAxis":"?",
   "yAxis":"?",
   "duration":"?",
   "cannedProperty":"?",
   "presentByGroup":"?",
   "series":"?",
   "selectAll":?,
   "isDisplayInDashboard":?,
   "tableName":"?",
   "entity":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

generateReportPresentation POST Interface

Method: POST

Relative URL: report-presentation/generate-report

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
genRepPresentation	ReportPresentation

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GENERATEREPORTPRESENTATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "reportId": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "title":"?",
   "typeOfGraph":"?",
   "xAxis":"?",
   "yAxis":"?",
   "duration":"?",
   "cannedProperty":"?",
   "presentByGroup":"?",
   "series":"?",
   "selectAll":?,
   "isDisplayInDashboard":?,
   "tableName":"?",
   "entity":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}