機械翻訳について

ジャンプ先

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

オブジェクト・ヒントの更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}

リクエスト

パス・パラメータ

• ObjectHintId(required): integer(int64)
  オブジェクト・ヒントの一意の識別子。
• OptyNumber(required): string
  商談の一意の代替識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EndDate: string (date-time)
  タイトル: End Date

  ヒントが終了する日付。
• 説明: 文字列(バイト)
  AIモデルからの予測の背後にある推論の説明テキスト。
• PredWinProb: number
  タイトル: Predicted Win Probability

  AIエンジンによって予測される受注確度。
• RespResourceId: integer (int64)
  タイトル: Response Resource ID

  推奨に関するフィードバックを提供したユーザーのリソースID。
• StartDate: string (date-time)
  ヒントが開始する日付。
• TaskId: integer (int64)
  推奨に対して作成されたタスクの一意の識別子。
• TopHintFlag: boolean
  最大長: 1

  UIに表示する現在の最上位ランク推奨を示します。
• UserResponse: string
  タイトル: User Response

  最大長: 1

  推奨に対するユーザーのレスポンス。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The date when the hint starts.",
            "format":"date-time",
            "nullable":true
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"The win probability predicted by the AI engine.",
            "nullable":true
        },
        "UserResponse":{
            "title":"User Response",
            "maxLength":1,
            "type":"string",
            "description":"The user's response to a recommendation.",
            "nullable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task that was created for the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Explanations":{
            "type":"string",
            "description":"The explanatory text for the reasoning behind predictions from the AI models.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TopHintFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the current highest ranked recommendation to display in the UI.",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the hint ends.",
            "format":"date-time",
            "nullable":true
        },
        "RespResourceId":{
            "title":"Response Resource ID",
            "type":"integer",
            "description":"The resource ID of the user who provided feedback on the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : opportunities-AiObjectHints-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• EnabledFlag: boolean
  タイトル: Enabled

  読取り専用: true

  最大長: 1

  レコードが使用可能かどうかを示します。 有効の場合はYまたはnull、無効の場合はN。
• EndDate: string (date-time)
  タイトル: End Date

  ヒントが終了する日付。
• 説明: 文字列(バイト)
  AIモデルからの予測の背後にある推論の説明テキスト。
• HintCode: string
  タイトル: Hint Code

  最大長: 10

  ヒントの一意の識別子。
• HintType: string
  タイトル: Hint Type

  読取り専用: true

  最大長: 30

  レコード・タイプ。 たとえば、RECOMMENDATION、WIN_PROBなどです。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LocalizedDetail: string
  タイトル: Explanation

  読取り専用: true

  最大長: 255

  ヒントの翻訳済説明および詳細。
• LocalizedSummary: string
  タイトル: Action

  読取り専用: true

  最大長: 180

  ヒントの翻訳済要約。
• ObjectHintId: integer (int64)
  タイトル: Object Hint ID

  オブジェクト・ヒントの一意の識別子。
• ObjectInstanceId: integer (int64)
  タイトル: Object ID

  OBJECT_TYPE列で指定されたオブジェクトの一意の識別子。
• ObjectType: string
  タイトル: Object Type

  最大長: 30

  ヒントが適用されるオブジェクト(OPPORTUNITY、LEADなど)。
• ObjectUuid: string
  タイトル: Object Unique ID

  最大長: 50

  代替キーであるオブジェクトの一意の識別子。
• PredWinProb: number
  タイトル: Predicted Win Probability

  AIエンジンによって予測される受注確度。
• RespResourceId: integer (int64)
  タイトル: Response Resource ID

  推奨に関するフィードバックを提供したユーザーのリソースID。
• StartDate: string (date-time)
  ヒントが開始する日付。
• TaskId: integer (int64)
  推奨に対して作成されたタスクの一意の識別子。
• TopHintFlag: boolean
  最大長: 1

  UIに表示する現在の最上位ランク推奨を示します。
• UserResponse: string
  タイトル: User Response

  最大長: 1

  推奨に対するユーザーのレスポンス。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HintType":{
            "title":"Hint Type",
            "maxLength":30,
            "type":"string",
            "description":"The record type. For example, RECOMMENDATION, WIN_PROB, etc.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task that was created for the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocalizedSummary":{
            "title":"Action",
            "maxLength":180,
            "type":"string",
            "description":"The translated short summary of the hint.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectHintId":{
            "title":"Object Hint ID",
            "type":"integer",
            "description":"The unique identifier of the object hint.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TopHintFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the current highest ranked recommendation to display in the UI.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the hint ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RespResourceId":{
            "title":"Response Resource ID",
            "type":"integer",
            "description":"The resource ID of the user who provided feedback on the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":10,
            "type":"string",
            "description":"The unique identifier of the hint.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the hint starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"The win probability predicted by the AI engine.",
            "nullable":true,
            "x-queryable":true
        },
        "UserResponse":{
            "title":"User Response",
            "maxLength":1,
            "type":"string",
            "description":"The user's response to a recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectUuid":{
            "title":"Object Unique ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the object which is an alternate key.",
            "nullable":false,
            "x-queryable":true
        },
        "Explanations":{
            "type":"string",
            "description":"The explanatory text for the reasoning behind predictions from the AI models.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LocalizedDetail":{
            "title":"Explanation",
            "maxLength":255,
            "type":"string",
            "description":"The translated explanation and details for the hint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the record is enabled or not. Y or null for enabled and N for disabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectInstanceId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object specified by OBJECT_TYPE column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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."
        }
    }
}

「トップに戻る」