Manage Installed Integration Mapping Attributes

Creates, updates,gets and removes installed integration mapping attributes. This attribute mapping is not applicable for email integrations.

Notes

  • During update only the attribute value get updates
  • Any update in user mapping attribute will create a new attribute
  • User needs to delete mapping to renew mapping attribute

Path Parameters

  • tenantIdstringrequired

    Describes the tenantId of the tenant

  • installedIntgIdstringrequired

    Unique Identifier of the installed integration

Query Parameters

  • entitystring

    Describes the entity name of the mappable properties

    Enum:
    ALERTPROBLEMINCIDENTCHANGESERVICEREQUESTTASKUSERUSERGROUP

Responses

  • namestring

    OpsRamp attribute name.

    Enum:
    RolePhonePrimary EmailTime ZoneMobile NumberDesignationFirst NameCountryLast NameStatusPriorityAlert stateAlert resource host nameAssignee group nameAlert resource nameAlert descriptionAlert subjectAlert metricAlert time
  • entityTypestring

    OpsRamp entity type.

    Enum:
    ALERTPROBLEMINCIDENTCHANGESERVICEREQUESTTASKUSERUSERGROUP
  • attrNamestring

    Enum:
    incident.assigneeGroup.nameincident.priority.nameuser.roleuser.countryuser.designationuser.emailuser.firstNameuser.lastNameuser.mobileNumberuser.phoneNumberuserGroup.roleserviceRequest.status.nameserviceRequest.priority.nameincident.status.namealert.currentStatealert.resource.hostNameuser.timeZonealert.deviceNamealert.descriptionalert.subjectalert.serviceNamealert.alertTime
  • thirdPartyAttrNamestring

    Third-party attribute name.

  • thirdPartyEntityTypestring

    Third-party entity type.

  • attrValuesarray

    Mapping attribute values:

  • modestring

    Enum:
    INBOUNDOUTBOUND
  • parsingPropertyobject

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the tenantId of the tenant

  • installedIntgIdstringrequired

    Unique Identifier of the installed integration

Request Body

application/json

  • inboundConfigobject

  • outboundConfigobject

Loading Examples...

Responses

  • namestring

    OpsRamp attribute name.

    Enum:
    RolePhonePrimary EmailTime ZoneMobile NumberDesignationFirst NameCountryLast NameStatusPriorityAlert stateAlert resource host nameAssignee group nameAlert resource nameAlert descriptionAlert subjectAlert metricAlert time
  • entityTypestring

    OpsRamp entity type.

    Enum:
    ALERTPROBLEMINCIDENTCHANGESERVICEREQUESTTASKUSERUSERGROUP
  • attrNamestring

    Enum:
    incident.assigneeGroup.nameincident.priority.nameuser.roleuser.countryuser.designationuser.emailuser.firstNameuser.lastNameuser.mobileNumberuser.phoneNumberuserGroup.roleserviceRequest.status.nameserviceRequest.priority.nameincident.status.namealert.currentStatealert.resource.hostNameuser.timeZonealert.deviceNamealert.descriptionalert.subjectalert.serviceNamealert.alertTime
  • thirdPartyAttrNamestring

    Third-party attribute name.

  • thirdPartyEntityTypestring

    Third-party entity type.

  • attrValuesarray

    Mapping attribute values:

  • modestring

    Enum:
    INBOUNDOUTBOUND
  • parsingPropertyobject

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the tenantId of the tenant

  • installedIntgIdstringrequired

    Unique Identifier of the installed integration

Responses

200OK