Virima API Specification - MajorSoftwareService Services

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

Contents

1 getAllMajorSoftwares GET Interface
2 editMajorSoftware POST Interface
3 addAsMajorSoftware POST Interface
4 sendSwMonitorRequestsToAgent GET Interface

getAllMajorSoftwares GET Interface

Method: GET

Relative URL: majorsoftware/get-all-major-softwares

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
allSoftwares	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":1239512737,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

editMajorSoftware POST Interface

Method: POST

Relative URL: majorsoftware/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
majorsoftware	MajorSoftware

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITMAJORSOFTWARE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "majorSoftwareName":"?",
   "majorSoftwareNameForLinux":"?",
   "isWindows":"?",
   "isLinux":?,
   "isBoth":?,
   "version":"?",
   "OsType":"?",
   "configFileWindows":"?",
   "configFileUnix":"?",
   "searchDirectoryWindows":"?",
   "searchDirectoryUnix":"?",
   "processName":"?",
   "processNameForLinux":"?",
   "monitorSoftwareUsage":?,
   "archive":?,
   "installedPathForWindows":"?",
   "installedPathForLinux":"?"
}

Example Response:

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

addAsMajorSoftware POST Interface

Method: POST

Relative URL: majorsoftware/add-as-major-software/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
idList	ArrayOfInteger

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDASMAJORSOFTWARE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "idlist":[
      {
      }   ]
}

Example Response:

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

sendSwMonitorRequestsToAgent GET Interface

Method: GET

Relative URL: majorsoftware/send-sw-monitor-requests-to-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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