Surveys Responses Using Invitation ID (POST、PATCH)
アンケートへの回答を送信するためのプロセスを開始し、アンケートの最初のページの詳細を返すには、POST 要求を発行します。アンケートへの回答を送信するには、PATCH 要求を使用します。アンケートを作成すると、顧客や従業員などフィードバックが必要なユーザからデータを収集できます。アンケートへの回答は SurveyResponse オブジェクトに保存され、個々の質問への回答は SurveyQuestionResponse オブジェクトに保存されます。
特別なアクセスルール
このリソースを使用するには、Feedback Management - Starter および Feedback Management - Growth ライセンスが必要です。
- リソース
-
1/connect/surveys/surveyId/invitation/surveyInvitationId/survey-response - 例
-
1https://yourInstance.salesforce.com/services/data/56.0/connect/surveys/0Kdx00000000H46CAE/invitation/0Kixx0000004EsOCAU/survey-response - 使用可能なバージョン
- 56.0
- Chatter が必要かどうか
- いいえ
- HTTP のメソッド
- POST、PATCH
- POST のリクエストボディ
-
- JSON の例
-
1{ 2 "languageCode": "", 3 "relatedRecordIds": [ 4 "500xx000000bo3dAAA" 5 ], 6 "recipientEngagementContext": { 7 "test_key1": "test_value1", 8 "test_key2": "test_value1" 9 } 10}
- プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン invitationSettings Survey Invitation Settings Input アンケートの招待設定。 必須 56.0 languageCode String アンケートを作成する言語のコード。 省略可能 56.0 recipientEngagementContext Map<String, String> アンケートの受信者のエンゲージメントコンテキスト設定。 省略可能 56.0 relatedRecordIds String [] アンケートに関連付けられているレコードの ID。 省略可能 56.0 staticMergeFields Map<String, String> 静的な差し込み項目値の対応付け。 省略可能 56.0
- POST のレスポンスボディ
- Survey Description Output
- PATCH のリクエストボディ
-
- JSON の例
-
複数の質問の例を次に示します。
1{ 2 "invitationId": "0Kixx0000004DbMCAU", 3 "languageCode": "en", 4 "flowInterviewState": "ewqJgw", 5 "navigationAction" : "Next", 6 "surveyPageResponses": { 7 "name" : "p_ff794819_c0f0_4e0d_b357_29ca1694cfc4", 8 "questionResponses": [ 9 { 10 "name": "q_d217f330_05a6_4e2b_859b_1f1ef210bf84", 11 "questionType": "NPS", 12 "responseValue": 5 13 }, 14 { 15 "name": "q_ab781617_3665_4a41_b4ff_f236d73ecb30", 16 "questionType": "FreeText", 17 "responseValue": "Free Text Question Response" 18 }, 19 { 20 "name": "q_b1cdfe4c_9c7d_4c2f_ad9d_1915d301d780", 21 "questionType": "ShortText", 22 "responseValue": "Short Text Question Response" 23 }, 24 { 25 "name": "q_f84a6a3c_683c_4ed5_864e_5b486baed308", 26 "questionType": "Boolean", 27 "responses": [ 28 { 29 "name": "choice1" 30 } 31 ] 32 }, 33 { 34 "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040", 35 "questionType": "MultiChoice", 36 "responses": [ 37 { 38 "name": "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a" 39 }, 40 { 41 "name": "c_0f1f63cc_608a_4560_9d29_72b203f195f2" 42 } 43 ] 44 }, 45 { 46 "name": "q_1d8690a9_ae95_4e7c_86be_b8057205facc", 47 "questionType": "RadioButton", 48 "responses": [ 49 { 50 "name": "c_4867edc8_e9a6_4e86_9fea_b80758e90caf" 51 } 52 ] 53 }, 54 { 55 "name": "q_8946f212_25ff_43a8_a507_d267637eee1f", 56 "questionType": "Rating", 57 "responses": [ 58 { 59 "name": "c_f51c509a_9643_4a05_89f1_42464de618a6" 60 } 61 ] 62 } 63 ] 64 } 65} -
単一の質問の例を次に示します。
1{ 2 "invitationId": "0Kixx0000004EdsCAE", 3 "languageCode": "en", 4 "navigationAction" : "Next", 5 "surveyPageResponses": { 6 "questionResponses": [ 7 { 8 "name": "q_3e501184_bb93_4a9c_a66b_6f2d81c92316", 9 "questionType": "FreeText", 10 "responseValue": "Answer for text question" 11 } 12 ] 13 }, 14 "flowInterviewState": "eg" 15} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン flowInterviewState String フローインタビューの状態。 必須 56.0 invitationId String アンケートへの招待の ID。 必須 56.0 languageCode String アンケートを作成する言語のコード。 省略可能 56.0 navigationAction String アンケートページで使用可能なナビゲーションアクション。 可能な値は次のとおりです。- Back — 前のアンケートページへ戻ります。
- Next — 次のアンケートページへ進みます。
必須 57.0 surveyPageResponses Survey Page Response Input ページ上のアンケートの質問に対する回答。 必須 56.0
- PATCH のレスポンスボディ
- Survey Response Output