Intelligence Setup REST API

The following REST endpoints are used to support administration of intelligence models for product recommendations.

Get All Intelligence Models

Use this endpoint to retrieve all intelligence models.

• Endpoint: /rest/v19/intelligenceSetup/models
• Method:  GET

Update Intelligence Models

Use this endpoint to update intelligence models.

• Endpoint: /rest/v19/intelligenceSetup/models
• Method:  PATCH

Get an Intelligence Model

Use this endpoint to retrieve the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}
• Method:  GET

Delete an Intelligence Model

Use this endpoint to delete the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}
• Method:  DELETE

Update an Intelligence Model

Use this endpoint to update the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}
• Method:  PATCH

Get All Intelligence Model Filters

Use this endpoint to retrieve all filters for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters
• Method:  GET

Add an Intelligence Model Filter

Use this endpoint to create a filter for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters
• Method:  POST

Update Intelligence Model Filters

Use this endpoint to update filters for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters
• Method:  PATCH

Get an Intelligence Model Filter

Use this endpoint to retrieve the specified intelligence model filter.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
• Method:  GET

Delete an Intelligence Model Filter

Use this endpoint to delete the specified intelligence model filter.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
• Method:  DELETE

Update an Intelligence Model Filter

Use this endpoint to update the specified intelligence model filter.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/filters/{filterId}
• Method:  PATCH

Get All Intelligence Model Trainings

Use this endpoint to retrieve all trainings for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/trainings
• Method:  GET

Update Intelligence Model Trainings

Use this endpoint to update trainings for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/trainings
• Method:  PATCH

Get an Intelligence Model Training

Use this endpoint to retrieve the specified intelligence model training.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/trainings/{trainingId}
• Method:  GET

Delete an Intelligence Model Training

Use this endpoint to delete the specified intelligence model training.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/trainings/{trainingId}
• Method:  DELETE

Train an Intelligence Model

Use this endpoint to start a training session for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/actions/train
• Method:  POST

Deploy an Intelligence Model Training

Use this endpoint to deploy the most recent training for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/actions/deploy
• Method:  POST

Undeploy an Intelligence Model Training

Use this endpoint to undeploy the last deployed training for the specified intelligence model.

• Endpoint: /rest/v19/intelligenceSetup/models/{modelId}/actions/undeploy
• Method:  POST

Get Commerce Process Data Columns

Use this endpoint to retrieve Data Columns for the specified Commerce Process.

• Endpoint: /rest/v19/intelligenceSetup/models/lookups/commerceProcesses/{commerceProcessVarName}/dataColumns
• Method:  GET

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

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.