ユースケースの更新
patch
/crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}
リクエスト
パス・パラメータ
- UsecaseCode(required): string
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
レコードのオブジェクト・バージョン番号。
-
CriteriaFilterExpr: string
エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
-
DataSourceName: string
最大長:
700
ユース・ケースに関連付けられているデータ・ソースの名前。 -
DataSourcePk: string
最大長:
200
ユース・ケースに関連付けられているデータ・ソースの一意の識別子。 -
DataSourceType: string
最大長:
80
ユース・ケースに関連付けられているデータ・ソースのタイプ。 -
ModelType: string
最大長:
200
ユース・ケースに関連付けられているモデル・タイプ。 モデルのタイプは、実行するタスクによって異なります。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
ShowuiFlag: boolean
最大長:
1
この処理が内部かどうかを示すブール型。 -
TargetColumn: string
最大長:
200
ユースケースのターゲット列。 -
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
UsecaseDescription: string
最大長:
2000
タスク情報を含むユースケースの説明。 -
UsecaseName: string
最大長:
800
ユースケースの名前。 -
ZcaOmlFixedFieldRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール -
ZcaOmlJobs: array Sales Machine Learning Models
タイトル:
Sales Machine Learning Models
営業機械学習モデル -
ZcaOmlUsecaseAvailableFields: array Use Case Available Fields
タイトル:
Use Case Available Fields
Sales Machine Learningで使用可能な機能 -
ZcaOmlUsecaseFixedFields: array Use Case Selected Fields
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール
ソースを表示
ネストされたスキーマ : ユースケース使用可能フィールド
タイプ:
array
タイトル:
Use Case Available Fields
Sales Machine Learningで使用可能な機能
ソースを表示
ネストされたスキーマ : ユースケース選択フィールド
タイプ:
array
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
機械学習モデルに関する追加の詳細。
-
FieldName: string
最大長:
200
シノニムに関連付けられたrootキーワード。 -
FieldRuleCode: string
最大長:
800
ルールの一意の識別子。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
RuleCode: string
最大長:
200
ルールの一意の識別子。 -
RuleValue: 文字列(バイト)
モデルに関連付けられたルールの値。
-
UsecaseCode: string
最大長:
200
ユース・ケースに関連付けられたコード。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
CriteriaFilterExpr: string
エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
-
DebugFlag: boolean
モデルがデバッグ・モードかどうかを示します。
-
DebugMessage: string
デバッグ・モードに関連付けられたメッセージ。
-
DeployFlag: boolean
フィールドをデプロイできるかどうかを示します。
-
JobDescription: string
最大長:
1040
モデルの説明。 -
JobId: integer (int64)
モデルの一意の識別子。
-
JobName: string
最大長:
2000
機械学習モデルの名前。 -
JobStatus: string
最大長:
255
機械学習モデルのステータス。 -
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
ユースケースの名前。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
FieldDataType: string
ブール、文字列など、選択したフィールドの日付タイプ。
-
FieldName: string
モデルに関連付けられているフィールドの名前。
-
FieldTitle: string
使用可能なフィールドの表示名。
-
JobId: string
機械学習モデルの一意の識別子。
-
UsecaseCode: string
最大長:
255
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
ネストされたスキーマ : salesMLUsecases-ZcaOmlUsecaseFixedFields-item-patch-request
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
レコードのオブジェクト・バージョン番号。
-
FieldDataType: string
最大長:
200
文字列、ブールなど、フィールドのデータ型。 -
FieldName: string
最大長:
800
使用可能なフィールドの表示名。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : salesMLUsecases-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: 文字列(バイト)
レコードのオブジェクト・バージョン番号。
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
CriteriaFilterExpr: string
エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
-
DataSourceName: string
最大長:
700
ユース・ケースに関連付けられているデータ・ソースの名前。 -
DataSourcePk: string
最大長:
200
ユース・ケースに関連付けられているデータ・ソースの一意の識別子。 -
DataSourceType: string
最大長:
80
ユース・ケースに関連付けられているデータ・ソースのタイプ。 -
LastUpdateDate: string (date-time)
読取り専用:
true
モデル・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
モデルを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
モデルを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ModelType: string
最大長:
200
ユース・ケースに関連付けられているモデル・タイプ。 モデルのタイプは、実行するタスクによって異なります。 -
ObjectVersionNumber: 整数(int32)
レコードのオブジェクト・バージョン番号。
-
ShowuiFlag: boolean
最大長:
1
この処理が内部かどうかを示すブール型。 -
TargetColumn: string
最大長:
200
ユースケースのターゲット列。 -
UsecaseCode: string
最大長:
200
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。 -
UsecaseDescription: string
最大長:
2000
タスク情報を含むユースケースの説明。 -
UsecaseName: string
最大長:
800
ユースケースの名前。 -
ZcaOmlFixedFieldRules: array Model Validation and Transformation Rules
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール -
ZcaOmlJobs: array Sales Machine Learning Models
タイトル:
Sales Machine Learning Models
営業機械学習モデル -
ZcaOmlUsecaseAvailableFields: array Use Case Available Fields
タイトル:
Use Case Available Fields
Sales Machine Learningで使用可能な機能 -
ZcaOmlUsecaseFixedFields: array Use Case Selected Fields
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ネストされたスキーマ : モデル検証および変換ルール
タイプ:
array
タイトル:
Model Validation and Transformation Rules
モデル検証および変換ルール
ソースを表示
ネストされたスキーマ : ユースケース使用可能フィールド
タイプ:
array
タイトル:
Use Case Available Fields
Sales Machine Learningで使用可能な機能
ソースを表示
ネストされたスキーマ : ユースケース選択フィールド
タイプ:
array
タイトル:
Use Case Selected Fields
Sales Machine Learningの選択した機能
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : salesMLUsecases-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
ユース・ケースに関連付けられたコード。
ネストされたスキーマ : salesMLUsecases-ZcaOmlJobs-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
ユースケースの名前。
ネストされたスキーマ : salesMLUsecases-ZcaOmlUsecaseAvailableFields-item-response
タイプ:
ソースを表示
object
-
AdditionalMetadata: string
レコードのオブジェクト・バージョン番号。
-
FieldDataType: string
ブール、文字列など、選択したフィールドの日付タイプ。
-
FieldName: string
モデルに関連付けられているフィールドの名前。
-
FieldTitle: string
使用可能なフィールドの表示名。
-
JobId: string
機械学習モデルの一意の識別子。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
UsecaseCode: string
最大長:
255
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
ネストされたスキーマ : salesMLUsecases-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
ユース・ケースの検索に使用されるユース・ケースの一意の識別子。
リンク
- ZcaOmlFixedFieldRules
-
パラメータ:
- UsecaseCode:
$request.path.UsecaseCode
モデル検証および変換ルール - UsecaseCode:
- ZcaOmlJobs
-
パラメータ:
- UsecaseCode:
$request.path.UsecaseCode
営業機械学習モデル - UsecaseCode:
- ZcaOmlUsecaseAvailableFields
-
操作: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFieldsパラメータ:
- UsecaseCode:
$request.path.UsecaseCode
Sales Machine Learningで使用可能な機能 - UsecaseCode:
- ZcaOmlUsecaseFixedFields
-
パラメータ:
- UsecaseCode:
$request.path.UsecaseCode
Sales Machine Learningの選択した機能 - UsecaseCode: