Virima API Specification - FileService Services

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

Contents

1 uploadMicrosoftProjectAndAssociate FILE Interface
2 getAllPictures GET Interface
3 getAllServiceCatalogPictures GET Interface
4 uploadDocument FILE Interface
5 uploadSoftwareFile FILE Interface
6 uploadSoftwareFile FILE Interface
7 saveSoftwareLink POST Interface
8 getUploadedFiles GET Interface
9 detachFile POST Interface
10 uploadProfilePicture FILE Interface
11 uploadWorkflowPicture FILE Interface
12 downloadProfilePicture GET Interface
13 uploadITSMCategoryPicture FILE Interface
14 downloadITSMCategoryPicture GET Interface
15 uploadCIData FILE Interface
16 uploadTagsData FILE Interface
17 uploadScheduleScan FILE Interface
18 uploadCIAssetRelationship FILE Interface
19 uploadCIProperties FILE Interface
20 uploadRelationshipTypes FILE Interface
21 uploadITSMData FILE Interface
22 uploadSpiceworkData FILE Interface
23 getUploadedCIFiles GET Interface
24 deleteFile POST Interface
25 uploadPropertyFile FILE Interface
26 deletePropertyFile GET Interface
27 deleteCommentsAttachment POST Interface
28 uploadCategoryFile FILE Interface
29 uploadADZipFile FILE Interface
30 uploadExternalAlertFile FILE Interface
31 uploadChildAuditAttachment FILE Interface
32 uploadIDPMetaData FILE Interface
33 uploadAttachment FILE Interface
34 uploadCommentsAttachment FILE Interface
35 saveUploadCIData FILE Interface
36 getUploadedFilesForRunBook GET Interface
37 sendFileToApp FILE Interface
38 uploadCMDBProperties FILE Interface
39 uploadFileToTemp FILE Interface

uploadMicrosoftProjectAndAssociate FILE Interface

Method: FILE

Relative URL: file/upload-mpp-project

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
transactionMessage	TransactionMessage

Example Request:

Example Response:

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

getAllPictures GET Interface

Method: GET

Relative URL: file/get-all-pictures

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

getAllServiceCatalogPictures GET Interface

Method: GET

Relative URL: file/get-all-servicecatalog-pictures

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadDocument FILE Interface

Method: FILE

Relative URL: file/upload-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
responseMsg	TransactionMessage	The response

Example Request:

Example Response:

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

uploadSoftwareFile FILE Interface

Method: FILE

Relative URL: file/upload-software-file/version

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadSoftwareFile FILE Interface

Method: FILE

Relative URL: file/import-software-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

saveSoftwareLink POST Interface

Method: POST

Relative URL: file/save-software-link/version

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
link	DataInput	Link of software

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

SAVESOFTWARELINK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "dataValue":"?",
   "description":"?"
}

Example Response:

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

getUploadedFiles GET Interface

Method: GET

Relative URL: file/get-uploaded-files/entity-id/entity-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
responseMsg	ArrayAttachList	Array of files with fileId

Example Request:

Example Response:

{
   "id":1348100403,
   "customerId":"?",
   "userId":"?",
   "listFiles":[
      {
         "id":2147483647,
         "attachmentId":?,
         "name":"?",
         "fileName":"?",
         "entity":"?",
         "status":"?",
         "version":"?",
         "uploadedBy": {
               "id":1750503779,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "uploadedOn":?,
         "driveFileId":"?",
         "fileSize":?,
         "description":"?",
         "isRunBookAttachment":?
      }   ]
}

detachFile POST Interface

Method: POST

Relative URL: file/detach-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
attachFileList	ArrayAttachList

Response Structure:

Field Name	Type	Description
responseMsg	Response	Response

Example Request:

DETACHFILE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "customerId":"?",
   "userId":"?",
   "listFiles":[
      {
         "attachmentId":?,
         "name":"?",
         "fileName":"?",
         "entity":"?",
         "status":"?",
         "version":"?",
         "uploadedBy": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "uploadedOn":?,
         "driveFileId":"?",
         "fileSize":?,
         "description":"?",
         "isRunBookAttachment":?
      }   ]
}

