Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての機械学習モデルを入手

get

/crmRestApi/resources/11.13.18.05/salesMLModels

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します
- PrimaryKey主キーを使用して機械学習モデルを見つけます。
  ファインダ変数
  - JobId; integer; モデルの検索に使用される一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdditionalMetadata; string; レコードのオブジェクト・バージョン番号。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- CriteriaFilterExpr; string; エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
- JobDescription; string;モデルの説明。
- JobId; integer;モデルの一意の識別子。
- JobName; string;機械学習モデルの名前。
- LastUpdateDate; string; モデル・レコードが最後に更新された日付。
- LastUpdateLogin; string;モデルを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; モデルを最後に更新したユーザー。
- NumofFeatures; integer;モデルに対して選択した属性の数。
- ObjectVersionNumber; integer;レコードのオブジェクト・バージョン番号。
- スケジュール;文字列;機械学習実験の実行に使用されるスケジュール。
- ステータス、文字列。機械学習モデルのステータス。
- StorePredProbColumnName; string;予測値として格納された販売機械学習モデルの結果。
- StorePredSchedule; string; セールス機械学習モデルの実行時に予測を格納する機能。
- StorePredValueColumnName; string;セールス機械学習モデルの予測値を格納する列の名前。
- StorePrediction; string; セールス機械学習モデルの実行時に予測を格納する機能。
- UsecaseCode; string;ユースケースの検索に使用されるユースケースの一意の識別子。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : salesMLModels

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object salesMLModels-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : salesMLModels-item-response

タイプ: object

ソースを表示

AdditionalMetadata: string

レコードのオブジェクト・バージョン番号。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
CriteriaFilterExpr: string

エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
DebugFlag: boolean

モデルがデバッグ・モードかどうかを示します。
DebugMessage: string

デバッグ・モードに関連付けられたメッセージ。
DeployFlag: boolean

フィールドをデプロイできるかどうかを示します。
JobDescription: string

最大長: 1040

モデルの説明。
JobId: integer (int64)

モデルの一意の識別子。
JobName: string

最大長: 2000

機械学習モデルの名前。
JobStatus: string

最大長: 255

機械学習モデルのステータス。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
NumofFeatures: integer

モデルの選択した属性の数。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
QueryMetadata: string

モデルに関連付けられた問合せの詳細。
QueryResultSet: string

モデルに関連付けられている問合せの結果。
Schedule: string

最大長: 1000

機械学習実験の実行に使用されるスケジュール。
Status: string

最大長: 80

機械学習モデルのステータス。
StorePredCriteriaFilter: string

販売機械学習モデルの予測データセットを定義し、予測を格納するためのフィルタ基準。
StorePrediction: string

最大長: 1

営業機械学習モデルの実行時に予測を格納する機能。
StorePredProbColumnName: string

最大長: 60

予測値として格納された販売機械学習モデルの結果。
StorePredSchedule: string

最大長: 1000

営業機械学習モデルの実行時に予測を格納する機能。
StorePredValueColumnName: string

最大長: 60

販売機械学習モデルの予測値を格納する列の名前。
SubmitFlag: boolean

モデルを発行できるかどうかを示します。
UsecaseCode: string

最大長: 200

ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
UsecaseName: string

ユースケースの名前。
ZcaOmlFixedFieldRules: array Model Validation and Transformation Rules

タイトル: Model Validation and Transformation Rules

モデル検証および変換ルール
ZcaOmlJobsSelFields: array Model Selected Fields

タイトル: Model Selected Fields

モデル選択済フィールド
ZcaOmlJobStatistics: array Machine Learning Job Statistics Details

タイトル: Machine Learning Job Statistics Details

モデル統計
ZcaOmlUsecaseFixedFields: array Use Case Selected Fields

タイトル: Use Case Selected Fields

