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

機械翻訳について

アセスメントの作成

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments

リクエスト

パス・パラメータ

OptyNumber(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 the assessed business object.",
            "nullable":false
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":4,
            "type":"string",
            "description":"The language of the assessment.",
            "nullable":false,
            "default":"US"
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the assessment.",
            "nullable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The type of the assessment template associated with the assessment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of assessment.",
            "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 of the assessment. 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 answered in the assessment.",
            "nullable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-item-post-request"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile 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 assessment.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of an assessment.",
            "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 assessment template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

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

タイプ: array

タイトル: Assessment Answer Groups

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

ソースを表示

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

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

ネストされたスキーマ : opportunities-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 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 assessment associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentAnswer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request"
            }
        }
    }
}

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

タイプ: array

ソースを表示

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

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

ネストされたスキーマ : opportunities-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 assessments 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 assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "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 assessment 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 assessment 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のデフォルト・バージョンを選択します。

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

アセスメントで回答する質問の合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the assessment 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 assessment.",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the assessment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the assessed business object.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":4,
            "type":"string",
            "description":"The language of the assessment.",
            "nullable":false,
            "default":"US",
            "x-queryable":true
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The type of the assessment template associated with the assessment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of assessment.",
            "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 of the assessment. 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 answered in the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-item-response"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile 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 assessment.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of an assessment.",
            "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 assessment 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 assessment as configured in the associated assessment template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "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 assessment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Assessment Answer Groups

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

ソースを表示

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

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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"
    }
}

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

回答グループの名前。

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated 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 assessment 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 answers resource is used to view and update a response to a question in the question group.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

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

タイプ: array

タイトル: Assessment Answers

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

ソースを表示

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

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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"
    }
}

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

質問に対するレスポンス。

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessments 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 assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "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 assessment 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 to 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 assessment 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/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups

パラメータ:

AssessmentId: $request.path.AssessmentId
OptyNumber: $request.path.OptyNumber

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

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/opportunities/300100090218733/child/Assessments

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"AssessedObjTypeCode" : "Opportunity",
"AssessTemplateId" : 300100007058259
}

レスポンス本文の例

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

{
  "AssessmentId" : 300100090220734,
  "BusinessUnit" : 1,
  "AssessTemplateId" : 300100007058259,
  "Name" : "Untitled300,100,070,256,623-300,100,007,058,259",
  "AssessedLanguage" : "US",
  "StatusCode" : "INCOMPLETE",
  "AssessmentScore" : 0,
  "AssessedObjectId" : 300100070256623,
  "RelatedObjectId" : null,
  "RelatedObjTypeCode" : null,
  "AssessedObjTypeCode" : "Opportunity",
  "LastUpdateDate" : "2016-11-17T22:10:12-08:00",
  "CreatedBy" : "SALES_ADMIN",
  "LastUpdatedBy" : "SALES_ADMIN",
  "TemplateName" : "Opportunity4620126527273821",
  "TemplateType" : "Opportunity",
  "NumberOfGroups" : 0,
  "TotalQuestions" : 0,
  "TotalAnswered" : 0,
  "StatusFuse" : "FUSE_STATUS_NOT_STARTED",
  "links" : [ {
		...
		}
	]
}

「トップに戻る」