Intelligence REST APIs

Overview

The Intelligence Run-Time and Setup REST APIs provide web services to support product recommendations based on Machine Learning to suggest products to be added alongside the current items in the quote. AI generated product recommendations can help improve the customer experience and increase sales by creating opportunities to cross-sell and upsell products. The algorithms look at the products already selected and starts recommending other products based on the concepts "Frequently bought together" and/or "Customers also bought".

Frequently bought together looks for products that are frequently bought together on the same quote.
Customers also bought has a wider scope by looking at products also bought by a customer, even if on different quote.

Administration

Intelligence Run-Time REST API

Render Recommended Products

Render Recommended Products
Description	Use this endpoint to render product recommendations during runtime.
URI Endpoint	/rest/v19/intelligence/actions/recommendProducts
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	commerce	The Commerce Intelligence Data Source object:
		cacheInstanceId	The Commerce cache instance Id.
		id	The transaction Id
		maxTopPicks	The maximum number of top picks to return.
		onlyTopPicks	This Boolean parameter indicates if other recommendation categories are returned in addition to the Top Picks category. true: (default value) Only Top Picks category is returned false: Additional categories are returned
Response Body Parameters	The following arrays can be returned:
	topPicks	Top Picks product recommendations are always returned.
	frequentlyBoughtTogether	Products that are frequently bought together on the same quote. This category is returned when `onlyTopPicks` is false.
	customersAlsoBought	Products that are also bought by a customer, even if on different quote. This category is returned when `onlyTopPicks` is false.
	Each array contains the following items:
	confidence	Confidence represents the likelihood of the recommended item would be purchased.
	lift	Lift measures the strength of the commendation compared to what would be expected by chance. A lift value greater than 1 suggests a positive association, while a value less than 1 a negative association.
	rank	The recommendation rank.
	recommendationReason	The reason for the recommendation.
	recommendationType	The recommendation type. Allowed Values: "frequentlyBoughtTogether" and "customersAlsoBought"
	recommendedItem	The recommended item object:
		bomItemVariableName	The BOM Item variable name.
		description	The product description.
		id	The top recommendations Id.
		label	The product label
		listPrice	The product list price.
		partNumber	The part number
		productIdentifier	The product identifier
		productType	The product type
		status	The product status

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligence/actions/recommendProducts

Sample Request Body

{ "commerce": { "id": 3023201387, "cacheInstanceId": "K4MAHuD725BG6ivxR3tvGqazte22AOVHIb9owz7WmBtO84saOneTD3hN4Nkb73i9", "onlyTopPicks": false, "maxTopPicks": 4 } }

Sample Response Body