Sales Machine Learningの選択した機能

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueryMetadata":{
            "type":"string",
            "description":"The details of the query associated with the model.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ZcaOmlFixedFieldRules":{
            "title":"Model Validation and Transformation Rules",
            "type":"array",
            "description":"Model Validation and Transformation Rules",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlFixedFieldRules-item-response"
            }
        },
        "SubmitFlag":{
            "type":"boolean",
            "description":"Indicates if the model can be submitted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CriteriaFilterExpr":{
            "type":"string",
            "description":"A previously defined object filter criteria and mapping that specifies the list of records that will be exported.",
            "nullable":true,
            "x-queryable":true
        },
        "JobName":{
            "maxLength":2000,
            "type":"string",
            "description":"The name of the machine learning model.",
            "nullable":false,
            "x-queryable":true
        },
        "DeployFlag":{
            "type":"boolean",
            "description":"Indicates if the field can be deployed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StorePredProbColumnName":{
            "maxLength":60,
            "type":"string",
            "description":"The outcome of the sales machine learning model stored as prediction value.",
            "nullable":true,
            "x-queryable":true
        },
        "QueryResultSet":{
            "type":"string",
            "description":"The results of the query associated with the model.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobStatus":{
            "maxLength":255,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true,
            "x-queryable":false
        },
        "JobDescription":{
            "maxLength":1040,
            "type":"string",
            "description":"The description of the model.",
            "nullable":true,
            "x-queryable":true
        },
        "StorePredValueColumnName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the column to store prediction value for sales machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ZcaOmlJobsSelFields":{
            "title":"Model Selected Fields",
            "type":"array",
            "description":"Model Selected Fields",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ZcaOmlUsecaseFixedFields":{
            "title":"Use Case Selected Fields",
            "type":"array",
            "description":"Sales Machine Learning Selected Features",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlUsecaseFixedFields-item-response"
            }
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DebugMessage":{
            "type":"string",
            "description":"The message associated with the debug mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "StorePrediction":{
            "maxLength":1,
            "type":"string",
            "description":"The ability to store predictions when executing a sales machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DebugFlag":{
            "type":"boolean",
            "description":"Indicates if the model is in debug mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StorePredSchedule":{
            "maxLength":1000,
            "type":"string",
            "description":"The ability to store predictions when executing a sales machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "UsecaseName":{
            "type":"string",
            "description":"The name of the use case.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UsecaseCode"
                ]
            }
        },
        "Schedule":{
            "maxLength":1000,
            "type":"string",
            "description":"The schedule used to run the machine learning experiment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "nullable":true,
            "x-queryable":true
        },
        "NumofFeatures":{
            "type":"integer",
            "description":"The number of selected attributes for the model.",
            "nullable":true,
            "x-queryable":true
        },
        "ZcaOmlJobStatistics":{
            "title":"Machine Learning Job Statistics Details",
            "type":"array",
            "description":"Model Statistics",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobStatistics-item-response"
            }
        },
        "StorePredCriteriaFilter":{
            "type":"string",
            "description":"The filter criteria to define the prediction data-set and store predictions for sales machine learning model.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : モデル検証および変換ルール

タイプ: array

タイトル: Model Validation and Transformation Rules

モデル検証および変換ルール

ソースを表示

Array of: object salesMLModels-ZcaOmlFixedFieldRules-item-response

{
    "title":"Model Validation and Transformation Rules",
    "type":"array",
    "description":"Model Validation and Transformation Rules",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlFixedFieldRules-item-response"
    }
}

ネストされたスキーマ : モデル選択済フィールド

タイプ: array

タイトル: Model Selected Fields

モデル選択済フィールド

ソースを表示

Array of: object salesMLModels-ZcaOmlJobsSelFields-item-response

{
    "title":"Model Selected Fields",
    "type":"array",
    "description":"Model Selected Fields",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-item-response"
    }
}

ネストされたスキーマ : 機械学習ジョブ統計詳細

タイプ: array

タイトル: Machine Learning Job Statistics Details

モデル統計

ソースを表示

Array of: object salesMLModels-ZcaOmlJobStatistics-item-response

{
    "title":"Machine Learning Job Statistics Details",
    "type":"array",
    "description":"Model Statistics",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobStatistics-item-response"
    }
}

ネストされたスキーマ : ユースケース選択フィールド

タイプ: array

タイトル: Use Case Selected Fields

Sales Machine Learningの選択した機能

ソースを表示

Array of: object salesMLModels-ZcaOmlUsecaseFixedFields-item-response

