Get an integration map
get
/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}
Request
Path Parameters
-
integrationMaps_id(required): string
This path parameter maps to the following field defined in the Integration Maps REST resource:
- integrationMapNumber: The public unique identifier of the integration map.
Query Parameters
-
$fields: string
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
There's no request body for this operation.
Back to TopResponse
Default Response
A single item response
Root Schema : integrationMaps_item-response
Match All
Show Source
-
object
Integration Map
Title:
Integration Map
An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application. -
object
__busObj_context
Nested Schema : Integration Map
Type:
object
Title:
Integration Map
An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application.
Show Source
-
activeFlag: boolean
Title:
Active Flag
Indicates that the integration map is active. -
createdBy: string
Title:
Created By
Read Only:true
The user who created the integration map record. -
description: string
Title:
Map Description
The description of the integration map. -
integrationMapId: string
(big-integer)
Title:
Integration Map Identifier
The unique identifier of the integration map. -
integrationMapNumber: string
Title:
Integration Map Number
The public unique identifier of the integration map. -
integrationSpec: string
(long-text)
Title:
Map Transform Specification
The transform specifications for the integration map. -
lockedFlag: boolean
Title:
Locked Flag
Indicates that the integration map is locked and can't be edited or cloned by a user. -
name: string
Title:
Map Name
The name of the integration map. -
seededFlag: boolean
Title:
Seeded Flag
Indicates whether the integration map was seeded by Oracle. -
sourceApplication: string
Title:
Source Application
Read Only:true
The source application for the integration. -
sourceObject: string
Title:
Source Object
The source object of the integration. -
timeCreated: string
(date-time)
Title:
Time Created
Read Only:true
The date and time when the integration map was created. -
timeUpdated: string
(date-time)
Title:
Time Updated
Read Only:true
The date and time when the integration map was last updated. -
updatedBy: string
Title:
Updated By
Read Only:true
The user who last updated the integration map record.
Links
- $self
-
Parameters:
- integrationMaps_id:
$request.path.integrationMaps_id
- integrationMaps_id:
Examples
The following example shows how to get an integration map by submitting a GET request on the REST resource.
cURL Command
curl -X GET --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/DATAINTG-100' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "integrationMapId": "300100575711592", "name": "Upsert Product in CPQ", "description": "Synchronize product create or update in Sales with CPQ.", "integrationMapNumber": "DATAINTG-100", "sourceObject": "Product", "seededFlag": true, "integrationSpec": "{\"BeforeHandler\":\"com.oracle.osc.aspects.consumer.product.BeforeHandlerImpl\",\"MapTransform\":{\"Transform\":\"{\\n$.Product.ProductTranslation[*].Description:$.upsertParts.partSetups.items[*].translations.items[*].description\\n$.lookup($.Product.ProductTranslation[*].Language,'CPQ_LANGUAGES'):$.upsertParts.partSetups.items[*].translations.items[*].language.languageCode\\n$.Product.Name:$.upsertParts.partSetups.items[*].partDisplayNumber\\n$.Product.InventoryItemId:$.upsertParts.partSetups.items[*].partnerPartId\\n$.Product.OrganizationId:$.upsertParts.partSetups.items[*].partnerOrganizationId\\n$.Product.DefaultPeriodicityCode:$.upsertParts.partSetups.items[*].pricePeriod\\n$.Product.DefaultPeriods:$.upsertParts.partSetups.items[*].numberOfPricePeriods\\n$.Product.DefaultPriceTypeCode:$.upsertParts.partSetups.items[*].priceType\\n$.Product.ItemNumber:$.upsertParts.partSetups.items[*].partNumber\\n$.Product.DefaultUOMCode:$.upsertParts.partSetups.items[*].defaultUOMCode\\n$.Product.ProductTypeCode:$.upsertParts.partSetups.items[*].salesProductType\\n$.Product.EligibleToSell:$.upsertParts.partSetups.items[*].eligibleToSell\\n$.Product.CSSEnabled:$.upsertParts.partSetups.items[*].enableSelfService\\n$.Product.EligibleForService:$.upsertParts.partSetups.items[*].eligibleForService\\n$.Product.ProcessingDays:$.upsertParts.partSetups.items[*].leadTime\\n$.\\\"1\\\":$.upsertParts.partSetups.items[*].directBuy.lookupCode\\n}\",\"Invoke\":{\"ConnectionReference\":\"ORA_CPQ_APP\",\"EndPointURI\":\"\/rest\/v14\/partSetups\/actions\/upsertParts\",\"EndPointAction\":\"POST\",\"EndPointHeaders\":\"\"}},\"IntegrationStepName\":\"IntegrateProduct\"}", "createdBy": "FUSION_APPS_CRM_SOA_APPID", "timeCreated": "2023-04-04T22:38:55Z", "updatedBy": "FUSION_APPS_CRM_SOA_APPID", "timeUpdated": "2023-06-18T05:37:48Z", "lockedFlag": false, "activeFlag": true, "$id": "DATAINTG-100", "$context": { "etag": "3", "links": { "$self": { "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/integrationMaps/DATAINTG-100" } } } }