Get an Intelligence Model

get

/rest/v19/intelligenceSetup/models/{modelId}

Use this endpoint to retrieve the specified intelligence model.

Request

Path Parameters
Query Parameters
  • 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".
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : IntelligenceModel
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : PricingResourceCollection_IntelligenceFilter
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • 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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • 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 : items
Type: array
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 : IntelligenceFilter
Type: object
Show Source
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 : PricingResourceCollection_IntelligenceTraining
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • 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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • 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 : items
Type: array
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 : IntelligenceTraining
Type: object
Show Source
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
Back to Top

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"
}
Back to Top