Get distribution user responses
Annu
Owned by Annu
Dec 04, 2019
2 min read
Loading data...
Use below endpoint to for this API.
- Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/form/getDistributionUserResponses
- Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/getDistributionUserResponses
This API returns data about all forms templates in UpRaise.
Distribution user id is needed in the request endpoint URL. To get distribution user-id, Open the relevant distribution, click on view responses of the relevant user's form. In the link tab you get dUserId.
Response
| Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
| distributionId | Number | Distribution id to which the distribution user id is associated with | 1, 2, 3, 4, etc | |
| distributionName | String | Distribution name to which the distribution user id is associated with |
| |
| distributionDescription | String | Distribution description to which the distribution user id is associated with | Any description | |
| getDistributionDetailsUrl | String | Url endpoint to retrieve distribution details | jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributions?id=501 | |
| getTemplateQuestionsUrl | String | Url endpoint to retrieve template questions | jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getTemplateQuestions/317 | |
| distributionUserDetails | Object | This object consists of all details related to individual form of the user in the current distribution | ||
| distributionUserDetails | id | Number | Distribution user id. This is an id associated with individual form of the user in the distribution | 12, 13, 14, 15, etc |
| distributionUserDetails | isOpen | String | Status of the form that indicates whether the form is accepting inputs |
|
| distributionUserDetails | teamMember | Object | This object consists of all details related to the team member of the current form | |
| distributionUserDetails | reviewer | Object | This object consists of all details related to the reviewer of the current form | |
| distributionUserDetails | status | Object | This object consists of all details related to status of the form |
|
| status | id | Number | Status id | |
| status | name | String | Status name | Statuses based on actions taken by respondents, for example, reviewer shared, team member shared, etc |
| distributionUserDetails | scores | Object | This object consists of all details total scores on team member's self-assessment & score given by reviewer |
|
| scores | name | String | This parameter defines the form respondent's type and name |
|
| scores | value | Number | Actual scores given by respondent of the form |
|
| distributionUserDetails | hrUser | Object | This object consists of all details related to the HR user of the current form | |
| distributionUserDetails | assignedTo | Object | This object consists of all details related to the user who is current assignee of the form | |
| tabs | Object | This object consists of all details related to tabs on the form | ||
| tabs | tabName | Object | Tab name |
|
| tabs | fields | String | This object consists of all details of the fields related to the questions in the current tab | |
| fields | id | Number | Field id | 1, 12, 1254, 56, etc |
| fields | questionName | String | Question name | Any type of question possible in UpRaise templates |
| fields | response | String | Response in the question | Any response marked by the form respondent on the current question. This varies based on the type of question |
| fields | score | Number | Scores given on the question | Scores associated with the selected answer by the respondent (this is applicable only for scorable questions) |
Read Get template questions for more details on question responses related to each question type.