1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Scoring Models

Get all scoring models

get

/crmRestApi/resources/11.13.18.05/scoringModels

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • AltKey Finds the scoring model with the alternate key.
      Finder Variables
      • ModelObjectCode; string; The scoring model object code.
      • ModelScoreAttribute; string; The scoring model object attribute.
      • ModelVersion; integer; The scoring model version.
    • PrimaryKey Finds the scoring model using the primary key.
      Finder Variables
      • ModelUuid; string; The unique identifier of the model.
    • RowFinder Finds the scoring model using the given information.
      Finder Variables
      • ModelObjectCode; string; The object code of the scoring model.
      • ModelScoreAttribute; string; The scoring model object attribute.
      • ModelVersion; integer; The model version of the scoring.
  • 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.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. 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
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the scoring model.
    • CreationDate; string; The date and time when the scoring model was created.
    • Description; string; The description of the scoring model.
    • LastUpdateDate; string; The date and time when the scoring model was last updated.
    • LastUpdatedBy; string; The user who last updated the scoring model.
    • ModelName; string; The name of the scoring model.
    • ModelObjectCode; string; The object code for this scoring model where the score is calculated for.
    • ModelScoreAttribute; string; The object's attribute name where the score will be stored.
    • ModelUuid; string; The primary key of the scoring model.
    • ModelVersion; integer; The version of the scoring model.
    • ObjectVersionNumber; integer; The object version number of the scoring model.
    • ScoreUpdateTime; string; The date and time when the status was last updated.
    • StatusCode; string; The status code of the scoring model.
    • StatusMessage; string; The status message of the scoring model.
    • StatusUpdateTime; string; The date and time when the status was last updated.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : scoringModels
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : scoringModels-item-response
Type: object
Show Source
Nested Schema : Scoring Details
Type: array
Title: Scoring Details
The scoring details resource is used to view and create a scoring detail. It defines the object and attribute that the scoring will be calculated on.
Show Source
Nested Schema : scoringModels-ScoringDetail-item-response
Type: object
Show Source
Nested Schema : Scoring Weights
Type: array
Title: Scoring Weights
The scoring weights resource is used to view and create a scoring weight. It defines the condition and the score weight.
Show Source
Nested Schema : scoringModels-ScoringDetail-ScoringWeight-item-response
Type: object
Show Source
Back to Top