Machine Learning Use Cases
salesMLUsecases Based on latest (2026.09)
Create, change, delete and look up Machine Learning Use Cases, with zca oml fixed field rules, zca oml jobs and zca oml usecase available fields.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
UsecaseCode- Required on create
DataSourceNameDataSourceTypeModelTypeUsecaseCodeUsecaseDescriptionUsecaseName- At a glance
- 23 fields1 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/salesMLUsecases?fields=AdditionalMetadata,CreatedBy,CreationDate,CriteriaFilterExpr,DataSourceName&limit=25&onlyData=true
{
"items": [
{
"AdditionalMetadata": "<string>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CriteriaFilterExpr": "<string>",
"DataSourceName": "<string, max 700>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 23
| Attribute | Type | Use |
|---|---|---|
AdditionalMetadata | text | Optional on createUpdatable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CriteriaFilterExpr | text | Optional on createUpdatableSearchable |
DataSourceName | text · max 700 | Required on createUpdatableSearchable |
DataSourcePk | text · max 200 | Optional on createUpdatableSearchable |
DataSourceType | text · max 80 | Required on createUpdatableSearchable |
FunctionalArea | text · max 200 | Optional on createUpdatableSearchable |
IsUsecaseGroup | text · max 1 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ModelType | text · max 200 | Required on createUpdatableSearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
PreSeededFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
PreferredTargetValue | text · max 200 | Optional on createUpdatableSearchable |
ReadOnlyFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ShowuiFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TargetColumn | text · max 200 | Optional on createUpdatableSearchable |
UsecaseCode | text · max 200 | Required on createUpdatableSearchable |
UsecaseDescription | text · max 2000 | Required on createUpdatableSearchable |
UsecaseGroupCode | text · max 200 | Optional on createUpdatableSearchable |
UsecaseName | text · max 800 | Required on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ZcaOmlUsecaseAltKey·UsecaseCode
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/<name>. Add them to a GET with expand.
ZcaOmlFixedFieldRulesGET · POST · PATCH · DELETE Model Validation and Transformation Rules · 12 fields · 1 findersAdditionalMetadataCreatedByCreationDateFieldNameFieldRuleCodeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberRuleCodeRuleValueUsecaseCodeZcaOmlJobsGET · POST · PATCH · DELETE Sales Machine Learning Models · 35 fieldsAdditionalMetadataCreatedByCreationDateCriteriaFilterExprDebugFlagDebugMessageDeployFlagFunctionalAreaJobDescriptionJobIdJobNameJobStatusLastUpdateDateLastUpdateLoginLastUpdatedByMinimumClusterProbabilityMinimumJWSimilarityScoreModelOutcomeNumofFeaturesObjectVersionNumberPerformActionPreferredAlgorithmQueryMetadataQueryResultSetScheduleStatusStorePredCriteriaFilterStorePredProbColumnNameStorePredScheduleStorePredSuccessProbColumnStorePredValueColumnNameStorePredictionSubmitFlagUsecaseCodeUsecaseNameZcaOmlUsecaseAvailableFieldsGET · POST · PATCH · DELETE Use Case Available Fields · 6 fieldsAdditionalMetadataFieldDataTypeFieldNameFieldTitleJobIdUsecaseCodeZcaOmlUsecaseFixedFieldsGET · POST · PATCH · DELETE Use Case Selected Fields · 10 fields · 1 findersAdditionalMetadataCreatedByCreationDateFieldDataTypeFieldNameLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberUsecaseCode
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/salesMLUsecasesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ZcaOmlUsecaseAltKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AdditionalMetadata, notadditionalmetadata. - 5 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.