Jump to

• Request
• Response
• Examples

Get all integration maps

get

/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps

Request

Query Parameters

• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• $filter: string
  The resource collection will be queried using the specified filter condition.
• $limit: integer
  Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.

  Default Value: 25
• $offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.

  Default Value: 0
• $sortBy: string
  Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : integrationMaps_view-default

Match All

Show Source

• object __collection_context
• object integrationMaps_view-default-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/integrationMaps_view-default_item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : integrationMaps_view-default-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/integrationMaps_view-default_item-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: integrationMaps_view-default_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/integrationMaps_view-default_item-response"
    }
}

Nested Schema : integrationMaps_view-default_item-response

Match All

Show Source

• allOf integrationMaps_item-response
• object integrationMaps_view-default_item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/integrationMaps_item-response"
        },
        {
            "type":"object",
            "properties":{
                "integrationMapId":{
                },
                "name":{
                },
                "description":{
                },
                "integrationMapNumber":{
                },
                "sourceObject":{
                },
                "seededFlag":{
                },
                "integrationSpec":{
                },
                "createdBy":{
                },
                "timeCreated":{
                },
                "updatedBy":{
                },
                "timeUpdated":{
                },
                "lockedFlag":{
                },
                "activeFlag":{
                }
            }
        }
    ]
}

Nested Schema : integrationMaps_item-response

Match All

Show Source

• object Integration Map
  Title: Integration Map

  Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : Integration Map

Type: object

Title: Integration Map

Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.

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.

{
    "type":"object",
    "properties":{
        "integrationMapId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Identifier",
            "description":"The unique identifier of the integration map."
        },
        "name":{
            "type":"string",
            "title":"Map Name",
            "description":"The name of the integration map."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Map Description",
            "description":"The description of the integration map."
        },
        "integrationMapNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Number",
            "description":"The public unique identifier of the integration map."
        },
        "sourceApplication":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "title":"Source Application",
            "description":"The source application for the integration."
        },
        "sourceObject":{
            "type":"string",
            "x-searchable":true,
            "title":"Source Object",
            "description":"The source object of the integration."
        },
        "seededFlag":{
            "type":"boolean",
            "x-searchable":true,
            "title":"Seeded Flag",
            "description":"Indicates whether the integration map was seeded by Oracle."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration map was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration map record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration map was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who last updated the integration map record."
        },
        "integrationSpec":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Map Transform Specification",
            "description":"The transform specifications for the integration map."
        },
        "activeFlag":{
            "type":"boolean",
            "title":"Active Flag",
            "description":"Indicates that the integration map is active."
        },
        "lockedFlag":{
            "type":"boolean",
            "title":"Locked Flag",
            "description":"Indicates that the integration map is locked and can't be edited or cloned by a user."
        }
    },
    "x-primaryKey":[
        "integrationMapId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationMapNumber"
        ]
    },
    "title":"Integration Map",
    "x-hints":{
        "titlePlural":"Integration Maps"
    },
    "description":"Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications."
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : integrationMaps_view-default_item-response-allOf[1]

Type: object

Show Source

• activeFlag:
• createdBy:
• description:
• integrationMapId:
• integrationMapNumber:
• integrationSpec:
• lockedFlag:
• name:
• seededFlag:
• sourceObject:
• timeCreated:
• timeUpdated:
• updatedBy:

{
    "type":"object",
    "properties":{
        "integrationMapId":{
        },
        "name":{
        },
        "description":{
        },
        "integrationMapNumber":{
        },
        "sourceObject":{
        },
        "seededFlag":{
        },
        "integrationSpec":{
        },
        "createdBy":{
        },
        "timeCreated":{
        },
        "updatedBy":{
        },
        "timeUpdated":{
        },
        "lockedFlag":{
        },
        "activeFlag":{
        }
    }
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to get all 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' \
--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.

{
    "items": [
        {
            "integrationMapId": "300100576881595",
            "name": "Integrate Products",
            "description": "Synchronize product create or update in Sales with CPQ.",
            "integrationMapNumber": "DATAINTG-699",
            "sourceObject": "Product",
            "seededFlag": true,
            "integrationSpec": "{\"BeforeHandler\":\"com.oracle.osc.aspects.consumer.product.BeforeHandlerImpl\",\"MapTransform\":{\"Transform\":\"{\\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": "MHoope",
            "timeCreated": "2023-06-20T14:26:27.333951Z",
            "updatedBy": "MHoope",
            "timeUpdated": "2023-06-20T14:26:27.333951Z",
            "lockedFlag": false,
            "activeFlag": false,
            "$id": "DATAINTG-699",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/integrationMaps/DATAINTG-699"
                    }
                }
            }
        },
        {
            "integrationMapId": "300100576881593",
            "name": "Integrate Products",
            "description": "Synchronize product create or update in Sales with CPQ.",
            "integrationMapNumber": "DATAINTG-067",
            "sourceObject": "Product",
            "seededFlag": true,
            "integrationSpec": "{\"BeforeHandler\":\"com.oracle.osc.aspects.consumer.product.BeforeHandlerImpl\",\"MapTransform\":{\"Transform\":\"{\\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": "MHoope",
            "timeCreated": "2023-06-20T12:32:18.144399Z",
            "updatedBy": "MHoope",
            "timeUpdated": "2023-06-20T12:32:18.144399Z",
            "lockedFlag": false,
            "activeFlag": false,
            "$id": "DATAINTG-067",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/integrationMaps/DATAINTG-067"
                    }
                }
            }
        },
        {
            "integrationMapId": "300100576881592",
            "name": "Integrate Products",
            "description": "Synchronize product create or update in Sales with CPQ.",
            "integrationMapNumber": "DATAINTG-859",
            "sourceObject": "Product",
            "seededFlag": true,
            "integrationSpec": "{\"BeforeHandler\":\"com.oracle.osc.aspects.consumer.product.BeforeHandlerImpl\",\"MapTransform\":{\"Transform\":\"{\\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": "MHoope",
            "timeCreated": "2023-06-20T11:52:01.167677Z",
            "updatedBy": "MHoope",
            "timeUpdated": "2023-06-20T11:52:01.167677Z",
            "lockedFlag": false,
            "activeFlag": false,
            "$id": "DATAINTG-859",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/integrationMaps/DATAINTG-859"
                    }
                }
            }
        },
        {
            "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"
                    }
                }
            }
        }
    ],
    "hasMore": false
}

Back to Top