Virima API Specification - JiraIntegrationService Services

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

Contents

1 getJiraCredential GET Interface
2 saveJiraCredential POST Interface
3 newgetJiraCredential GET Interface
4 loadJiraMeta POST Interface
5 verifyAndSaveJiraCredential POST Interface
6 deleteJiraCredential GET Interface
7 copyAllRecordsToJira POST Interface
8 getAllJiraObjSchemas GET Interface
9 getJiraObjTypes POST Interface
10 saveMappingForBlueprint POST Interface
11 getPickListPropertiesWithId POST Interface
12 getVirimaBlueprints GET Interface
13 getVirimaProperties POST Interface
14 getAllColumnNamesForTable POST Interface
15 getMappingDetails POST Interface
16 getAttributeValuesWithId POST Interface
17 isRedisKeyExisted GET Interface
18 resyncJiraData GET Interface
19 getSchemasFromJira GET Interface
20 getProjectIssuesTypesFromJira GET Interface
21 createSchemaInJira POST Interface
22 getLogsForCi GET Interface
23 saveMappingForServiceManagement POST Interface
24 getServiceManagementMapping GET Interface
25 deleteServiceManagementMapping POST Interface
26 getServiceManagementDetails GET Interface
27 getNewPropertiesOfAllIssuetypeFromJira GET Interface
28 getNewPropertiesOfIssuetypeFromJira POST Interface
29 jiraRedisKeyCheck GET Interface
30 resetDefaultMapping POST Interface
31 verifyAndSaveJiraVirimaAppCredential POST Interface
32 sendMailAndLogeGeneration POST Interface

getJiraCredential GET Interface

Method: GET

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	JiraCredential

Example Request:

Example Response:

{
   "id":2147483647,
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

saveJiraCredential POST Interface

Method: POST

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEJIRACREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

Example Response:

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

newgetJiraCredential GET Interface

Method: GET

Relative URL: jira-integration/new-get-jira-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	JiraCredential

Example Request:

Example Response:

{
   "id":2147483647,
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

loadJiraMeta POST Interface

Method: POST

Relative URL: jira-integration/load-jira-metadata

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

LOADJIRAMETA 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

Example Response:

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

verifyAndSaveJiraCredential POST Interface

Method: POST

Relative URL: jira-integration/verify-save-jira-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraCredential

Response Structure:

Field Name	Type	Description
response	JiraCredential

Example Request:

VERIFYANDSAVEJIRACREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

Example Response:

{
   "id":2147483647,
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

deleteJiraCredential GET Interface

Description: Delete jira credentials.

Method: GET

Relative URL: jira-integration/delete-jira-credential/record-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

copyAllRecordsToJira POST Interface

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

Method: POST

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

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:

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

getAllJiraObjSchemas GET Interface

Method: GET

Relative URL: jira-integration/get-all-jira-obj-schemas

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

getJiraObjTypes POST Interface

Method: POST

Relative URL: jira-integration/get-jira-obj-types

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraIDAndNameDetails

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETJIRAOBJTYPES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraIDValue":?,
   "jiraNameValue":"?"
}

Example Response:

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

saveMappingForBlueprint POST Interface

Method: POST

Relative URL: jira-integration/save-mappings

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
jiraMapping	JiraMapping

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGFORBLUEPRINT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "virimaBluePrinId":?,
   "virimaBluePrintName":"?",
   "jiraObjSchemaId":?,
   "jiraObjSchema":"?",
   "jiraObjTypeId":?,
   "jiraObjType":"?",
   "jiraChildId":?,
   "jiraChild":"?",
   "propertyMapping":"?",
   "isEnabled":?,
   "jiraMappingCondition":[
      {
         "jiraMappingId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?"
      }   ],
   "jiraObjTypeHierarchy":"?",
   "archive":?,
   "actualJiraObjType":"?"
}

Example Response:

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

getPickListPropertiesWithId POST Interface

Method: POST

Relative URL: jira-integration/get-picklist-with-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraIDAndNameDetails

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETPICKLISTPROPERTIESWITHID 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraIDValue":?,
   "jiraNameValue":"?"
}

