URL
POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/mappingAttr
This attribute mapping is not applicable for email integrations.
Sample URLs
https://{api-url}/api/v2/tenants/client_5/agentPolicies/1/devices
Parameters
Both fields are mandatory:
Field | Sub-Fields | Data Type | Values | Description |
---|---|---|---|---|
inboundConfig | Map attributes | |||
1. name | String | NA | OpsRamp attribute name. | |
2. tenantAttrName | String | NA | Third party attribute name. | |
3. entityType | String | ALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASK | OpsRamp entity type. | |
4. tenantEntityType | String | NA | Third-party entity type. | |
5. attrValues
| String | NA | Mapping attribute values:
| |
outboundConfig | Map attributes | |||
1. name | String | NA | OpsRamp attribute name. | |
2. tenantAttrName | String | NA | Third-party attribute name. | |
3. entityType | String | ALERT, PROBLEM, INCIDENT, CHANGE,SERVICEREQUEST, TASK | OpsRamp entity type. | |
4. tenantEntityType | String | NA | Third-party entity type. | |
5. attrValues
| String | NA | Mapping attribute values:
|
NA indicates that the value is not applicable.
Create or update installed integration with inbound mappings
Sample URL
https://{api-url}/api/v2/tenants/client_9/integrations/installed/INTG-99fb8b36-0dcc-4486-ad59-8b24395d5a86/mappingAttr
Sample request
{
"inboundConfig": {
"mapAttributes": [{
"name": "Status",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
},
{
"attrValue": "New",
"thirdPartyAttrValue": "New"
},
{
"attrValue": "On Hold",
"thirdPartyAttrValue": "Delay"
},
{
"attrValue": "Pending",
"thirdPartyAttrValue": "In Line"
},
{
"attrValue": "Resolved",
"thirdPartyAttrValue": "Fixed"
}
]
},
{
"name": "Priority",
"thirdPartyAttrName": "severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Important"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minor"
},
{
"attrValue": "Normal",
"thirdPartyAttrValue": "Major"
},
{
"attrValue": "Urgent",
"thirdPartyAttrValue": "V. Important"
},
{
"attrValue": "Very Low",
"thirdPartyAttrValue": "Low"
}
]
}
]
}
}
Sample response
[
{
"name": "Status",
"attrName": "serviceRequest.status.name",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
},
{
"attrValue": "New",
"thirdPartyAttrValue": "New"
},
{
"attrValue": "On Hold",
"thirdPartyAttrValue": "Delay"
},
{
"attrValue": "Pending",
"thirdPartyAttrValue": "In Line"
},
{
"attrValue": "Resolved",
"thirdPartyAttrValue": "Fixed"
}
]
},
{
"name": "Priority",
"attrName": "serviceRequest.priority.name",
"thirdPartyAttrName": "severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Important"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minor"
},
{
"attrValue": "Normal",
"thirdPartyAttrValue": "Major"
},
{
"attrValue": "Urgent",
"thirdPartyAttrValue": "V. Important"
},
{
"attrValue": "Very Low",
"thirdPartyAttrValue": "Low"
}
]
}
]
Create or update installed integration with outbound mappings
Sample URL
https://{api-url}/api/v2/tenants/client_9/integrations/installed/INTG-99fb8b36-0dcc-4486-ad59-8b24395d5a86/mappingAttr
Sample request
{
"outboundConfig": {
"mapAttributes": [{
"name": "Status",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
},
{
"attrValue": "New",
"thirdPartyAttrValue": "New"
},
{
"attrValue": "On Hold",
"thirdPartyAttrValue": "Delay"
},
{
"attrValue": "Pending",
"thirdPartyAttrValue": "In Line"
},
{
"attrValue": "Resolved",
"thirdPartyAttrValue": "Fixed"
}
]
},
{
"name": "Priority",
"thirdPartyAttrName": "severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Important"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minor"
},
{
"attrValue": "Normal",
"thirdPartyAttrValue": "Major"
},
{
"attrValue": "Urgent",
"thirdPartyAttrValue": "V. Important"
},
{
"attrValue": "Very Low",
"thirdPartyAttrValue": "Low"
}
]
}
]
}
}
Sample response
[
{
"name": "Status",
"attrName": "serviceRequest.status.name",
"thirdPartyAttrName": "Status",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "Open",
"thirdPartyAttrValue": "In Progress"
},
{
"attrValue": "Closed",
"thirdPartyAttrValue": "Completed"
},
{
"attrValue": "New",
"thirdPartyAttrValue": "New"
},
{
"attrValue": "On Hold",
"thirdPartyAttrValue": "Delay"
},
{
"attrValue": "Pending",
"thirdPartyAttrValue": "In Line"
},
{
"attrValue": "Resolved",
"thirdPartyAttrValue": "Fixed"
}
]
},
{
"name": "Priority",
"attrName": "serviceRequest.priority.name",
"thirdPartyAttrName": "severity",
"entityType": "SERVICEREQUEST",
"thirdPartyEntityType": "SRQ",
"attrValues": [{
"attrValue": "High",
"thirdPartyAttrValue": "Important"
},
{
"attrValue": "Low",
"thirdPartyAttrValue": "Minor"
},
{
"attrValue": "Normal",
"thirdPartyAttrValue": "Major"
},
{
"attrValue": "Urgent",
"thirdPartyAttrValue": "V. Important"
},
{
"attrValue": "Very Low",
"thirdPartyAttrValue": "Low"
}
]
}
]