{ "topPicks": [{ "recommendedItem": { "id": 15213819, "partNumber": "Customer Specific Pricing 02", "productIdentifier": "PART_Customer Specific Pricing 02", "description": "Base price in all currencies - Absolute price profile in USD only", "label": "Customer Specific Pricing 02", "listPrice": "$2.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 1, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 8523277, "partNumber": "part100", "productIdentifier": "PART_part100", "label": "Part Display 100", "listPrice": "$100.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 2, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 1.0, "lift": 2.793103448275862 }, { "recommendedItem": { "id": 8523072, "partNumber": "part1", "productIdentifier": "BOM_configIntegrationRoot", "bomItemVariableName": "configIntegrationRoot", "label": "Part Display 1", "listPrice": "$1.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Bom", "lookupCode": 1 } }, "rank": 3, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 0.9655172413793104, "lift": 1.4756018217306441 }, { "recommendedItem": { "id": 19823338, "partNumber": "PriceScore1", "productIdentifier": "PART_PriceScore1", "description": "pricescore", "label": "PriceScore1", "listPrice": "$200.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 4, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 8523091, "partNumber": "part10", "productIdentifier": "PART_part10", "label": "Part Display 10", "listPrice": "$10.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 5, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 0.9655172413793104, "lift": 2.6068965517241383 } ], "frequentlyBoughtTogether": [{ "recommendedItem": { "id": 8523277, "partNumber": "part100", "productIdentifier": "PART_part100", "label": "Part Display 100", "listPrice": "$100.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 1, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 1.0, "lift": 2.793103448275862 }, { "recommendedItem": { "id": 8523072, "partNumber": "part1", "productIdentifier": "BOM_configIntegrationRoot", "bomItemVariableName": "configIntegrationRoot", "label": "Part Display 1", "listPrice": "$1.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Bom", "lookupCode": 1 } }, "rank": 2, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 0.9655172413793104, "lift": 1.4756018217306441 }, { "recommendedItem": { "id": 8523091, "partNumber": "part10", "productIdentifier": "PART_part10", "label": "Part Display 10", "listPrice": "$10.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 3, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 0.9655172413793104, "lift": 2.6068965517241383 }, { "recommendedItem": { "id": 8523281, "partNumber": "part102", "productIdentifier": "PART_part102", "label": "part102", "listPrice": "$102.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 4, "recommendationType": "frequentlyBoughtTogether", "recommendationReason": "This item is frequently bought together with others in the transaction.", "confidence": 0.9655172413793104, "lift": 2.793103448275862 } ], "customersAlsoBought": [{ "recommendedItem": { "id": 15213819, "partNumber": "Customer Specific Pricing 02", "productIdentifier": "PART_Customer Specific Pricing 02", "description": "Base price in all currencies - Absolute price profile in USD only", "label": "Customer Specific Pricing 02", "listPrice": "$2.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 1, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 19823338, "partNumber": "PriceScore1", "productIdentifier": "PART_PriceScore1", "description": "pricescore", "label": "PriceScore1", "listPrice": "$200.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 2, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 8523135, "partNumber": "part32", "productIdentifier": "PART_part32", "label": "part32", "listPrice": "$32.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 3, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 8523080, "partNumber": "part5", "productIdentifier": "PART_part5", "label": "Part Display 5", "listPrice": "$5.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 4, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 }, { "recommendedItem": { "id": 16267157, "partNumber": "Basic Pricing 13", "productIdentifier": "PART_Basic Pricing 13", "description": "Explicitly added to Pricebook 5: Multiplier of Pricebook 3 (10.0x) in all MDB currencies.", "label": "Basic Pricing 13", "listPrice": "$1.00", "status": { "displayValue": "Created", "lookupCode": "ORA_CREATED" }, "productType": { "displayValue": "Part", "lookupCode": 0 } }, "rank": 5, "recommendationType": "customersAlsoBought", "recommendationReason": "Customers also bought this item with others in the transaction.", "confidence": 1.0, "lift": 2.0 } ] }

Intelligence Setup REST APIs

The Intelligence Setup REST API endpoints provide web service support for the administration of AI generated product recommendations.

Intelligence Models

Delete an Intelligence Model

Delete an Intelligence Model
Description	Use this endpoint to delete the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

Get All Intelligence Models

Get All Intelligence Models
Description	Use this endpoint to retrieve all intelligence models.
URI Endpoint	/rest/v19/intelligenceSetup/models
Endpoint Parameters	None
Query Parameters	This endpoint supports the following optional parameters: `expand`, `fields`, `finder`, `limit`, `offset`, `onlyData`, `orderby`, `q`, and `totalResults`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of intelligence model items:
	analyticsType	(required) The analytics type. Allowed Values: "productRecommendation"
	createdBy	The details of the user who created the record.
	customerAlsoBought	Indicates whether to perform the customer also bought analysis.
	dateAdded	Creation date of the intelligence model.
	dateFilter	The Id of the attribute used in the date filter.
	dateModified	Last modified date of the intelligence model.
	description	Description of the intelligence model.
	documentId	The Commerce document Id.
	documentName	Name of the source document.
	duration	The duration of the date filter. Allowed Values: "NONE", "THIRTYDAYS", "SIXTYDAYS", "SIXMONTHS", "ONEYEAR", "TWOYEAR", "ALL"
	filters	List of filters to be applied for the intelligence model.
	frequentlyBoughtTogether	Indicates whether to perform the frequently bought together analysis.
	id	Id of the intelligence model.
	lastModifiedBy	The details of the user who modified the record.
	links	The link relations associated with the resource instance.
	maxNumOutput	The maximum number of outputs.
	name	(required) Name of the intelligence model.
	processId	The Commerce process Id.
	processName	Name of the source process.
	trainings	List of trainings for the intelligence model.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models?onlyData=true&q={analyticsType:'productRecommendation'}

Sample Response Body

{ "items": [{ "id": 334523, "name": "Product Recommendation", "frequentlyBoughtTogether": true, "customerAlsoBought": true, "algorithm": "AssociationRules", "description": "Seeded product recommendation.", "analyticType": "ProductRecommendation", "dateFilter": "LastSixMonths", "processName": "Quote Process", "processId": "4534256", "documentName": "Sub Document", "documentId": "2234256", "createdBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "lastModifiedBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "dateAdded": "06/05/2024 10:23 PM", "dateModified": "06/05/2024 10:23 PM" }, { "id": 3324561, "name": "Custom Product Recommendations", "frequentlyBoughtTogether": true, "customerAlsoBought": true, "algorithm": "AssociationRules", , "description": "Custom product recommendation.", "analyticType": "ProductRecommendation", "dateFilter": "LastSixMonths", "processName": "Quote Process", "processId": "4534256", "documentName": "Sub Document", "documentId": "2234256", "createdBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "lastModifiedBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "dateAdded": "06/05/2024 10:23 PM", "dateModified": "06/05/2024 10:23 PM" } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false }

Get an Intelligence Model

Get an Intelligence Model
Description	Use this endpoint to retrieve the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}
Endpoint Parameters	modelId	The intelligence model Id
Query Parameters	This endpoint supports the following optional parameters: `expand` and `fields`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	analyticsType	(required) The analytics type. Allowed Values: "productRecommendation"
	createdBy	The details of the user who created the record.
	customerAlsoBought	Indicates whether to perform the customer also bought analysis.
	dateAdded	Creation date of the intelligence model.
	dateFilter	The Id of the attribute used in the date filter.
	dateModified	Last modified date of the intelligence model.
	description	Description of the intelligence model.
	documentId	The Commerce document Id.
	documentName	Name of the source document.
	duration	The duration of the date filter. Allowed Values: "NONE", "THIRTYDAYS", "SIXTYDAYS", "SIXMONTHS", "ONEYEAR", "TWOYEAR", "ALL"
	filters	List of filters to be applied for the intelligence model.
	frequentlyBoughtTogether	Indicates whether to perform the frequently bought together analysis.
	id	Id of the intelligence model.
	lastModifiedBy	The details of the user who modified the record.
	links	The link relations associated with the resource instance.
	maxNumOutput	The maximum number of outputs.
	name	(required) Name of the intelligence model.
	processId	The Commerce process Id.
	processName	Name of the source process.
	trainings	List of trainings for the intelligence model.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523

Sample Response Body

{ "id": 334523, "name": "Product Recommendation", "frequentlyBoughtTogether": true, "customerAlsoBought": true, "algorithm": "AssociationRules", "description": "Seeded product recommendation.", "analyticType": "ProductRecommendation", "dateFilter": "LastSixMonths", "processName": "Quote Process", "processId": "4534256", "documentName": "Sub Document", "documentId": "2234256", "createdBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "lastModifiedBy": { "firstName": "Super", "lastName": "User", "emailId": "junk@bigmachines.com" }, "dateAdded": "06/05/2024 10:23 PM", "dateModified": "06/05/2024 10:23 PM" }

Update Intelligence Models

Update Intelligence Models
Description	Use this endpoint to update the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	PATCH
Request Body Parameters	The array of intelligence patch operations.
	op	The operation to be performed. Allowed values: "add", "remove", and "replace".
	path	The JSON pointer string for "path" property.
	value	The target value. Refer to Update Intelligence Model for more information.
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/intelligenceSetup/models

Sample Request Body

[ { "op": "replace", "path": "/3023483575", "value" : { "attributeId": "4356390", "operator" : "_not_eq", "attributeValue": "44" } } ]

Update an Intelligence Model

Update an Intelligence Model
Description	Use this endpoint to update the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	PATCH
Request Body Parameters	analyticsType	(required) The analytics type. Allowed Values: "productRecommendation"
	customerAlsoBought	Indicates whether to perform the customer also bought analysis.
	dateFilter	The Id of the attribute used in the date filter.
	description	Description of the intelligence model.
	documentId	The Commerce document Id.
	documentName	Name of the source document.
	duration	The duration of the date filter. Allowed Values: "NONE", "THIRTYDAYS", "SIXTYDAYS", "SIXMONTHS", "ONEYEAR", "TWOYEAR", "ALL"
	filters	List of filters to be applied for the intelligence model.
	frequentlyBoughtTogether	Indicates whether to perform the frequently bought together analysis.
	id	Id of the intelligence model.
	maxNumOutput	The maximum number of outputs.
	name	(required) Name of the intelligence model.
	processId	The Commerce process Id.
	processName	Name of the source process.
	trainings	List of trainings for the intelligence model.
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523

Sample Request Body

{ "frequentlyBoughtTogether": true, "customerAlsoBought" : true, "topPicks": false }

Intelligence Model Filters

Add an Intelligence Model Filter

Add an Intelligence Model Filter
Description	Use this endpoint to create an intelligence model filter.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	POST
Request Body Parameters	attributeId	(required) ID of the attribute used on the left hand side of the filter.
	attributeLabel	Label of the attribute used on the left hand side of the filter.
	attributeValue	(required) Value on the right hand side of the filter.
	attributeValueLabel	Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
	operator	(required) Operator used in the filter. Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]
Response Body Parameters	_proxy_id	The proxy identifier for the resource that was added.
	attributeId	(required) ID of the attribute used on the left hand side of the filter.
	attributeLabel	Label of the attribute used on the left hand side of the filter.
	attributeValue	(required) Value on the right hand side of the filter.
	attributeValueLabel	Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model filter.
	dateModified	Last modified date of the intelligence model filter.
	id	Id of the intelligence model filter.
	lastModifiedBy	The details of the user who modified the record.
	operator	(required) Operator used in the filter. Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/filters

Sample Request Body

{ "attributeId": 18064711, "operator": "_eq", "attributeValue": "ORDER_PLACED" }

Sample Response Body

{ "createdBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "lastModifiedBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "dateModified": "2025-03-08T20:13:50Z", "dateAdded": "2025-03-08T20:13:50Z", "id": 3023620976, "attributeId": 18064711, "operator": "_eq", "attributeValue": "ORDER_PLACED" }

Delete an Intelligence Model Filter

Delete an Intelligence Model Filter
Description	Use this endpoint to delete the specified intelligence model filter.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
Endpoint Parameters	modelId	The intelligence model Id
Endpoint Parameters	filterId	The intelligence model filter Id
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

Get All Intelligence Model Filters

Get All Intelligence Model Filters
Description	Use this endpoint to retrieve all intelligence model filters for the specified model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters
Endpoint Parameters	modelId	The intelligence model Id
Query Parameters	This endpoint supports the following optional parameters: `fields`, `limit`, `offset`, `onlyData`, `orderby`, `q`, and `totalResults`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of intelligence model filter items:
	_proxy_id	The proxy identifier for the resource that was added.
	attributeId	(required) ID of the attribute used on the left hand side of the filter.
	attributeLabel	Label of the attribute used on the left hand side of the filter.
	attributeValue	(required) Value on the right hand side of the filter.
	attributeValueLabel	Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model filter.
	dateModified	Last modified date of the intelligence model filter.
	id	Id of the intelligence model filter.
	lastModifiedBy	The details of the user who modified the record.
	operator	(required) Operator used in the filter. Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523

Sample Response Body

Get an Intelligence Model Filter

Get an Intelligence Model Filter
Description	Use this endpoint to retrieve the specified intelligence model filter.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
Endpoint Parameters	modelId	The intelligence model Id
Endpoint Parameters	filterId	The intelligence model filter Id
Query Parameters	This endpoint supports the following optional parameters: `expand` and `fields`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	_proxy_id	The proxy identifier for the resource that was added.
	attributeId	(required) ID of the attribute used on the left hand side of the filter.
	attributeLabel	Label of the attribute used on the left hand side of the filter.
	attributeValue	(required) Value on the right hand side of the filter.
	attributeValueLabel	Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model filter.
	dateModified	Last modified date of the intelligence model filter.
	id	Id of the intelligence model filter.
	lastModifiedBy	The details of the user who modified the record.
	operator	(required) Operator used in the filter. Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/filters/3023603684

Sample Response Body

{ "createdBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "lastModifiedBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "dateModified": "2025-02-27T23:49:41Z", "dateAdded": "2025-02-27T23:49:41Z", "id": 3023603684, "attributeId": 20013292, "attributeLabel": "Status", "operator": "_eq", "attributeValue": "won", "attributeValueLabel": "Won" }

Update Intelligence Model Filters

Update Intelligence Model Filters
Description	Use this endpoint to update intelligence model filters.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	PATCH
Request Body Parameters	The array of intelligence patch operations.
	op	The operation to be performed. Allowed values: "add", "remove", and "replace".
	path	The JSON pointer string for "path" property.
	value	The target value. Refer to Update Intelligence Model Filter for more information.
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523/filters

Sample Request Body

[{ "op": "add", "path": "/", "value": { "id": -1, "attributeId": 4356390, "operator": "_not_eq", "value": "55" }, { "op": "replace", "path": "/5435123", "value": { "value": "Healthcare" } }, { "op": "remove", "path": "/1234567" } ]

Sample Response Body

[{ "_proxy_id": -1, "id": "321456" } ]

Update an Intelligence Model Filter

Update an Intelligence Model Filter
Description	Use this endpoint to update the specified intelligence model filter.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
Endpoint Parameters	modelId	The intelligence model Id
Endpoint Parameters	filterId	The intelligence model filter Id
HTTP Method	PATCH
Request Body Parameters	attributeId	(required) ID of the attribute used on the left hand side of the filter.
	attributeLabel	Label of the attribute used on the left hand side of the filter.
	attributeValue	(required) Value on the right hand side of the filter. This value must either be the variable name of the source attribute or prefixed with '#SPECIFIC_' for static values.
	attributeValueLabel	Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
	operator	(required) Operator used in the filter. Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523/filters/3023603684

Sample Request Body

{ "attributeValue": "ORDERED" }

Intelligence Model Training

Delete an Intelligence Model Training

Delete an Intelligence Model Training
Description	Use this endpoint to delete the specified intelligence model training.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/trainings/{trainingId}
Endpoint Parameters	modelId	The intelligence model Id
Endpoint Parameters	trainingId	The training Id
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

Deploy Intelligence Model Training

Deploy Intelligence Model Training
Description	Use this endpoint to deploy the most recent training for the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/actions/deploy
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	POST
Request Body Parameters	trainingId	The Id of the training to be deployed. It should be a training that has successfully completed but has not been deployed yet.
Response Body Parameters	analyticsInfo	Information about the training.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model training.
	dateModified	Last modified date of the intelligence model training.
	duration	The training duration.
	id	The Id of the intelligence model training.
	lastDeployed	Date of the training's last deployment.
	lastModifiedBy	The details of the user who modified the record.
	learningTimeElapsed	Learning time elapsed.
	message	Training message.
	status	The training status. Allowed Values: [ "Started", "Completed", "Failed" ]
	testErrorRate	Test error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.
	totalRecords	Total number of records used for training.
	trainingErrorRate	Training error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/actions/deploy

Sample Request Body

{ "trainingId": 3023602739 }

Sample Response Body

{ "id": 3023602739, "dateModified": "2025-02-27T10:13:23Z", "dateAdded": "2025-02-27T10:12:01Z", "learningTimeElapsed": "72", "status": "Completed", "message": "The model was built successfully.", "lastDeployed": "2025-02-27T10:13:23Z", "totalRecords": 2132 }

Get All Intelligence Model Trainings

Get All Intelligence Model Trainings
Description	Use this endpoint to retrieve all trainings for the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/trainings
Endpoint Parameters	modelId	The intelligence model Id
Query Parameters	This endpoint supports the following optional parameters: `fields`, `limit`, `offset`, `onlyData`, `orderby`, `q`, and `totalResults`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of intelligence model training items.
	analyticsInfo	Information about the training.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model training.
	dateModified	Last modified date of the intelligence model training.
	duration	The training duration.
	id	The Id of the intelligence model training.
	lastDeployed	Date of the training's last deployment.
	lastModifiedBy	The details of the user who modified the record.
	learningTimeElapsed	Learning time elapsed.
	message	Training message.
	status	The training status. Allowed Values: [ "Started", "Completed", "Failed" ]
	testErrorRate	Test error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.
	totalRecords	Total number of records used for training.
	trainingErrorRate	Training error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/trainings

Sample Response Body

{ "items": [{ "createdBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "lastModifiedBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "id": 3023602739, "dateModified": "2025-02-27T10:13:23Z", "dateAdded": "2025-02-27T10:12:01Z", "learningTimeElapsed": "72", "duration": 0, "status": "Completed", "message": "The model was built successfully.", "lastDeployed": "2025-02-27T10:13:23Z", "totalRecords": 2132 }, { "createdBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "id": 3023620982, "dateModified": "2025-03-08T20:42:00Z", "dateAdded": "2025-03-08T20:40:32Z", "learningTimeElapsed": "83", "duration": 0, "status": "Completed", "message": "The model was built successfully.", "totalRecords": 2521 } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false }

Get an Intelligence Model Training

Get an Intelligence Model Training
Description	Use this endpoint to retrieve the specified intelligence model training.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/trainings/{trainingId}
Endpoint Parameters	modelId	The intelligence model Id
Endpoint Parameters	trainingId	The training Id
Query Parameters	This endpoint supports the following optional parameters: `expand` and `fields`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	analyticsInfo	Information about the training.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model training.
	dateModified	Last modified date of the intelligence model training.
	duration	The training duration.
	id	The Id of the intelligence model training.
	lastDeployed	Date of the training's last deployment.
	lastModifiedBy	The details of the user who modified the record.
	learningTimeElapsed	Learning time elapsed.
	message	Training message.
	status	The training status. Allowed Values: [ "Started", "Completed", "Failed" ]
	testErrorRate	Test error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.
	totalRecords	Total number of records used for training.
	trainingErrorRate	Training error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/trainings/3023602739

Sample Response Body

{ "createdBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "lastModifiedBy": { "firstName": "Alex", "lastName": "Smith", "emailId": "alex.smith@example.com" }, "id": 3023602739, "dateModified": "2025-02-27T10:13:23Z", "dateAdded": "2025-02-27T10:12:01Z", "learningTimeElapsed": "72", "status": "Completed", "message": "The model was built successfully.", "lastDeployed": "2025-02-27T10:13:23Z", "totalRecords": 2132 }

Train an Intelligence Model

Train an Intelligence Model
Description	Use this endpoint start an intelligence model training session.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/actions/train
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	analyticsInfo	Information about the training.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model training.
	dateModified	Last modified date of the intelligence model training.
	duration	The training duration.
	id	The Id of the intelligence model training.
	lastDeployed	Date of the training's last deployment.
	lastModifiedBy	The details of the user who modified the record.
	learningTimeElapsed	Learning time elapsed.
	message	Training message.
	status	The training status. Allowed Values: [ "Started", "Completed", "Failed" ]
	testErrorRate	Test error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.
	totalRecords	Total number of records used for training.
	trainingErrorRate	Training error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/321456/actions/train

Sample Response Body

[{ "id": 321456, "startDate": "2024-08-09T07:00:00Z", "status": "In Progress" } ]

Undeploy Intelligence Model Training

Undeploy Intelligence Model Training
Description	Use this endpoint to undeploy the most recent training deployment for the specified intelligence model.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/actions/undeploy
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	analyticsInfo	Information about the training.
	createdBy	The details of the user who created the record.
	dateAdded	Creation date of the intelligence model training.
	dateModified	Last modified date of the intelligence model training.
	duration	The training duration.
	id	The Id of the intelligence model training.
	lastDeployed	Date of the training's last deployment.
	lastModifiedBy	The details of the user who modified the record.
	learningTimeElapsed	Learning time elapsed.
	message	Training message.
	status	The training status. Allowed Values: [ "Started", "Completed", "Failed" ]
	testErrorRate	Test error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.
	totalRecords	Total number of records used for training.
	trainingErrorRate	Training error rate. Training and Test Error Rates measure the accuracy of the recommendations made by the intelligence model. If the Training or Test Error Rates are too high, messages will display with recommended actions to improve the model’s recommendations.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/334523/actions/undeploy

Sample Response Body

Update Intelligence Model Trainings

Update Intelligence Model Trainings
Description	Use this endpoint to update intelligence model trainings.
URI Endpoint	/rest/v19/intelligenceSetup/models/{modelId}/trainings
Endpoint Parameters	modelId	The intelligence model Id
HTTP Method	PATCH
Request Body Parameters	The array of intelligence patch operations.
	op	The operation to be performed. Allowed values: "add", "remove", and "replace".
	path	The JSON pointer string for "path" property.
	value	The target value. Refer to Update Intelligence Model Training for more information.
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523/trainings

Sample Request Body

[{ "op": "remove", "path": "/5435123" } ]

Get Commerce Process Data Columns

Get Commerce Process Data Columns
Description	Use this endpoint to retrieve all Data Columns for the specified Commerce Process.
URI Endpoint	/rest/v19/intelligenceSetup/models/lookups/commerceProcesses/{commerceProcessVarName}/dataColumns
Endpoint Parameters	modelId	The intelligence model Id
Query Parameters	This endpoint supports the following optional parameters: `fields`, `limit`, `offset`, `onlyData`, and `totalResults`. Refer to Manage Collections for additional information
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	An array of data column items.
	attributeId	Id of the attribute.
	attributeLabel	The attribute label.
	attributeVariableName	Variable Name of the attribute.
	commerceDocumentVariableName	Variable Name of the commerce document.
	createdBy	The details of the user who created the record.
	Id	Id of the data column.
	lastModifiedBy	The details of the user who modified the record.
	links	The link relations associated with the resource instance.
	menuItems	An array of menu items: Display Value Order Number Value
	type	Type of the attribute.

URI Endpoint Sample

https://site.oracle.com/rest/v19/intelligenceSetup/models/lookups/commerceProcesses/oraclecpqo/dataColumns

Sample Response Body

{ "items": [{ "id": 18319676, "attributeId": 18319514, "attributeVariableName": "bsid", "attributeLabel": "Main: bs_id", "commerceDocumentVariableName": "main", "type": "Text" }, { "id": 20316314, "attributeId": 18319534, "attributeVariableName": "floatField1", "attributeLabel": "Main: Float Field 1", "commerceDocumentVariableName": "main", "type": "Float" }, { "id": 20316315, "attributeId": 18319598, "attributeVariableName": "integerFieldSub1", "attributeLabel": "Sub: Integer Field Sub 1", "commerceDocumentVariableName": "sub", "type": "Integer" }, { "id": 1, "attributeId": 1, "attributeLabel": "Main: System Creation Date", "commerceDocumentVariableName": "main", "type": "Date" }, { "id": 2, "attributeId": 2, "attributeLabel": "Main: System Last Modified Date", "commerceDocumentVariableName": "main", "type": "Date" }, { "id": 3, "attributeId": 3, "attributeLabel": "Sub: System Creation Date", "commerceDocumentVariableName": "sub", "type": "Date" }, { "id": 4, "attributeId": 4, "attributeLabel": "Sub: System Last Modified Date", "commerceDocumentVariableName": "sub", "type": "Date" } ], "offset": 0, "limit": 1000, "count": 7, "hasMore": false }

Intelligence REST APIs

Overview

Administration

Intelligence Run-Time REST API

Intelligence Setup REST APIs

Intelligence Models

Intelligence Model Filters

Intelligence Model Training

Related Topics