Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

リード評価の作成

post

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

リクエスト

パス・パラメータ

leadsUniqID(required): string

これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

AssessAnswerGroups: array Assessment Answer Groups

タイトル: Assessment Answer Groups

アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。
AssessedLanguage: string

タイトル: Assessment Language

最大長: 4

デフォルト値: US

リードの評価に使用される言語。
AssessedObjectId(required): integer (int64)

タイトル: Assessed Object ID

アセスメント済ビジネス・オブジェクトの一意の識別子。
AssessedObjTypeCode(required): string

タイトル: Object Type Code

最大長: 30

評価済ビジネス・オブジェクトのタイプを示すコード。
AssessmentId: integer (int64)

タイトル: Assessment ID

リード評価の一意の識別子。
AssessmentScore: integer (int64)

タイトル: Score

デフォルト値: 0

リード評価の計算済スコア。
AssessTemplateId(required): integer (int64)

タイトル: Template Name

この資格のソースとして機能したリード評価テンプレートの一意の識別子。
BusinessUnit: integer (int64)

タイトル: Business Unit

リード評価の作成に必要なビジネス・ユニットで、ビジネス・オブジェクトのビジネス・ユニットに対応します。
ConflictId: integer (int64)

タイトル: Conflict ID

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
Name(required): string

タイトル: Name

最大長: 255

見込み客認定の名前。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: INCOMPLETE

リード評価の有効なステータスを示すコード。有効な値は、IN_PROGRESSおよびCOMPLETEです。
TemplateName: string

タイトル: Template

リード評価テンプレートの名前。
TemplateType: string

タイトル: Template Type

資格に関連付けられたリード評価テンプレートのオブジェクト・タイプ。
TotalAnswered: number

タイトル: Total Questions Answered

資格で応答された質問の数。
TotalQuestions: number

タイトル: Total Questions

資格で回答する質問の合計数。

{
    "required":[
        "AssessTemplateId",
        "AssessedObjTypeCode",
        "AssessedObjectId",
        "Name"
    ],
    "type":"object",
    "properties":{
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of assessed business object.",
            "nullable":false
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":4,
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US"
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The object type of the lead qualification template associated with the qualification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of the lead qualification.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISNOTBLANK"
                ],
                "precision":10
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-post-request"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit required to create a lead qualification and corresponds to the business unit of business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TemplateName":{
            "title":"Template",
            "type":"string",
            "description":"The name of the lead qualification template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the lead qualification template that served as the source of this qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : アセスメント回答グループ

タイプ: array

タイトル: Assessment Answer Groups

アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。

ソースを表示

Array of: object leads-Assessments-AssessAnswerGroups-item-post-request

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-post-request"
    }
}

ネストされたスキーマ : leads-Assessments-AssessAnswerGroups-item-post-request

タイプ: object

ソースを表示

AssessAnswerGroupId: integer (int64)

アンサー・グループの一意の識別子。
AssessmentAnswer: array AssessmentAnswer
AssessmentId(required): integer (int64)

アンサー・グループに関連付けられたリード評価テンプレートの一意の識別子。
AttributeGroupId(required): integer (int64)

関連付けられたリード評価テンプレートの質問グループの一意の識別子。

{
    "required":[
        "AssessmentId",
        "AttributeGroupId"
    ],
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated lead qualification template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentAnswer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request"
            }
        }
    }
}

ネストされたスキーマ : AssessmentAnswer

タイプ: array

ソースを表示

Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request"
    }
}

ネストされたスキーマ : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request

タイプ: object

ソースを表示

Answered: string

質問が回答済かどうかを示します。
AnswerId: integer (int64)

資格回答の一意の識別子。
AssessmentId: integer (int64)

回答に関連付けられたリード評価テンプレートの一意の識別子。
AttributeGroupId: integer (int64)

タイトル: Question Group

資格回答に関連付けられた質問グループの一意の識別子。
AttributeId: integer (int64)

タイトル: Question

資格回答に関連付けられた質問の一意の識別子。
AttributeValueId: integer (int64)

タイトル: Response

レスポンスの一意の識別子。
Comments: string

タイトル: Comments

最大長: 1500

資格ランタイムについてユーザーが入力したコメント。
HasComments: string

コメントが存在するかどうかを示します。

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            }
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : leads-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

資格で回答する質問の合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusFuse":{
            "title":"Status",
            "type":"string",
            "description":"The status of the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode",
                    "TotalAnswered",
                    "TotalQuestions"
                ]
            },
            "x-queryable":true
        },
        "RatingFeedback":{
            "title":"Feedback",
            "type":"string",
            "description":"The feedback mapped to the rating of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of assessed business object.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":4,
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US",
            "x-queryable":true
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The object type of the lead qualification template associated with the qualification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of the lead qualification.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISNOTBLANK"
                ],
                "precision":10
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-response"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit required to create a lead qualification and corresponds to the business unit of business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template",
            "type":"string",
            "description":"The name of the lead qualification template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RatingTerm":{
            "title":"Rating",
            "type":"string",
            "description":"The overall rating of the qualification as configured in the associated lead qualification template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the lead qualification template that served as the source of this qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the lead qualification template record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アセスメント回答グループ

タイプ: array

タイトル: Assessment Answer Groups

アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。

ソースを表示

Array of: object leads-Assessments-AssessAnswerGroups-item-response

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-response"
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : leads-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

回答グループの名前。

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated lead qualification template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the answer group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentAnswer":{
            "title":"Assessment Answers",
            "type":"array",
            "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

ネストされたスキーマ : アセスメント回答

タイプ: array

タイトル: Assessment Answers

アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用します。

ソースを表示

Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : leads-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

質問のレスポンス。

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            },
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response",
            "type":"string",
            "description":"The response of the question.",
            "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"
            }
        },
        "AttributeName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            },
            "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."
        }
    }
}

リンク

AssessAnswerGroups

操作: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups

パラメータ:

AssessmentId: $request.path.AssessmentId
leadsUniqID: $request.path.leadsUniqID

アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示するために使用されます。

AssessmentTemplateVA

操作: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV

パラメータ:

ファインダ: AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}

アセスメント・テンプレート・リソースは、アセスメント・テンプレートの表示に使用されます。アセスメントに関連付けられたテンプレートが格納されます。

LookupPVO1

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}

参照リソースは、標準参照コードの表示に使用されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、リード評価を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100097576277/child/Assessments/

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
  AssessTemplateId": 300100104003343   
}

レスポンス本文の例

次の例は、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"
}
],
}

「トップに戻る」