Virima API Specification - SoftwareMetricsService Services

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

Contents

1 addSoftwareMetrics POST Interface
2 getSoftwareMetricsTopLevel POST Interface
3 getSoftwareMetricsSystemLevel POST Interface
4 getSoftwareMetricsDayLevel POST Interface
5 exportToExcel POST Interface

addSoftwareMetrics POST Interface

Method: POST

Relative URL: software-metrics/add-software-metrics

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	SoftwareMetrics

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

ADDSOFTWAREMETRICS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "agentId":"?",
   "clientSessionId":"?",
   "reportTime":?,
   "softwareMetrics":[
      {
         "majorSoftware":?,
         "majorSoftwareName":"?",
         "agentId":"?",
         "cmdbCi":?,
         "cmdbCiAssetName":"?",
         "usageCount":?,
         "totalUsedTime":?,
         "totalElapsedTime":?,
         "reportTime":?,
         "startDate":?,
         "endDate":?,
         "pid":?,
         "user":"?",
         "metricsType":"?"
      }   ],
   "timeZone":"?"
}

Example Response:

{
   "id":60297232,
   "recordId":"?",
   "message":"?",
   "status":?
}

getSoftwareMetricsTopLevel POST Interface

Method: POST

Relative URL: software-metrics/get-software-metrics-top-level/time-span

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	KeyValue

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETSOFTWAREMETRICSTOPLEVEL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "toDate":?,
   "fromDate":?
}

Example Response:

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

getSoftwareMetricsSystemLevel POST Interface

Method: POST

Relative URL: software-metrics/get-software-metrics-system-level/software-id/time-span

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	KeyValue

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETSOFTWAREMETRICSSYSTEMLEVEL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "toDate":?,
   "fromDate":?
}

Example Response:

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

getSoftwareMetricsDayLevel POST Interface

Method: POST

Relative URL: software-metrics/get-software-metrics-day-level/software-id/ci-id/time-span

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	KeyValue

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETSOFTWAREMETRICSDAYLEVEL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "toDate":?,
   "fromDate":?
}

Example Response:

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

exportToExcel POST Interface

Method: POST

Relative URL: software-metrics/software-metrics-export

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
exportData	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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