すべてのオブジェクト・ヒントの取得
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints
リクエスト
パス・パラメータ
- OptyNumber(required): string
商談の一意の代替識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ObjectHintsRowFinder : オブジェクト・ヒントの公開一意識別子に基づいてオブジェクト・ヒントを検索します。
ファインダ変数:- ObjectUuid; string;オブジェクト・ヒントの一意の公開識別子。
- ObjectHintsWinProbRowFinder : 獲得確度行に基づいてオブジェクト・ヒントを検索します。
ファインダ変数:- HintCode; string;ヒント識別子。
- ObjectInstanceId; integer;オブジェクト型で指定されたオブジェクトの一意の識別子。
- ObjectType; string;ヒントが適用されるオブジェクト。
- PrimaryKey : 主キーを含むオブジェクト・ヒントを検索します。
ファインダ変数:- ObjectHintId; integer;オブジェクトのヒントの主キー。
- ObjectHintsRowFinder : オブジェクト・ヒントの公開一意識別子に基づいてオブジェクト・ヒントを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- EnabledFlag; boolean;レコードが有効かどうかを示します。 有効の場合はYまたはnull、無効の場合はN。
- EndDate; string; ヒントが終了する日付。
- HintCode; string;ヒントの一意の識別子。
- HintType; string;レコード・タイプ。 たとえば、RECOMMENDATION、WIN_PROBなどです。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- LocalizedDetail; string;ヒントの翻訳された説明および詳細。
- LocalizedSummary; string;ヒントの翻訳された短いサマリー。
- ObjectHintId; integer;オブジェクト・ヒントの一意の識別子。
- ObjectInstanceId; integer; OBJECT_TYPE列で指定されたオブジェクトの一意の識別子。
- ObjectType; string;ヒントが適用されるオブジェクト。例: OPPORTUNITY、LEAD。
- ObjectUuid; string; 代替キーであるオブジェクトの一意の識別子。
- PredWinProb; number; AIエンジンによって予測される受注確度。
- RespResourceId; integer;推奨に関するフィードバックを提供したユーザーのリソースID。
- StartDate; string;ヒントが開始される日付。
- TaskId; integer;推奨事項に対して作成されたタスクの一意の識別子。
- TopHintFlag; boolean。UIに表示する、現在最高ランクの推奨を示します。
- UserResponse; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : opportunities-AiObjectHints
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : 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
推奨に対するユーザーのレスポンス。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- endDateObjectHints
-
パラメータ:
- OptyNumber:
$request.path.OptyNumber
このメソッドを使用すると、関連するアクティブな商談オブジェクトのヒントをすべて検索し、終了日を現在の時間に設定できます。 - OptyNumber: