Get an Intelligence Model
get
/rest/v19/intelligenceSetup/models/{modelId}
Use this endpoint to retrieve the specified intelligence model.
Request
Path Parameters
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=trainings,filters. To include all the children and grandchildren, specify the value of this query parameter to be "all".
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : IntelligenceModel
Type:
Show Source
object
-
analyticsType(required):
string()
Title:
Analytics Type
Allowed Values:[ "productRecommendation" ]
The analytics type. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
customerAlsoBought:
boolean()
Title:
Customer Also Bought
Indicates whether to perform the customer also bought analysis. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Pricing Model. -
dateFilter:
integer()
Title:
Date Filter Attribute ID
The ID of the attribute used in the date filter. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Model. -
description:
string()
Title:
Description
Description of the pricing Model. -
documentId:
integer()
Title:
Commerce Document ID
The commerce document ID. -
documentName:
string()
Title:
Document Name
Read Only:true
Name of the source Document. -
duration:
string()
Title:
Duration
Allowed Values:[ "NONE", "THIRTYDAYS", "SIXTYDAYS", "SIXMONTHS", "ONEYEAR", "TWOYEAR", "ALL" ]
The duration of the date filter. -
filters:
Filters
Title:
Filters
Read Only:true
List of filters to be applied for the Intelligence Model. -
frequentlyBoughtTogether:
boolean()
Title:
Frequtently Bought Together
Indicates whether to perform the frequently bought together analysis. -
id:
integer()
Title:
ID
Read Only:true
ID of the Intelligence Model. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
maxNumOutput:
integer()
Title:
Maximum Number of Outputs
The maximum number of outputs. -
name(required):
string()
Title:
Name
Name of the Intelligence Model. -
processId:
integer()
Title:
Commerce Process ID
The commerce process ID. -
processName:
string()
Title:
Process Name
Read Only:true
Name of the source Process. -
trainings:
Trainings
Title:
Trainings
Read Only:true
List of trainings done for the Intelligence Model.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Filters
Title:
Filters
Read Only:
true
List of filters to be applied for the Intelligence Model.
Match All
List of filters to be applied for the Intelligence Model.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Trainings
Title:
Trainings
Read Only:
true
List of trainings done for the Intelligence Model.
Match All
List of trainings done for the Intelligence Model.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PricingResourceCollection_IntelligenceFilter
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : IntelligenceFilter
Type:
Show Source
object
-
_proxy_id:
integer()
Title:
Proxy ID
Read Only:true
The proxy identifier for the resource that was added. -
attributeId(required):
integer()
Title:
Attribute ID
ID of the attribute used on the left hand side of the filter. -
attributeLabel:
string()
Title:
Attribute Label
Read Only:true
Label of the attribute used on the left hand side of the filter. -
attributeValue(required):
string()
Title:
Value
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:
string()
Title:
Value
Read Only:true
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:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Pricing Model. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Model. -
id:
integer()
Title:
ID
Read Only:true
ID of the Intelligence Filter. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
operator(required):
string()
Title:
Operator
Allowed Values:[ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]
Operator used in the filter.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingResourceCollection_IntelligenceTraining
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : IntelligenceTraining
Type:
Show Source
object
-
analyticsInfo:
string()
Title:
Training Information
Read Only:true
Information about the training. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Training. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Training. -
duration:
integer()
Title:
Duration
Read Only:true
Training duration. -
id:
integer()
Title:
ID
Read Only:true
ID of the Intelligence Training. -
lastDeployed:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Last Deployed
Read Only:true
Date of the training's last deployment. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
learningTimeElapsed:
string()
Title:
Learning Time
Read Only:true
Learning time elapsed. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
message:
string()
Title:
Message
Read Only:true
Training message. -
status:
string()
Title:
Status
Read Only:true
Allowed Values:[ "Started", "Completed", "Failed" ]
Training status. -
testErrorRate:
number()
Title:
Test Error Rate
Read Only:true
Test error rate. -
totalRecords:
integer()
Title:
Total Records
Read Only:true
Total number of records used for training. -
trainingErrorRate:
number()
Title:
Training Error Rate
Read Only:true
Training error rate.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following examples show how to retrieve the specified intelligence model by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
The 'limit' query specification is used in the following example to limit the results to three models per page.
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523
Response Body Sample
{ "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" }