Get integration mappings

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/mappingAttr

Sample URLs

https://{api-url}/api/v2/tenants/msp_6/integrations/installed/INTG-733a25ef-cf39-4f4a-862f-7dd4f49e8650/mappingAttr?entity=INCIDENT

Integration Mapping helps to map third-party attributes with OpsRamp attributes for an efficient exchange of data.

Use Search Installed Integrations to fetch the list of installed integrations.

Query variables

Query Variables	Description
entity	Name of the entity to be mapped. Tickets integration supports the following entities to be mapped: INCIDENT SERVICEREQUEST CHANGE PROBLEM TASK Alerts integration supports the entity ALERT to be mapped.
name	OpsRamp mapping attribute name. Use Get Integration Mappable Properties to fetch the list of OpsRamp supported mapping attributes for an entity. Example: Assignee Group name, Priority
intgMode	Integration mode.Inbound - Entity data is sent from third-party application to OpsRamp.Outbound - Entity data is sent from OpsRamp to third-party application. Example: OUTBOUND, INBOUND

Status code

200 OK

Get integration mapping of an entity

Sample URL

https://{api-url}/api/v2/tenants/msp_6/integrations/installed/INTG-733a25ef-cf39-4f4a-862f-7dd4f49e8650/mappingAttr?entity=INCIDENT

Sample response

[{
		"name": "Assignee group name",
		"attrName": "incident.assigneeGroup.name",
		"thirdPartyAttrName": "group.name",
		"entityType": "INCIDENT",
		"thirdPartyEntityType": "INCIDENTS",
		"mode": "OUTBOUND",
		"attrValues": [{
			"attrValue": "Brocade Inc Users",
			"thirdPartyAttrValue": "brcIncOB"
		}]
	},
	{
		"name": "Status",
		"attrName": "incident.status.name",
		"thirdPartyAttrName": "State",
		"entityType": "INCIDENT",
		"thirdPartyEntityType": "INCIDENTS",
		"mode": "OUTBOUND",
		"attrValues": [{
			"attrValue": "Closed",
			"thirdPartyAttrValue": "Completed"
		}]
	},
	{
		"name": "Priority",
		"attrName": "incident.priority.name",
		"thirdPartyAttrName": "Level of Importance",
		"entityType": "INCIDENT",
		"thirdPartyEntityType": "INCIDENTS",
		"mode": "OUTBOUND",
		"attrValues": [{
			"attrValue": "Very Low",
			"thirdPartyAttrValue": "Low"
		}]
	},
	{
		"name": "Priority",
		"attrName": "incident.priority.name",
		"thirdPartyAttrName": "priority",
		"entityType": "INCIDENT",
		"thirdPartyEntityType": "INCIDENTS",
		"mode": "INBOUND",
		"attrValues": [{
			"attrValue": "Very Low",
			"thirdPartyAttrValue": "Low"
		}]
	}
]

Get integration mapping of an entity with integration mode

Sample URL

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-733r57ef-cf39-4f4a-862f-7dd4f49e8650/mappingAttr?entity=SERVICEREQUEST&intgMode=OUTBOUND

Sample response

[{
		"name": "Status",
		"attrName": "serviceRequest.status.name",
		"thirdPartyAttrName": "state",
		"entityType": "SERVICEREQUEST",
		"thirdPartyEntityType": "SERVICEREQUESTS",
		"mode": "OUTBOUND",
		"attrValues": [{
			"attrValue": "Closed",
			"thirdPartyAttrValue": "Completed"
		}]
	},
	{
		"name": "Priority",
		"attrName": "serviceRequest.priority.name",
		"thirdPartyAttrName": "Preference",
		"entityType": "SERVICEREQUEST",
		"thirdPartyEntityType": "SERVICEREQUESTS",
		"mode": "OUTBOUND",
		"attrValues": [{
			"attrValue": "Very Low",
			"thirdPartyAttrValue": "Low"
		}]
	}
]

Get integration mapping of an entity with mapping attribute name and integration mode

Sample URL

https://{api-url}/api/v2/tenants/client_9/integrations/installed/INTG-0da1a791-bc74-40af-8924-8932149a5790/mappingAttr?entity=INCIDENT&name=Status&intgMode=INBOUND

Sample response

[{
	"name": "Status",
	"attrName": "incident.status.name",
	"thirdPartyAttrName": "state",
	"entityType": "INCIDENT",
	"thirdPartyEntityType": "INCIDENTS",
	"mode": "INBOUND",
	"attrValues": [{
		"attrValue": "Closed",
		"thirdPartyAttrValue": "Completed"
	}]
}]