評価を受ける
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
リクエスト
パス・パラメータ
- AssessmentId(required): integer(int64)
アセスメントの一意の識別子。
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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-Assessments-item-response
タイプ:
ソースを表示
object-
AssessAnswerGroups: array Assessment Answer Groups
タイトル:
Assessment Answer Groupsアセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。 -
AssessedLanguage: string
タイトル:
Assessment Language最大長:4デフォルト値:USアセスメントの言語。 -
AssessedObjectId: integer (int64)
タイトル:
Assessed Object IDアセスメント済ビジネス・オブジェクトの一意の識別子。 -
AssessedObjTypeCode: string
タイトル:
Object Type Code最大長:30査定済ビジネス・オブジェクトのタイプを示すコード。 -
AssessmentId: integer (int64)
タイトル:
Assessment IDアセスメントの一意の識別子。 -
AssessmentScore: integer (int64)
タイトル:
Scoreデフォルト値:0査定の計算済スコア。 -
AssessTemplateId: integer (int64)
タイトル:
Template Nameこのアセスメントのソースとして機能したアセスメント・テンプレートの一意の識別子。 -
BusinessUnit: integer (int64)
タイトル:
Business Unit査定の作成時に渡されるビジネス・ユニットの名前で、ビジネス・オブジェクトのビジネス・ユニットに対応します。 -
ConflictId: integer (int64)
タイトル:
Conflict IDデフォルト値:0モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64アセスメント・レコードを作成したユーザー。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:true査定レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64アセスメント・レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name最大長:255アセスメントの名前。 -
RatingFeedback: string
タイトル:
Feedback読取り専用:true評点にマップされたフィードバック。 -
RatingTerm: string
タイトル:
Rating読取り専用:true関連付けられたアセスメント・テンプレートで構成されたアセスメントの総合評点。 -
StatusCode: string
タイトル:
Status最大長:30デフォルト値:INCOMPLETEアセスメントの有効なステータスを示すコード。 有効な値は、IN_PROGRESSおよびCOMPLETEです。 -
StatusFuse: string
タイトル:
Status読取り専用:trueアセスメントのステータス。 -
TemplateName: string
タイトル:
Templateアセスメント・テンプレートの名前。 -
TemplateType: string
タイトル:
Template Typeアセスメントに関連付けられたアセスメント・テンプレートのタイプ。 -
TotalAnswered: number
タイトル:
Total Questions Answeredアセスメントで回答された質問の数。 -
TotalQuestions: number
タイトル:
Total Questionsアセスメントで回答する質問の合計数。
ネストされたスキーマ : アセスメント回答グループ
タイプ:
arrayタイトル:
Assessment Answer Groupsアセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : opportunities-Assessments-AssessAnswerGroups-item-response
タイプ:
ソースを表示
object-
AssessAnswerGroupId: integer (int64)
アンサー・グループの一意の識別子。
-
AssessmentAnswer: array Assessment Answers
タイトル:
Assessment Answersアセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。 -
AssessmentId: integer (int64)
アンサー・グループに関連付けられたアセスメントの一意の識別子。
-
AttributeGroupId: integer (int64)
関連テンプレートの質問グループの一意の識別子。
-
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Name: string
読取り専用:
true回答グループの名前。
ネストされたスキーマ : アセスメント回答
タイプ:
arrayタイトル:
Assessment Answersアセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response
タイプ:
ソースを表示
object-
Answered: string
質問が回答済かどうかを示します。
-
AnswerId: integer (int64)
アセスメント回答の一意の識別子。
-
AssessmentId: integer (int64)
アンサーに関連付けられたアセスメントの一意の識別子。
-
AttributeGroupId: integer (int64)
タイトル:
Question Groupアセスメント回答に関連付けられた質問グループの一意の識別子。 -
AttributeId: integer (int64)
タイトル:
Questionアセスメント回答に関連付けられた質問の一意の識別子。 -
AttributeName: string
読取り専用:
true最大長:500質問の名前。 -
AttributeValueId: integer (int64)
タイトル:
Responseレスポンスの一意の識別子。 -
Comments: string
タイトル:
Comments最大長:1500エンド・ユーザーが入力したアセスメント・ランタイム・コメント。 -
HasComments: string
コメントが存在するかどうかを示します。
-
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
ResponseValue: string
タイトル:
Response読取り専用:true質問に対するレスポンス。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- AssessAnswerGroups
-
パラメータ:
- AssessmentId:
$request.path.AssessmentId - OptyNumber:
$request.path.OptyNumber
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。 - AssessmentId:
- AssessmentTemplateVA
-
パラメータ:
- ファインダ:
AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}
アセスメント・テンプレート・リソースは、アセスメント・テンプレートの表示に使用されます。 アセスメントに関連付けられたテンプレートが格納されます。 - ファインダ:
- LookupPVO1
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、評価を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/300100090218733/child/Assessments/300100090190738
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"items" : [ {
"AssessmentId" : 300100090201738,
"BusinessUnit" : 1,
"AssessTemplateId" : 100000012061095,
"Name" : "Rest -121",
"AssessedLanguage" : "US",
"StatusCode" : "INCOMPLETE",
"AssessmentScore" : 0,
"AssessedObjectId" : 300100070256132,
"RelatedObjectId" : null,
"RelatedObjTypeCode" : "OPPORTUNITY",
"AssessedObjTypeCode" : "OPPORTUNITY",
"LastUpdateDate" : "2016-11-04T05:11:25-07:00",
"CreatedBy" : "SALES_ADMIN",
"LastUpdatedBy" : "SALES_ADMIN",
"TemplateName" : "Customer Discount Eligibility",
"TemplateType" : "OPPORTUNITY",
"NumberOfGroups" : 0,
"TotalQuestions" : 0,
"TotalAnswered" : 0,
"StatusFuse" : "FUSE_STATUS_NOT_STARTED",
"links" : [ {
... }
]
}