Virima API Specification - ReportDashBoardService Services

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

Contents

1 getRepsInDBoardForEntity GET Interface
2 delRepsInDBoardForEntity POST Interface
3 getReportsMyItems GET Interface
4 getDefaultReportsMyItems GET Interface
5 publishReportsMyItems POST Interface
6 deleteReportsMyItems POST Interface
7 deleteDefaultReportsMyItems GET Interface
8 saveReportInDashboard POST Interface
9 getAllReportInDashboard GET Interface
10 delCalendarInDashboard GET Interface
11 refreshKPI GET Interface

getRepsInDBoardForEntity GET Interface

Method: GET

Relative URL: report-dashboard/get/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
repIdList	Response

Example Request:

Example Response:

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

delRepsInDBoardForEntity POST Interface

Method: POST

Relative URL: report-dashboard/delete

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
delRepInDBoard	DelRepInDBoard

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELREPSINDBOARDFORENTITY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entity":"?",
   "reportIdList":[
      {
         "flag":?
      }   ]
}

Example Response:

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

getReportsMyItems GET Interface

Get all reports published in my items dashboard

Method: GET

Relative URL: report-dashboard/get-my-items

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
repIdList	Response

Example Request:

Example Response:

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

getDefaultReportsMyItems GET Interface

Get all default reports published in my items dashboard

Method: GET

Relative URL: report-dashboard/get-default-my-items

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
repIdList	Response

Example Request:

Example Response:

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

publishReportsMyItems POST Interface

Publish reports into my items dashboard

Method: POST

Relative URL: report-dashboard/publish-my-items

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reportIdList	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

PUBLISHREPORTSMYITEMS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "flag":?
      }   ]
}

Example Response:

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

deleteReportsMyItems POST Interface

Method: POST

Relative URL: report-dashboard/delete-my-items

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
delRepInDBoard	DelRepInDBoard

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEREPORTSMYITEMS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entity":"?",
   "reportIdList":[
      {
         "flag":?
      }   ]
}

Example Response:

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

deleteDefaultReportsMyItems GET Interface

Method: GET

Relative URL: report-dashboard/delete-default-my-items/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

saveReportInDashboard POST Interface

Method: POST

Relative URL: report-dashboard/save-report-dashboard/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reportList	IntegerIds

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEREPORTINDASHBOARD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "scopeId":?,
   "width":"?",
   "flag":?,
   "calendar":"?"
}

Example Response:

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

getAllReportInDashboard GET Interface

Method: GET

Relative URL: report-dashboard/get-all-report-dashboard/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

delCalendarInDashboard GET Interface

Method: GET

Relative URL: report-dashboard/delete-calendar/entity/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

refreshKPI GET Interface

Method: GET

Relative URL: report-dashboard/refresh-kpi/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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