Get all machine learning models
get
/crmRestApi/resources/11.13.18.05/salesMLModels
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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- PrimaryKey Find machine learning model using primary key.
Finder Variables- JobId; integer; The unique identifier used to find the model.
- PrimaryKey Find machine learning model using primary key.
-
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.
-
links: string
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 -
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 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
-
q: string
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:- AdditionalMetadata; string; The object version number for the record.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CriteriaFilterExpr; string; A previously defined object filter criteria and mapping that specifies the list of records that will be exported.
- JobDescription; string; The description of the model.
- JobId; integer; The unique identifier of the model.
- JobName; string; The name of the machine learning model.
- LastUpdateDate; string; The date when the model record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the model.
- LastUpdatedBy; string; The user who last updated the model.
- NumofFeatures; integer; The number of selected attributes for the model.
- ObjectVersionNumber; integer; The object version number for the record.
- Schedule; string; The schedule used to run the machine learning experiment.
- Status; string; The status of the machine learning model.
- StorePredProbColumnName; string; The outcome of the sales machine learning model stored as prediction value.
- StorePredSchedule; string; The ability to store predictions when executing a sales machine learning model.
- StorePredValueColumnName; string; The name of the column to store prediction value for sales machine learning model.
- StorePrediction; string; The ability to store predictions when executing a sales machine learning model.
- UsecaseCode; string; The unique identifier of the use case used to find a use case.
-
totalResults: boolean
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : salesMLModels
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CriteriaFilterExpr: string
A previously defined object filter criteria and mapping that specifies the list of records that will be exported.
-
DebugFlag: boolean
Indicates if the model is in debug mode.
-
DebugMessage: string
The message associated with the debug mode.
-
DeployFlag: boolean
Indicates if the field can be deployed.
-
JobDescription: string
Maximum Length:
1040
The description of the model. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobName: string
Maximum Length:
2000
The name of the machine learning model. -
JobStatus: string
Maximum Length:
255
The status of the machine learning model. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumofFeatures: integer
The number of selected attributes for the model.
-
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
QueryMetadata: string
The details of the query associated with the model.
-
QueryResultSet: string
The results of the query associated with the model.
-
Schedule: string
Maximum Length:
1000
The schedule used to run the machine learning experiment. -
Status: string
Maximum Length:
80
The status of the machine learning model. -
StorePredCriteriaFilter: string
The filter criteria to define the prediction data-set and store predictions for sales machine learning model.
-
StorePrediction: string
Maximum Length:
1
The ability to store predictions when executing a sales machine learning model. -
StorePredProbColumnName: string
Maximum Length:
60
The outcome of the sales machine learning model stored as prediction value. -
StorePredSchedule: string
Maximum Length:
1000
The ability to store predictions when executing a sales machine learning model. -
StorePredValueColumnName: string
Maximum Length:
60
The name of the column to store prediction value for sales machine learning model. -
SubmitFlag: boolean
Indicates if the model can be submitted.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
UsecaseName: string
The name of the use case.
-
ZcaOmlFixedFieldRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules -
ZcaOmlJobsSelFields: array
Model Selected Fields
Title:
Model Selected Fields
Model Selected Fields -
ZcaOmlJobStatistics: array
Machine Learning Job Statistics Details
Title:
Machine Learning Job Statistics Details
Model Statistics -
ZcaOmlUsecaseFixedFields: array
Use Case Selected Fields
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Model Validation and Transformation Rules
Show Source
Nested Schema : Model Selected Fields
Type:
array
Title:
Model Selected Fields
Model Selected Fields
Show Source
Nested Schema : Machine Learning Job Statistics Details
Type:
array
Title:
Machine Learning Job Statistics Details
Model Statistics
Show Source
Nested Schema : Use Case Selected Fields
Type:
array
Title:
Use Case Selected Fields
Sales Machine Learning Selected Features
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesMLModels-ZcaOmlFixedFieldRules-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The additional details about the machine learning model.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldName: string
Maximum Length:
200
The root keyword associated with the synonym. -
FieldRuleCode: string
Maximum Length:
800
The unique identifier of the rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the rule. -
RuleValue: string
(byte)
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The code associated with the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlJobsSelFields-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldDataType: string
Maximum Length:
200
The date type of the selected field such as boolean, string, and so on. -
FieldName: string
Maximum Length:
800
The name of the field associated with the ML model. -
FieldTitle: string
Maximum Length:
800
The display name of the available field. -
IsFeature: string
Maximum Length:
20
Indicates if the field is a feature or not. The valid values are Yes, No, or Null. -
JobId: integer
(int64)
The unique identifier used to find the model.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case. -
ZcaOmlJobRules: array
Model Validation and Transformation Rules
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Model Validation and Transformation Rules
Type:
array
Title:
Model Validation and Transformation Rules
Sales Machine Learning Model Rules
Show Source
Nested Schema : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldName: string
Maximum Length:
800
The name of the selected field. -
JobId: integer
(int64)
The unique identifier of the model.
-
JobRuleId: integer
(int64)
The unique identifier of the validation or transformation rule.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RuleCode: string
Maximum Length:
200
The unique identifier of the validation or transformation rule. -
RuleValue: string
The value of the rule associated with the model.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlJobStatistics-item-response
Type:
Show Source
object
-
AdditionalMetadataJson: string
The additional JSON details of the machine learning model.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DataSourceName: string
Maximum Length:
700
The name of the data source associated with the use case. -
DataSourceSQL: string
The SQL query for the data source associated with the use case.
-
DataSourceType: string
Maximum Length:
80
The type of the data source associated with the use case. -
ExplainabilityMetrics: string
The metrics used to explain the model and its performance.
-
JobId: integer
(int64)
The unique identifier used to find the model.
-
JobName: string
Maximum Length:
2000
The name of the machine learning model. -
JobRunId: integer
(int64)
The unique identifier of the job run.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelAccuracy: string
Maximum Length:
200
The accuracy of the machine learning model. -
ModelStatus: string
Maximum Length:
20
The status of the machine learning model. -
ModelType: string
Maximum Length:
200
The model type associated with the use case. The type of the model depends on the task you want to perform. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
RangeValues: string
The range of possible values for underlying model attributes.
-
SelectedAlgorithm: string
Maximum Length:
200
The algorithm selected for the use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesMLModels-ZcaOmlUsecaseFixedFields-item-response
Type:
Show Source
object
-
AdditionalMetadata: string
(byte)
The object version number for the record.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FieldDataType: string
Maximum Length:
200
The data type of the field such as string, boolean, and so on. -
FieldName: string
Maximum Length:
800
The display name of the available field. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the model record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the model. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the model. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number for the record.
-
UsecaseCode: string
Maximum Length:
200
The unique identifier of the use case used to find a use case.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source