機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

機械学習モデルの作成

post

/crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs

リクエスト

パス・パラメータ

• UsecaseCode(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: 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
  ユースケースの名前。

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true
        },
        "StorePrediction":{
            "maxLength":1,
            "type":"string",
            "description":"The ability to store predictions when executing a sales machine learning model.",
            "nullable":true
        },
        "QueryMetadata":{
            "type":"string",
            "description":"The details of the query associated with the model.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DebugFlag":{
            "type":"boolean",
            "description":"Indicates if the model is in debug mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
        },
        "JobName":{
            "maxLength":2000,
            "type":"string",
            "description":"The name of the machine learning model.",
            "nullable":false
        },
        "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
        },
        "StorePredSchedule":{
            "maxLength":1000,
            "type":"string",
            "description":"The ability to store predictions when executing a sales machine learning model.",
            "nullable":true
        },
        "QueryResultSet":{
            "type":"string",
            "description":"The results of the query associated with the model.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UsecaseName":{
            "type":"string",
            "description":"The name of the use case.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UsecaseCode"
                ]
            }
        },
        "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"
            }
        },
        "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
        },
        "StorePredValueColumnName":{
            "maxLength":60,
            "type":"string",
            "description":"The name of the column to store prediction value for sales machine learning model.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Schedule":{
            "maxLength":1000,
            "type":"string",
            "description":"The schedule used to run the machine learning experiment.",
            "nullable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "nullable":true
        },
        "NumofFeatures":{
            "type":"integer",
            "description":"The number of selected attributes for the model.",
            "nullable":true
        },
        "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
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DebugMessage":{
            "type":"string",
            "description":"The message associated with the debug mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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
  ユースケースの名前。

{
    "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
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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"
    }
}

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

タイプ: 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."
        }
    }
}

「トップに戻る」