Get template questions

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	Quarterly performance reviews for managers Employee satisfaction survey Confidential performance review for employees on probation
	description	String	Template description	This template should be distributed quarterly to all L1 managers only It is mandatory to complete the process before end of every quarter
	workflow	String	Template workflow name	Self and manager review Team member assessment followed by Reviewer Team member and Reviewer in parallel One-on-One discussions 360 review Assign to UpRaise Admin - 360 Review Survey/Confiential review Assign to UpRaise Admin Assign to Reviewer's Manager
	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	Yes No
settings	showIssueTab	String	This parameter is to define whether Jira issue tab should be shown is the template	Yes No
	tabs	Object	This object consists of all data points related to tabs on the current template	tabName feilds
tabs	tabName	String	Name of the tab on current template	Self and manager review Team member & Reviewer Team member Reviewer HR remarks 360 review/Survey/Confidential review Reviewer
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	Section start Import objectives Signle line text Paragraph text Date Multiple choice Check box Star ratings Dropdown Yes / No Opinion scale
fields	settings	Object	This object consists all data points related to question based on its types
Parameters 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	Yes No
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 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	Yes No
settings	extremeLabels	String	This parameter is to define extreme labels (labels that describe start and end of the scale) of current question	Extremely likely - Not likely Very good - Poor
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	score	String	This parameter is to define whether the question scorable or not scorable	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Define what you think of your current role and responsibilities in one sentence.
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	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
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	Mention in detail about what goals you have achieved during this assessment period. Mention what you did best and what you could have done better in this assessment period according to given tasks and responsibilities
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	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Date committed to achieve the target? Date on which you completed give target?
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	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Choose one or more option from given choices that you agree with. From the below options, what do you think which of these qualities belong to your team member?
settings	choices	Object	This object consists of all data points related to multiple choices related to the question	name
choices	name	String	Given multiple choices	Work ethics Time management Positive attitude Self-learner
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	score	String	This parameter is to define whether the question scorable or not scorable	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Select one of the following options you disagree with? Select one of the following options you agree with?
settings	choices	Object	This object consists of all data points given choices related to the question	name
choices	name	String	Given choices to respond to the question	Excellent Good As expected Below expectations
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Rate your goals achievements Employee meets deadlines in given time
settings	choices	Object	This object consists of all data points given choices related to the question	name
choices	name	String	Given choices to respond to the question	Agree Disagree Partially agree I don't know
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	score	String	This parameter is to define whether the question scorable or not scorable	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Select one of the qualities of your team member that you think proves them as best resource for our organization Select one of the options that you think is something team member needs to improve on
settings	choices	Object	This object consists of all data points given choices related to the question	name
choices	name	String	Given choices to respond to the question	Agree Disagree Partially agree I don't know
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	score	String	This parameter is to define whether the question scorable or not scorable	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Are you happy with your current project? Are you happy with your current responsibilities?
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc
Parameters 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	Rate this team member on the scale of 1-10 for their time management Rate this manager on the scale of 0-10 for their leadership skills
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	Yes No
settings	extremeLabels	String	This parameter is to define extreme labels (labels that describe start and end of the scale) of current question	Extremely likely - Not likely Very good - Poor
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	Yes No
settings	addCommentBox	String	This parameter is to define whether the question has comment box or not	Yes No
settings	score	String	This parameter is to define whether the question scorable or not scorable	Yes No
settings	sequenceId	Number	Sequence id of the question in current template	1, 2, 3, 4, etc

On this page

In this section

REST API Basics
REST APIs for Continuous Feedback
REST APIs for Objectives & Key Results
REST APIs for Company Directory
REST APIs for forms