Surveys Invitations 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 のリクエストボディ
-
- ルート XML タグ
- <SurveyDescriptionInput>
- 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 のリクエストボディ
-
- ルート XML タグ
- <SurveyResponseInput>
- JSON の例
-
複数の質問の例を次に示します。
1{ 2 "invitationId": "0Kixx0000004DbMCAU", 3 "flowInterviewState": "ewqJgw", 4 "surveyPageResponses": { 5 "questionResponses": [ 6 { 7 "name": "q_d217f330_05a6_4e2b_859b_1f1ef210bf84", 8 "questionType": "NPS", 9 "responseValue": 5 10 }, 11 { 12 "name": "q_ab781617_3665_4a41_b4ff_f236d73ecb30", 13 "questionType": "FreeText", 14 "responseValue": "Free Text Question Response" 15 }, 16 { 17 "name": "q_b1cdfe4c_9c7d_4c2f_ad9d_1915d301d780", 18 "questionType": "ShortText", 19 "responseValue": "Short Text Question Response" 20 }, 21 { 22 "name": "q_f84a6a3c_683c_4ed5_864e_5b486baed308", 23 "questionType": "Boolean", 24 "responses": [ 25 { 26 "name": "choice1" 27 } 28 ] 29 }, 30 { 31 "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040", 32 "questionType": "MultiChoice", 33 "responses": [ 34 { 35 "name": "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a" 36 }, 37 { 38 "name": "c_0f1f63cc_608a_4560_9d29_72b203f195f2" 39 } 40 ] 41 }, 42 { 43 "name": "q_1d8690a9_ae95_4e7c_86be_b8057205facc", 44 "questionType": "RadioButton", 45 "responses": [ 46 { 47 "name": "c_4867edc8_e9a6_4e86_9fea_b80758e90caf" 48 } 49 ] 50 }, 51 { 52 "name": "q_8946f212_25ff_43a8_a507_d267637eee1f", 53 "questionType": "Rating", 54 "responses": [ 55 { 56 "name": "c_f51c509a_9643_4a05_89f1_42464de618a6" 57 } 58 ] 59 } 60 ] 61 } 62} -
単一の質問の例を次に示します。
1{ 2 "invitationId": "0Kixx0000004EdsCAE", 3 "surveyPageResponses": { 4 "questionResponses": [ 5 { 6 "name": "q_3e501184_bb93_4a9c_a66b_6f2d81c92316", 7 "questionType": "FreeText", 8 "responseValue": "Answer for text question" 9 } 10 ] 11 }, 12 "flowInterviewState": "eg" 13} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン flowInterviewState String フローインタビューの状態。 必須 56.0 invitationId String アンケートへの招待の ID。 必須 56.0 languageCode String アンケートを作成する言語のコード。 省略可能 56.0 surveyPageResponses Survey Page Response Input ページ上のアンケートの質問に対する回答。 必須 56.0
- PATCH のレスポンスボディ
- Survey Response Output