Virima API Specification - ImportCIService Services

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

Contents

1 addRecord POST Interface
2 addCIAssetRelationship POST Interface
3 addTemplate POST Interface
4 deleteImportedParent POST Interface
5 deleteImportedFile GET Interface
6 getCMDBDifferences GET Interface
7 getImportedFileDetails GET Interface
8 getMappingForSelectedTemplate GET Interface
9 getAllImportTemplates GET Interface

addRecord POST Interface

Method: POST

Relative URL: import-ci/add-record

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDRECORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

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

addCIAssetRelationship POST Interface

Method: POST

Relative URL: import-ci/add-ci-asset-relationship

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDCIASSETRELATIONSHIP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

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

addTemplate POST Interface

Method: POST

Relative URL: import-ci/add-template

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCITemplate

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDTEMPLATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "createdOn":?,
   "name":"?",
   "propertyMappings":"?",
   "archive":?
}

Example Response:

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

deleteImportedParent POST Interface

Method: POST

Relative URL: import-ci/delete

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
importedItem	DiscoveryIDs

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEIMPORTEDPARENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1944458282,
   "recordId":"?",
   "scanID":?
}

Example Response:

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

deleteImportedFile GET Interface

Method: GET

Relative URL: import-ci/delete-file/file-id

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

getCMDBDifferences GET Interface

Method: GET

Relative URL: import-ci/get-cmdb-differences/id

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

getImportedFileDetails GET Interface

Method: GET

Relative URL: import-ci/get-imported-file/file-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	AttachmentPojo

Example Request:

Example Response:

{
   "id":2147483647,
   "attachmentId":?,
   "name":"?",
   "fileName":"?",
   "entity":"?",
   "status":"?",
   "version":"?",
   "uploadedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uploadedOn":?,
   "driveFileId":"?",
   "fileSize":?,
   "description":"?",
   "isRunBookAttachment":?
}

getMappingForSelectedTemplate GET Interface

Method: GET

Relative URL: import-ci/get-mapping-for-selected-template/template-id

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

getAllImportTemplates GET Interface

Method: GET

Relative URL: import-ci/get-import-templates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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