Virima API Specification - HelpDeskDashboardService Services

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

Contents

1 getDashboardDetails GET Interface
2 getAllOpenIncidents GET Interface
3 getAllOpenChanges GET Interface
4 getAllAwaitingIncidents GET Interface
5 getAllOpenRequests GET Interface
6 getAllAwaitingRequests GET Interface
7 getKnowledgeDashboardDetails GET Interface
8 getAllIncidentsBasedOnModelId GET Interface
9 getallEnduserFAQs GET Interface

getDashboardDetails GET Interface

get all dashboard details like announcements/ popular knowledges etc

Method: GET

Relative URL: helpdesk-dashboard/get-dashboard-details/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllOpenIncidents GET Interface

get open incidents dashboard details etc

Method: GET

Relative URL: helpdesk-dashboard/get-openincidents-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllOpenChanges GET Interface

get open changes dashboard details etc

Method: GET

Relative URL: helpdesk-dashboard/get-openchanges-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllAwaitingIncidents GET Interface

get awaiting incidents dashboard details etc

Method: GET

Relative URL: helpdesk-dashboard/get-awaitingincidents-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllOpenRequests GET Interface

get open requests dashboard details etc

Method: GET

Relative URL: helpdesk-dashboard/get-openrequests-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllAwaitingRequests GET Interface

get awaiting requests etc

Method: GET

Relative URL: helpdesk-dashboard/get-awaitingrequests-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getKnowledgeDashboardDetails GET Interface

get knowledge dashboard details etc

Method: GET

Relative URL: helpdesk-dashboard/get-knowledge-dashboard-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getAllIncidentsBasedOnModelId GET Interface

get all Incidents for the same model id

Method: GET

Relative URL: helpdesk-dashboard/get-all-incidents-on-modelid/limit/model-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
details	Response

Example Request:

Example Response:

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

getallEnduserFAQs GET Interface

Method: GET

Relative URL: helpdesk-dashboard/getall-faqs/role

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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