機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 営業リード
  4. リード評価

リード評価の取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}

リクエスト

パス・パラメータ
  • リード評価の一意の識別子。
  • これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : leads-Assessments-item-response
タイプ: object
ソースを表示
  • Assessment Answer Groups
    タイトル: Assessment Answer Groups
    アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。
  • タイトル: Assessment Language
    最大長: 4
    デフォルト値: US
    リードの評価に使用される言語。
  • タイトル: Assessed Object ID
    アセスメント済ビジネス・オブジェクトの一意の識別子。
  • タイトル: Object Type Code
    最大長: 30
    評価済ビジネス・オブジェクトのタイプを示すコード。
  • タイトル: Assessment ID
    リード評価の一意の識別子。
  • タイトル: Score
    デフォルト値: 0
    リード評価の計算済スコア。
  • タイトル: Template Name
    この資格のソースとして機能したリード評価テンプレートの一意の識別子。
  • タイトル: Business Unit
    リード評価の作成に必要なビジネス・ユニットで、ビジネス・オブジェクトのビジネス・ユニットに対応します。
  • タイトル: Conflict ID
    デフォルト値: 0
    この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    見込み客認定テンプレート・レコードを作成したユーザー。
  • タイトル: Last Updated Date
    読取り専用: true
    見込み客認定テンプレート・レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    見込み客認定テンプレート・レコードを最後に更新したユーザー。
  • Links
  • タイトル: Name
    最大長: 255
    見込み客認定の名前。
  • タイトル: Feedback
    読取り専用: true
    リードの評点にマップされたフィードバック。
  • タイトル: Rating
    読取り専用: true
    関連するリード評価テンプレートで構成された資格の総合評点。
  • タイトル: Status
    最大長: 30
    デフォルト値: INCOMPLETE
    リード評価の有効なステータスを示すコード。 有効な値は、IN_PROGRESSおよびCOMPLETEです。
  • タイトル: Status
    読取り専用: true
    資格のステータス。
  • タイトル: Template
    リード評価テンプレートの名前。
  • タイトル: Template Type
    資格に関連付けられたリード評価テンプレートのオブジェクト・タイプ。
  • タイトル: Total Questions Answered
    資格で応答された質問の数。
  • タイトル: Total Questions
    資格で回答する質問の合計数。
ネストされたスキーマ : アセスメント回答グループ
タイプ: array
タイトル: Assessment Answer Groups
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。
ソースを表示
ネストされたスキーマ : leads-Assessments-AssessAnswerGroups-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : アセスメント回答
タイプ: array
タイトル: Assessment Answers
アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response
タイプ: object
ソースを表示
リンク
AssessAnswerGroups
パラメータ:
  • AssessmentId: $request.path.AssessmentId
  • leadsUniqID: $request.path.leadsUniqID
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。
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 GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"AssessmentId": 300100104003366,
"BusinessUnit": null,
"AssessTemplateId": 300100104003343,
"Name": "Lead Qualification for CMS Server V1",
"AssessedLanguage": "US",
"StatusCode": "INCOMPLETE",
"AssessmentScore": 0,
"AssessedObjectId": 300100097576277,
"AssessedObjTypeCode": "LEAD",
"LastUpdateDate": "2017-03-28T06:09:37-07:00",
"CreatedBy": "MHoope",
"LastUpdatedBy": "MHoope",
"TemplateName": "Lead Qualification for CMS Server",
"TemplateType": "LEAD",
"TotalQuestions": 5,
"TotalAnswered": 0,
"StatusFuse": "FUSE_STATUS_NOT_STARTED",
"RatingTerm": "Poor",
"RatingFeedback": "The lead is unlikely to be qualified",
"links": [
  {
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366",
"name": "Assessments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366",
"name": "Assessments",
"kind": "item"
},
  {
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277",
"name": "leads",
"kind": "item"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/CommonObjectsMappingPVO1",
"name": "CommonObjectsMappingPVO1",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/AssessmentTemplateVA",
"name": "AssessmentTemplateVA",
"kind": "collection"
},
  {
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/lov/LookupPVO1",
"name": "LookupPVO1",
"kind": "collection"
},
  {
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/300100104003366/child/AssessAnswerGroups",
"name": "AssessAnswerGroups",
"kind": "collection"
}
],
}
「トップに戻る」