Example Response:

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

uploadProfilePicture FILE Interface

Method: FILE

Relative URL: file/upload-profile-picture/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadWorkflowPicture FILE Interface

Method: FILE

Relative URL: file/upload-workflow-picture/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

downloadProfilePicture GET Interface

Method: GET

Relative URL: file/download-profile-picture/module/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadITSMCategoryPicture FILE Interface

Method: FILE

Relative URL: file/upload-itsm-category-picture/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

downloadITSMCategoryPicture GET Interface

Method: GET

Relative URL: file/download-itsm-category-picture/module/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadCIData FILE Interface

Method: FILE

Relative URL: file/upload-ci-data/module/template-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadTagsData FILE Interface

Method: FILE

Relative URL: file/upload-tags-data/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadScheduleScan FILE Interface

Method: FILE

Relative URL: file/upload-schedulescan-data

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadCIAssetRelationship FILE Interface

Method: FILE

Relative URL: file/upload-ci-asset-relationship

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadCIProperties FILE Interface

Method: FILE

Relative URL: file/upload-ci-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadRelationshipTypes FILE Interface

Method: FILE

Relative URL: file/upload-relationship-types

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadITSMData FILE Interface

Method: FILE

Relative URL: file/upload-itsm-data/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadSpiceworkData FILE Interface

Method: FILE

Relative URL: file/upload-spicework-data/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

getUploadedCIFiles GET Interface

Method: GET

Relative URL: file/get-uploaded-ci-files/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ArrayAttachList	Array of files with fileId

Example Request:

Example Response:

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

deleteFile POST Interface

Method: POST

Relative URL: file/delete-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
fileDetails	DataInput	Details of file(id and name)

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

DELETEFILE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "dataValue":"?",
   "description":"?"
}

Example Response:

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

uploadPropertyFile FILE Interface

Method: FILE

Relative URL: file/upload-property-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

deletePropertyFile GET Interface

Method: GET

Relative URL: file/delete-property-file/file-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

deleteCommentsAttachment POST Interface

Method: POST

Relative URL: file/delete-comments-attachment

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
attachmentId	RecordID

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

uploadCategoryFile FILE Interface

Method: FILE

Relative URL: file/upload-category-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadADZipFile FILE Interface

Service to upload the ucf ad zip file and extract it

Method: FILE

Relative URL: file/upload-ad-zip-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadExternalAlertFile FILE Interface

Method: FILE

Relative URL: file/upload-external-alert-file/name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadChildAuditAttachment FILE Interface

Method: FILE

Relative URL: file/upload-child-audit-attachment/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadIDPMetaData FILE Interface

Method: FILE

Relative URL: file/upload-idp-metadata/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadAttachment FILE Interface

Method: FILE

Relative URL: file/upload-attachment

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

uploadCommentsAttachment FILE Interface

Method: FILE

Relative URL: file/upload-comments-attachment

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

saveUploadCIData FILE Interface

Method: FILE

Relative URL: file/save-upload-ci-data/module/template-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

getUploadedFilesForRunBook GET Interface

Method: GET

Relative URL: file/get-uploaded-files-for-runbook/entity-id/entity-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
responseMsg	ArrayAttachList	Array of files with fileId

Example Request:

Example Response:

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

sendFileToApp FILE Interface

Method: FILE

Relative URL: file/send-file-to-app

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	TransactionMessage	The response

Example Request:

Example Response:

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

uploadCMDBProperties FILE Interface

Method: FILE

Relative URL: file/upload-cmdb-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

uploadFileToTemp FILE Interface

Method: FILE

Relative URL: file/upload-file-to-temp

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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