Example Response:

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

getVirimaBlueprints GET Interface

Method: GET

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

getVirimaProperties POST Interface

Method: POST

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

getAllColumnNamesForTable POST Interface

Method: POST

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

getMappingDetails POST Interface

Method: POST

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

getAttributeValuesWithId POST Interface

Method: POST

Relative URL: jira-integration/get-attribute-values

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:

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

Example Response:

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

isRedisKeyExisted GET Interface

Method: GET

Relative URL: jira-integration/is-rediskey-existed

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

resyncJiraData GET Interface

Method: GET

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

getSchemasFromJira GET Interface

Method: GET

Relative URL: jira-integration/get-schemas-from-jira

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

getProjectIssuesTypesFromJira GET Interface

Method: GET

Relative URL: jira-integration/get-projects-issues-from-jira

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

createSchemaInJira POST Interface

Method: POST

Relative URL: jira-integration/create-schema-in-jira

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CREATESCHEMAINJIRA 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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

getLogsForCi GET Interface

Method: GET

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

saveMappingForServiceManagement POST Interface

Method: POST

Relative URL: jira-integration/save-mapping-for-servicemanagement/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
jiraIncidentAndChangeMapping	JiraIncidentAndChangeMapping

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAPPINGFORSERVICEMANAGEMENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "incidentMapping":"?",
   "changeMapping":"?"
}

Example Response:

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

getServiceManagementMapping GET Interface

Method: GET

Relative URL: jira-integration/get-service-management-mapping/module

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

deleteServiceManagementMapping POST Interface

Description: Delete service management mapping.

Method: POST

Relative URL: jira-integration/delete-service-management-mapping/module

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:

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

Example Response:

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

getServiceManagementDetails GET Interface

Method: GET

Relative URL: jira-integration/get-service-management-datails

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getNewPropertiesOfAllIssuetypeFromJira GET Interface

Method: GET

Relative URL: jira-integration/get-new-props-of-allissuetype-from-jira/module

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

getNewPropertiesOfIssuetypeFromJira POST Interface

Method: POST

Relative URL: jira-integration/get-new-props-of-issuetype-from-jira/module

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:

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

Example Response:

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

jiraRedisKeyCheck GET Interface

Method: GET

Relative URL: jira-integration/jira-redis-key-check

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

resetDefaultMapping POST Interface

Method: POST

Relative URL: jira-integration/reset-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:

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

Example Response:

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

verifyAndSaveJiraVirimaAppCredential POST Interface

Method: POST

Relative URL: jira-integration/verify-save-jira-virima-app-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	JiraCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

VERIFYANDSAVEJIRAVIRIMAAPPCREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "jiraDomain":"?",
   "jiraUsername":"?",
   "jiraApiKey":"?",
   "workSpaceId":"?",
   "selectedSchemas":"?",
   "selectedProjectIDs":"?",
   "selectedIncidentTypeIssues":"?",
   "selectedChangeTypeIssues":"?",
   "jiraProjectsAndIssueTypes":"?",
   "isMoveVirimaBlueprints":?,
   "assetManagement":?,
   "serviceManagement":?,
   "incidentIssuesBy":"?",
   "changeIssuesBy":"?",
   "doesJiraKeyExists":?,
   "fromJiraAPP":?
}

Example Response:

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

sendMailAndLogeGeneration POST Interface

Method: POST

Relative URL: jira-integration/send-mail-and-synclog-generation

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
props	IntegrationProps

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SENDMAILANDLOGEGENERATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userId":?,
   "customerId":?,
   "startTime":?,
   "statusMessage":"?",
   "moveId":"?",
   "action":"?"
}

Example Response:

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