Virima API Specification - IvantiIntegrationService Services

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

Contents

1 copyAllRecordsToIvanti POST Interface
2 getIvantiCredential GET Interface
3 saveIvantiCredential POST Interface
4 saveMappingsMultiple POST Interface
5 saveMappingForBlueprint POST Interface
6 getMappings GET Interface
7 getMappingDetails POST Interface
8 getAllIvantiBlueprintNames GET Interface
9 getAllIvantiBlueprintNamesIvanti GET Interface
10 getAllColumnNamesForTable POST Interface
11 getVirimaBlueprints GET Interface
12 getPicklist GET Interface
13 getIvantiBlueprints GET Interface
14 getIvantiCISubTypes GET Interface
15 getVirimaProperties POST Interface
16 getIvantiCICategory GET Interface
17 resyncIvantiData GET Interface
18 getRedisKeyForIvantiCred GET Interface
19 getSyncDetailsLogs GET Interface
20 getLogsForCi GET Interface
21 syncDefaultMapping POST Interface
22 addDuplicateMappings POST Interface
23 saveIvantiSubType POST Interface
24 saveBusinessObjectsForProperty GET Interface

copyAllRecordsToIvanti POST Interface

Description: Service to move all the selected records in cmdb to ivanti.

Method: POST

Relative URL: ivanti-integration/copy-all-records-to-ivanti

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getIvantiCredential GET Interface

Method: GET

Relative URL: ivanti-integration/get-ivanti-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	IvantiCredential

Example Request:

Example Response:

{
   "id":2147483647,
   "ivantiDomain":"?",
   "ivantiApiKey":"?"
}

saveIvantiCredential POST Interface

Method: POST

Relative URL: ivanti-integration/save-ivanti-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IvantiCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEIVANTICREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ivantiDomain":"?",
   "ivantiApiKey":"?"
}

Example Response:

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

saveMappingsMultiple POST Interface

Method: POST

Relative URL: ivanti-integration/save-mappings-multiple

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IvantiMappingArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGSMULTIPLE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mappingList":[
      {
         "virimaBpName":"?",
         "ivantiMappingCondition":[
            {
               "ivantiMappingId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?"
            }         ],
         "ivantiCIType":"?",
         "ivantiCISubType":"?",
         "ivantiCICategory":"?",
         "propertyMapping":"?",
         "isEnabled":?,
         "archive":?
      }   ]
}

Example Response:

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

saveMappingForBlueprint POST Interface

Method: POST

Relative URL: ivanti-integration/save-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IvantiMapping

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGFORBLUEPRINT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "virimaBpName":"?",
   "ivantiMappingCondition":[
      {
         "ivantiMappingId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?"
      }   ],
   "ivantiCIType":"?",
   "ivantiCISubType":"?",
   "ivantiCICategory":"?",
   "propertyMapping":"?",
   "isEnabled":?,
   "archive":?
}

Example Response:

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

getMappings GET Interface

Method: GET

Relative URL: ivanti-integration/get-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	IvantiMappingArray

Example Request:

Example Response:

{
   "id":2147483647,
   "mappingList":[
      {
         "id":2147483647,
         "virimaBpName":"?",
         "ivantiMappingCondition":[
            {
               "id":2147483647,
               "ivantiMappingId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?"
            }         ],
         "ivantiCIType":"?",
         "ivantiCISubType":"?",
         "ivantiCICategory":"?",
         "propertyMapping":"?",
         "isEnabled":?,
         "archive":?
      }   ]
}

getMappingDetails POST Interface

Method: POST

Relative URL: ivanti-integration/get-mapping-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getAllIvantiBlueprintNames GET Interface

Method: GET

Relative URL: ivanti-integration/get-all-ivanti-blueprint-names

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":"?"
}

getAllIvantiBlueprintNamesIvanti GET Interface

Method: GET

Relative URL: ivanti-integration/get-virima-blueprints-ivanti

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":"?"
}

getAllColumnNamesForTable POST Interface

Method: POST

Relative URL: ivanti-integration/get-all-column-names-table

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getVirimaBlueprints GET Interface

Method: GET

Relative URL: ivanti-integration/get-virima-blueprints

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getPicklist GET Interface

Method: GET

Relative URL: ivanti-integration/get-picklist

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getIvantiBlueprints GET Interface

Method: GET

Relative URL: ivanti-integration/get-ivanti-blueprints

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":"?"
}

getIvantiCISubTypes GET Interface

Method: GET

Relative URL: ivanti-integration/get-ivanti-ci-subtypes/ci-type

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":"?"
}

getVirimaProperties POST Interface

Method: POST

Relative URL: ivanti-integration/get-virima-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getIvantiCICategory GET Interface

Method: GET

Relative URL: ivanti-integration/get-ivanti-ci-category

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":"?"
}

resyncIvantiData GET Interface

Method: GET

Relative URL: ivanti-integration/resync-ivanti-data

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":"?"
}

getRedisKeyForIvantiCred GET Interface

Method: GET

Relative URL: ivanti-integration/get-redis-key-for-ivanti-cred

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":"?"
}

getSyncDetailsLogs GET Interface

Method: GET

Relative URL: ivanti-integration/get-sync-log-details/copy-start-time/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getLogsForCi GET Interface

Method: GET

Relative URL: ivanti-integration/get-logs-for-ci/main-ci/copy-start-time/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":"?"
}

syncDefaultMapping POST Interface

Method: POST

Relative URL: ivanti-integration/sync-default-mapping

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

addDuplicateMappings POST Interface

Method: POST

Relative URL: ivanti-integration/add-duplicate-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

saveIvantiSubType POST Interface

Method: POST

Relative URL: ivanti-integration/save-ivanti-subtype

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IvantiSubTypeDetails

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEIVANTISUBTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ivantiCIType":"?",
   "ivantiCISubType":"?"
}

Example Response:

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

saveBusinessObjectsForProperty GET Interface

Method: GET

Relative URL: ivanti-integration/save-business-objects-for-property/property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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