調査応答サマリーを取得

ディスカバリーフレームワークでは、調査からの応答は AssessmentQuestionResponse オブジェクトに格納され、フォームメタデータは OmniScript に残されます。この呼び出し可能なアクションを使用して、調査のサマリーデータを下流のプロセスに渡すことができます。この呼び出し可能なアクションは、ドキュメントを生成するドキュメント生成ワークフローで使用可能なサマリー JSON を提供します。

[調査応答サマリーを取得] 呼び出し可能アクションは、調査 ID を入力として受け取り、OmniScript (OmniProcess) ID を取得します。この ID は OmniScript を取得するために使用されます。また、調査 ID によって、調査応答を取得し、応答を OmniScript とマージすることで、サマリー JSON コードで調査サマリー応答が作成されます。

このオブジェクトは API バージョン 56.0 以降で使用できます。

サポートされている REST HTTP メソッド

URI

/services/data/v56.0/actions/standard/getAssessmentResponseSummary

形式

JSON

HTTP のメソッド

GET

認証

Authorization: Bearer token

入力

出力

使用方法

サンプル入力

REST API で「調査応答サマリーを取得」呼び出し可能アクションを公開する場合、次の形式で assessmentId とその値を含む入力を渡すことができます。

1{
2  "inputs" : [ {"assessmentId" : "0U3RO00000005FN0AY"} ]
3}

サンプル出力

この例では、最初の行は OmniScript 種別、サブ種別、および言語を示しています。各ステップには、OmniScript に表示される複数の質問が記述されています。この情報は、ドキュメント生成を使用した PDF ファイルの表示など、ダウンストリームのプロセスで利用できます。

1"KYC_Individual_English": {
2    "Step1": {
3      "label": "Identity Details",
4      "value": {
5        "LC_Survey_Question_2": {
6          "label": "Full Name",
7          "value": "Joe Smith"
8        },
9        "DateofBirth_m": {
10          "label": "Date of Birth",
11          "value": "Thu Jul 27 00:00:00 GMT 2000"
12        },
13        "Gender_m": {
14          "label": "Gender",
15          "value": "Female"
16        },
17        "EmailAddress_m": {
18          "label": "Email Address",
19          "value": "Joe.Smith@company.com"
20        },
21        "PAN": {
22          "label": "PAN",
23          "value": "QWEASDZXC"
24        }
25      }
26    },
27    "Step2": {
28      "label": "Address Details",
29      "value": {
30        "Address_CorrespondenceAdd_Corporate": {
31          "label": "Address of Correspondence",
32          "value": "100 Some St, San Francisco, CA 12345, United States"
33        },
34        "Address_ContactDetails_Corporate": {
35          "label": "Telephone/Mobile",
36          "value": "1616111233"
37        },
38        "Alternate_Contact": {
39          "label": "Alternate Mobile Number",
40          "value": "1911212123"
41        }
42      }
43    },
44    "Step3": {
45      "label": "Account Declaration",
46      "value": {
47        "Account_declaration": {
48          "label": "I declare that I have following deposit accounts with your/
49other bank's branches :",
50          "value": [
51            {
52              "Bank": {
53                "label": "Bank",
54                "value": "Acme1"
55              },
56              "Branch": {
57                "label": "Branch",
58                "value": "Mission St"
59              },
60              "Type_of_Account": {
61                "label": "Type of Account",
62                "value": "Checking"
63              },
64              "Account_Number": {
65                "label": "Account Number",
66                "value": "12345678"
67              }
68            },
69            {
70              "Bank": {
71                "label": "Bank",
72                "value": "Acme2"
73              },
74              "Branch": {
75                "label": "Branch",
76                "value": "Mission St"
77              },
78              "Type_of_Account": {
79                "label": "Type of Account",
80                "value": "Savings"
81              },
82              "Account_Number": {
83                "label": "Account Number",
84                "value": "1234567890"
85              }
86            }
87          ]
88        }
89      }
90    },
91    "Step4": {
92      "label": "Declaration",
93      "value": {
94        "Declaration_m": {
95          "label": "The customer declares and certifies that the information in this 
96form is true and correct. Any pre-filled sections of this form must be reviewed prior
97 to signing and submitting, to ensure the information accurately conveys the new 
98account details.",
99          "value": "true"
100        }
101      }
102    }
103  }
104}