Jump to

• Request
• Response
• Examples

Get All Intelligence Models

get

/rest/v19/intelligenceSetup/models

Use this endpoint to retrieve all intelligence models.

Request

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.
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>
  The following are the available finder names and corresponding finder variables:
  
  

  • findByKeyword:Find intelligence models using name and description.
    Finder Variable:
    • keyword;string:The search text.The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_IntelligenceModel

Type: object

Show Source

• 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntelligenceModel"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object IntelligenceModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IntelligenceModel"
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• 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

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : IntelligenceModel

Type: object

Show Source

• 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.

{
    "required":[
        "analyticsType",
        "name"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Model.",
            "title":"ID",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Model.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Model.",
            "title":"Date Added",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Intelligence Model.",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the pricing Model.",
            "title":"Description"
        },
        "processId":{
            "type":"integer",
            "format":"",
            "description":"The commerce process ID.",
            "title":"Commerce Process ID"
        },
        "processName":{
            "type":"string",
            "format":"",
            "description":"Name of the source Process.",
            "title":"Process Name",
            "readOnly":true
        },
        "documentId":{
            "type":"integer",
            "format":"",
            "description":"The commerce document ID.",
            "title":"Commerce Document ID"
        },
        "documentName":{
            "type":"string",
            "format":"",
            "description":"Name of the source Document.",
            "title":"Document Name",
            "readOnly":true
        },
        "analyticsType":{
            "type":"string",
            "format":"",
            "description":"The analytics type.",
            "title":"Analytics Type",
            "enum":[
                "productRecommendation"
            ]
        },
        "dateFilter":{
            "type":"integer",
            "format":"",
            "description":"The ID of the attribute used in the date filter.",
            "title":"Date Filter Attribute ID"
        },
        "duration":{
            "type":"string",
            "format":"",
            "description":"The duration of the date filter.",
            "title":"Duration",
            "enum":[
                "NONE",
                "THIRTYDAYS",
                "SIXTYDAYS",
                "SIXMONTHS",
                "ONEYEAR",
                "TWOYEAR",
                "ALL"
            ]
        },
        "filters":{
            "format":"",
            "description":"List of filters to be applied for the Intelligence Model.",
            "title":"Filters",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_IntelligenceFilter"
                }
            ]
        },
        "trainings":{
            "format":"",
            "description":"List of trainings done for the Intelligence Model.",
            "title":"Trainings",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_IntelligenceTraining"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "maxNumOutput":{
            "type":"integer",
            "format":"",
            "description":"The maximum number of outputs.",
            "title":"Maximum Number of Outputs"
        },
        "frequentlyBoughtTogether":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether to perform the frequently bought together analysis.",
            "title":"Frequtently Bought Together"
        },
        "customerAlsoBought":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether to perform the customer also bought analysis.",
            "title":"Customer Also Bought"
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object PricingResourceCollection_IntelligenceFilter

{
    "format":"",
    "description":"List of filters to be applied for the Intelligence Model.",
    "title":"Filters",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_IntelligenceFilter"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

• object PricingResourceCollection_IntelligenceTraining

{
    "format":"",
    "description":"List of trainings done for the Intelligence Model.",
    "title":"Trainings",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_IntelligenceTraining"
        }
    ]
}

Nested Schema : PricingResourceCollection_IntelligenceFilter

Type: object

Show Source

• 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntelligenceFilter"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object IntelligenceFilter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IntelligenceFilter"
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : IntelligenceFilter

Type: object

Show Source

• _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.

{
    "required":[
        "attributeId",
        "attributeValue",
        "operator"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Model.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Model.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Filter.",
            "title":"ID",
            "readOnly":true
        },
        "_proxy_id":{
            "type":"integer",
            "format":"",
            "description":"The proxy identifier for the resource that was added.",
            "title":"Proxy ID",
            "readOnly":true
        },
        "attributeId":{
            "type":"integer",
            "format":"",
            "description":"ID of the attribute used on the left hand side of the filter.",
            "title":"Attribute ID"
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"Label of the attribute used on the left hand side of the filter.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"Operator used in the filter.",
            "title":"Operator",
            "enum":[
                "_eq",
                "_not_eq",
                "_gr",
                "_le",
                "_gr_eq",
                "_le_eq",
                "_none",
                "_like",
                "_notlike",
                "_emp",
                "_not_emp"
            ]
        },
        "attributeValue":{
            "type":"string",
            "format":"",
            "description":"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.",
            "title":"Value"
        },
        "attributeValueLabel":{
            "type":"string",
            "format":"",
            "description":"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.",
            "title":"Value",
            "readOnly":true
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingResourceCollection_IntelligenceTraining

Type: object

Show Source

• 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntelligenceTraining"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object IntelligenceTraining

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IntelligenceTraining"
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : IntelligenceTraining

Type: object

Show Source

• 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.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Training.",
            "title":"ID",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Training.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Training.",
            "title":"Date Added",
            "readOnly":true
        },
        "learningTimeElapsed":{
            "type":"string",
            "format":"",
            "description":"Learning time elapsed.",
            "title":"Learning Time",
            "readOnly":true
        },
        "duration":{
            "type":"integer",
            "format":"",
            "description":"Training duration.",
            "title":"Duration",
            "readOnly":true
        },
        "trainingErrorRate":{
            "type":"number",
            "format":"",
            "description":"Training error rate.",
            "title":"Training Error Rate",
            "readOnly":true
        },
        "testErrorRate":{
            "type":"number",
            "format":"",
            "description":"Test error rate.",
            "title":"Test Error Rate",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "format":"",
            "description":"Training status.",
            "title":"Status",
            "readOnly":true,
            "enum":[
                "Started",
                "Completed",
                "Failed"
            ]
        },
        "message":{
            "type":"string",
            "format":"",
            "description":"Training message.",
            "title":"Message",
            "readOnly":true
        },
        "analyticsInfo":{
            "type":"string",
            "format":"",
            "description":"Information about the training.",
            "title":"Training Information",
            "readOnly":true
        },
        "lastDeployed":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Date of the training's last deployment.",
            "title":"Last Deployed",
            "readOnly":true
        },
        "totalRecords":{
            "type":"integer",
            "format":"",
            "description":"Total number of records used for training.",
            "title":"Total Records",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Back to Top

Examples

The following examples show how to retrieve all intelligence models 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?onlyData=true

Response Body Sample

{
  "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": "[e-mail]"
      },
      "lastModifiedBy": {
        "firstName": "Super",
        "lastName": "User",
        "emailId": "[e-mail]"
      },
      "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": "[e-mail]"
      },
      "lastModifiedBy": {
        "firstName": "Super",
        "lastName": "User",
        "emailId": "[e-mail]"
      },
      "dateAdded": "06/05/2024 10:23 PM",
      "dateModified": "06/05/2024 10:23 PM"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false
}

Back to Top