{
    "title":"Use Case Selected Fields",
    "type":"array",
    "description":"Sales Machine Learning Selected Features",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlUsecaseFixedFields-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : salesMLModels-ZcaOmlFixedFieldRules-item-response

タイプ: object

ソースを表示

AdditionalMetadata: 文字列(バイト)

機械学習モデルに関する追加の詳細。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
FieldName: string

最大長: 200

シノニムに関連付けられたrootキーワード。
FieldRuleCode: string

最大長: 800

ルールの一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
RuleCode: string

最大長: 200

ルールの一意の識別子。
RuleValue: 文字列(バイト)

モデルに関連付けられたルールの値。
UsecaseCode: string

最大長: 200

ユース・ケースに関連付けられたコード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleValue":{
            "type":"string",
            "description":"The value of the rule associated with the model.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The code associated with the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldRuleCode":{
            "maxLength":800,
            "type":"string",
            "description":"The unique identifier of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The additional details about the machine learning model.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldName":{
            "maxLength":200,
            "type":"string",
            "description":"The root keyword associated with the synonym.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : salesMLModels-ZcaOmlJobsSelFields-item-response

タイプ: object

ソースを表示

AdditionalMetadata: string

レコードのオブジェクト・バージョン番号。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
FieldDataType: string

最大長: 200

ブール、文字列など、選択したフィールドの日付タイプ。
FieldName: string

最大長: 800

MLモデルに関連付けられているフィールドの名前。
FieldTitle: string

最大長: 800

使用可能なフィールドの表示名。
IsFeature: string

最大長: 20

フィールドが機能かどうかを示します。有効な値ははい、いいえまたはNULLです。
JobId: integer (int64)

モデルの検索に使用される一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
UsecaseCode: string

最大長: 200

ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
ZcaOmlJobRules: array Model Validation and Transformation Rules

タイトル: Model Validation and Transformation Rules

営業機械学習モデル・ルール

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The date type of the selected field such as boolean, string, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsFeature":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates if the field is a feature or not. The valid values are Yes, No, or Null.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldTitle":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":true,
            "x-queryable":true
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ZcaOmlJobRules":{
            "title":"Model Validation and Transformation Rules",
            "type":"array",
            "description":"Sales Machine Learning Model Rules",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response"
            }
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the field associated with the ML model.",
            "nullable":false,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : モデル検証および変換ルール

タイプ: array

タイトル: Model Validation and Transformation Rules

営業機械学習モデル・ルール

ソースを表示

Array of: object salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response

{
    "title":"Model Validation and Transformation Rules",
    "type":"array",
    "description":"Sales Machine Learning Model Rules",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response"
    }
}

ネストされたスキーマ : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
FieldName: string

最大長: 800

選択したフィールドの名前。
JobId: integer (int64)

モデルの一意の識別子。
JobRuleId: integer (int64)

検証ルールまたは変換ルールの一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
RuleCode: string

最大長: 200

検証ルールまたは変換ルールの一意の識別子。
RuleValue: string

モデルに関連付けられたルールの値。
UsecaseCode: string

最大長: 200

ユース・ケースの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobRuleId":{
            "type":"integer",
            "description":"The unique identifier of the validation or transformation rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleValue":{
            "type":"string",
            "description":"The value of the rule associated with the model.",
            "nullable":true,
            "x-queryable":false
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the selected field.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the validation or transformation rule.",
            "nullable":false,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : salesMLModels-ZcaOmlJobStatistics-item-response

タイプ: object

ソースを表示

AdditionalMetadataJson: string

機械学習モデルの追加のJSON詳細。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
DataSourceName: string

最大長: 700

ユース・ケースに関連付けられているデータ・ソースの名前。
DataSourceSQL: string

ユースケースに関連付けられたデータ・ソースのSQL問合せ。
DataSourceType: string

最大長: 80

ユース・ケースに関連付けられているデータ・ソースのタイプ。
ExplainabilityMetrics: string

モデルとそのパフォーマンスの説明に使用されるメトリック。
JobId: integer (int64)

モデルの検索に使用される一意の識別子。
JobName: string

最大長: 2000

機械学習モデルの名前。
JobRunId: integer (int64)

ジョブ実行の一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ModelAccuracy: string

最大長: 200

機械学習モデルの精度。
ModelStatus: string

最大長: 20

機械学習モデルのステータス。
ModelType: string

最大長: 200

ユース・ケースに関連付けられているモデル・タイプ。モデルのタイプは、実行するタスクによって異なります。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
RangeValues: string

基礎となるモデル属性に指定可能な値の範囲。
SelectedAlgorithm: string

最大長: 200

ユースケース用に選択されたアルゴリズム。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExplainabilityMetrics":{
            "type":"string",
            "description":"The metrics used to explain the model and its performance.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceSQL":{
            "type":"string",
            "description":"The SQL query for the data source associated with the use case.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobName":{
            "maxLength":2000,
            "type":"string",
            "description":"The name of the machine learning model.",
            "nullable":false,
            "x-queryable":true
        },
        "RangeValues":{
            "type":"string",
            "description":"The range of possible values for underlying model attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "ModelAccuracy":{
            "maxLength":200,
            "type":"string",
            "description":"The accuracy of the machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSourceName":{
            "maxLength":700,
            "type":"string",
            "description":"The name of the data source associated with the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "JobRunId":{
            "type":"integer",
            "description":"The unique identifier of the job run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdditionalMetadataJson":{
            "type":"string",
            "description":"The additional JSON details of the machine learning model.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSourceType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of the data source associated with the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ModelType":{
            "maxLength":200,
            "type":"string",
            "description":"The model type associated with the use case. The type of the model depends on the task you want to perform.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SelectedAlgorithm":{
            "maxLength":200,
            "type":"string",
            "description":"The algorithm selected for the use case.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : salesMLModels-ZcaOmlUsecaseFixedFields-item-response

タイプ: object

ソースを表示

AdditionalMetadata: 文字列(バイト)

レコードのオブジェクト・バージョン番号。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
FieldDataType: string

最大長: 200

文字列、ブールなど、フィールドのデータ型。
FieldName: string

最大長: 800

使用可能なフィールドの表示名。
LastUpdateDate: string (date-time)

読取り専用: true

モデル・レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

モデルを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

モデルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

レコードのオブジェクト・バージョン番号。
UsecaseCode: string

最大長: 200

ユース・ケースの検索に使用されるユース・ケースの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The data type of the field such as string, boolean, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":false,
            "x-queryable":true
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

「トップに戻る」