Virima API Specification - CherwellIntegrationService Services

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

Contents

1 copyAllRecordsToCherwell POST Interface
2 getCherwellCredential GET Interface
3 saveCherwellCredential POST Interface
4 saveMappingsMultiple POST Interface
5 saveMappingForBlueprint POST Interface
6 getMappings GET Interface
7 getMappingDetails POST Interface
8 getRedisKeyForCherwellCred GET Interface
9 getAllCherwellBlueprintNames GET Interface
10 getAllColumnNamesForTable POST Interface
11 getVirimaBlueprints GET Interface
12 getCherwellBlueprints GET Interface
13 getVirimaProperties POST Interface
14 resyncCherwellData GET Interface
15 syncDefaultMapping POST Interface
16 abortSync GET Interface

copyAllRecordsToCherwell POST Interface

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

Method: POST

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

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:

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

getCherwellCredential GET Interface

Method: GET

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	CherwellCredential

Example Request:

Example Response:

{
   "id":2147483647,
   "cherwellUserName":"?",
   "cherwellPassword":"?",
   "cherwellDomain":"?",
   "cherwellApiKey":"?",
   "accessToken":"?",
   "accessType":"?",
   "integrationEnabled":?
}

saveCherwellCredential POST Interface

Method: POST

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CherwellCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVECHERWELLCREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "cherwellUserName":"?",
   "cherwellPassword":"?",
   "cherwellDomain":"?",
   "cherwellApiKey":"?",
   "accessToken":"?",
   "accessType":"?",
   "integrationEnabled":?
}

Example Response:

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

saveMappingsMultiple POST Interface

Method: POST

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CherwellMappingArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGSMULTIPLE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mappingList":[
      {
         "virimaBlueprintName":"?",
         "cherwellBlueprintDisplayName":"?",
         "cherwellBlueprintInternalName":"?",
         "cherwellBlueprintObjectId":"?",
         "propertyMapping":"?",
         "isEnabled":?,
         "cherwellMappingCondition":[
            {
               "cherwellMappingId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?"
            }         ],
         "archive":?
      }   ]
}

Example Response:

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

saveMappingForBlueprint POST Interface

Method: POST

Relative URL: cherwell-integration/save-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CherwellMapping

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGFORBLUEPRINT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "virimaBlueprintName":"?",
   "cherwellBlueprintDisplayName":"?",
   "cherwellBlueprintInternalName":"?",
   "cherwellBlueprintObjectId":"?",
   "propertyMapping":"?",
   "isEnabled":?,
   "cherwellMappingCondition":[
      {
         "cherwellMappingId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?"
      }   ],
   "archive":?
}

Example Response:

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

getMappings GET Interface

Method: GET

Relative URL: cherwell-integration/get-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	CherwellMappingArray

Example Request:

Example Response:

{
   "id":2147483647,
   "mappingList":[
      {
         "id":2147483647,
         "virimaBlueprintName":"?",
         "cherwellBlueprintDisplayName":"?",
         "cherwellBlueprintInternalName":"?",
         "cherwellBlueprintObjectId":"?",
         "propertyMapping":"?",
         "isEnabled":?,
         "cherwellMappingCondition":[
            {
               "id":2147483647,
               "cherwellMappingId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?"
            }         ],
         "archive":?
      }   ]
}

getMappingDetails POST Interface

Method: POST

Relative URL: cherwell-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":1146041837,
   "response":"?"
}

getRedisKeyForCherwellCred GET Interface

Method: GET

Relative URL: cherwell-integration/get-redis-key-for-cherwell-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":"?"
}

getAllCherwellBlueprintNames GET Interface

Method: GET

Relative URL: cherwell-integration/get-all-cherwell-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":896355145,
   "response":"?"
}

getAllColumnNamesForTable POST Interface

Method: POST

Relative URL: cherwell-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: cherwell-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":1979592251,
   "response":"?"
}

getCherwellBlueprints GET Interface

Method: GET

Relative URL: cherwell-integration/get-cherwell-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":"?"
}

getVirimaProperties POST Interface

Method: POST

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

resyncCherwellData GET Interface

Method: GET

Relative URL: cherwell-integration/resync-cherwell-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":"?"
}

syncDefaultMapping POST Interface

Method: POST

Relative URL: cherwell-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":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

abortSync GET Interface

Method: GET

Relative URL: cherwell-integration/abort-sync/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":227370807,
   "response":"?"
}