Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Use below endpoint to get questions from UpRaise form templates.
- Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/form/etTemplateQuestions/{form id}
- Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getTemplateQuestions/304
This API returns all questions from UpRaise form template. If the template is deleted or its id is incorrect, relevant message is returned.
Responses are returned based on user’s role in the system
Normal users, users with no access will get an error - ‘You do not have access to this data’
Admins will be able to get details only for those templates which they have created
Super admins will get all the templates on their instance
Request
Template id is needed as input in the request endpoint URL.
Response
Parent | Parameter | Type | Description | Possible values |
---|---|---|---|---|
id | Number | Template id | 1, 20, 30, 40, etc | |
name | String | Template name |
| |
description | String | Template description |
| |
workflow | String | Template workflow name |
| |
settings | Object | This object consists of all data points related to settings of the current template | ||
settings | showFeedbackTab | String | This parameter is to define whether feedback tab should be shown is the template |
|
settings | showIssueTab | String | This parameter is to define whether Jira issue tab should be shown is the template |
|
tabs | Object | This object consists of all data points related to tabs on the current template |
| |
tabs | tabName | String | Name of the tab on current template |
|
tabs | fields | Object | This object consists of all data points related to the fields of each question in current template | |
fields | questionName | String | Name of the question type |
|
fields | settings | Object | This object consists all data points related to question based on its types | |
Parameters for when question type is section start | ||||
settings | questionType | String | Question type | Section start |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | title | String | Section title | Work adherence, Quality, Time management, Commitment, etc |
settings | details | String | Any additional details related to the section start type question | This section is one of the important aspects of the review that will decide some major aspects of your performance. |
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | weightage | Number | Weightage of the question | Any non-decimal number between 0-10 |
settings | sequenceId | Number | Sequence id/number of the question in the current template | 1, 2, 3, 4, etc |
Parameters for when question type is import objectives | ||||
settings | questionType | String | Question type | Import objectives |
settings | questionId | Number | Question id | 10, 20, 30 ,40, etc |
settings | question | String | Question | Import objectives |
settings | range | Number | This parameter is to define the range of the scale | Any range between 0-11 / 1-11 (depending on the current value of startAtOne parameter) |
settings | startAtOne | String | This parameter is to define whether scale starts at one or zero |
|
settings | extremeLabels | String | This parameter is to define extreme labels (labels that describe start and end of the scale) of current question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is single-line text | ||||
settings | questionType | String | Question type | single-line text |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
question | String | Questio |
| |
settings | defaultValue | String | Any default value related to the question in default value field associated with single-line text question type | Any default value related to the question given in default value field associated with single-line text question type |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for Parameters when question type is paragraph text | ||||
settings | questionType | String | Question type | Paragraph text |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | questionValue | String | Any default value related to the question in default value field associated with single-line text question type | Any default value related to the question given in default value field associated with paragraph text question type |
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is Date | ||||
settings | questionType | String | Question type | Date |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | questionValue | Date | Any default value related to the question in default value field associated with date type question | Any date |
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | dateFormat | Date | Any date | Any date |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is multiple choice | ||||
settings | questionType | String | Question type | Multiple choice |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | choices | Object | This object consists of all data points related to multiple choices related to the question |
|
choices | name | String | Given multiple choices |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is checkbox | ||||
settings | questionType | String | Question type | Checkbox |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | choices | Object | This object consists of all data points given choices related to the question |
|
choices | name | String | Given choices to respond to the question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is star rating | ||||
settings | questionType | String | Question type | Star rating |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | choices | Object | This object consists of all data points given choices related to the question |
|
choices | name | String | Given choices to respond to the question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is dropdown | ||||
settings | questionType | String | Question type | Dropdown |
settings | questionId | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | choices | Object | This object consists of all data points given choices related to the question |
|
choices | name | String | Given choices to respond to the question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is yes/no | ||||
settings | questionType | String | Question type | Yes / No |
settings | questionid | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
Parameters for when question type is opinion scale | ||||
settings | questionType | String | Question type | Opinion scale |
settings | questionid | Number | Question id | 1, 2, 3, 4, etc |
settings | question | String | Question |
|
settings | range | Number | This parameter is to define the range of the scale | Any range between 0-11 / 1-11 (depending on the current value of startAtOne parameter) |
settings | startAtOne | String | This parameter is to define whether scale starts at one or zero |
|
settings | extremeLabels | String | This parameter is to define extreme labels (labels that describe start and end of the scale) of current question |
|
settings | instructions | String | This parameter is to add any instructions specific to the current question | Any instructions specific to the current question |
settings | isMandatory | String | This parameter is to define whether the question is madatory or optional |
|
settings | addCommentBox | String | This parameter is to define whether the question has comment box or not |
|
settings | score | String | This parameter is to define whether the question scorable or not scorable |
|
settings | sequenceId | Number | Sequence id of the question in current template | 1, 2, 3, 4, etc |
On this page
Table of Contents
In this section
Child pages (Children Display) | ||
---|---|---|
|