Versions Compared

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

ParentParameterTypeDescriptionPossible values

idNumberTemplate id1, 20, 30, 40, etc

nameStringTemplate name
  • Quarterly performance reviews for managers
  • Employee satisfaction survey
  • Confidential performance review for employees on probation

descriptionStringTemplate description
  • This template should be distributed quarterly to all L1 managers only
  • It is mandatory to complete the process before end of every quarter

workflowStringTemplate 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

settingsObjectThis object consists of all data points related to settings of the current template
settingsshowFeedbackTabStringThis parameter is to define whether feedback tab should be shown is the template
  • Yes
  • No
settingsshowIssueTabStringThis parameter is to define whether Jira issue tab should be shown is the template
  • Yes
  • No

tabsObjectThis object consists of all data points related to tabs on the current template
  • tabName
  • feilds
tabstabNameStringName of the tab on current template
  • Self and manager review
    • Team member & Reviewer
    • Team member
    • Reviewer
    • HR remarks
  • 360 review/Survey/Confidential review
    • Reviewer
tabsfieldsObjectThis object consists of all data points related to the fields of each question in current template
fieldsquestionNameStringName 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
fieldssettingsObjectThis object consists all data points related to question based on its types
Parameters for when question type is section start 
settingsquestionTypeStringQuestion typeSection start
settingsquestionIdNumberQuestion id 1, 2, 3, 4, etc
settingstitleStringSection title

Work adherence, Quality, Time management, Commitment, etc

settingsdetailsStringAny additional details related to the section start type questionThis section is one of the important aspects of the review that will decide some major aspects of your performance. 
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingsweightageNumberWeightage of the question Any non-decimal number between 0-10
settingssequenceIdNumberSequence id/number of the question in the current template1, 2, 3, 4, etc
Parameters for when question type is import objectives
settingsquestionTypeStringQuestion typeImport objectives
settingsquestionIdNumberQuestion id10, 20, 30 ,40, etc
settingsquestionStringQuestionImport objectives
settingsrangeNumberThis parameter is to define the range of the scaleAny range between 0-11 / 1-11 (depending on the current value of startAtOne parameter)
settingsstartAtOneStringThis parameter is to define whether scale starts at one or zero
  • Yes
  • No
settingsextremeLabelsStringThis 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
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is single-line text
settingsquestionTypeStringQuestion typesingle-line text
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc

questionStringQuestio
  • Define what you think of your current role and responsibilities in one sentence. 
settingsdefaultValueStringAny default value related to the question in default value field associated with single-line text question typeAny default value related to the question given in default value field associated with single-line text question type
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for Parameters  when question type is paragraph text
settingsquestionTypeStringQuestion typeParagraph text
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion 
  • 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
settingsquestionValueStringAny default value related to the question in default value field associated with single-line text question typeAny default value related to the question given in default value field associated with paragraph text question type
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is Date
settingsquestionTypeStringQuestion typeDate
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion 
  • Date committed to achieve the target? 
  • Date on which you completed give target? 
settingsquestionValueDateAny default value related to the question in default value field associated with date type questionAny date
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsdateFormatDateAny dateAny date
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is multiple choice
settingsquestionTypeStringQuestion typeMultiple choice
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion 
  • 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? 
settingschoicesObjectThis object consists of all data points related to multiple choices related to the question
  • name
choicesnameStringGiven multiple choices
  • Work ethics
  • Time management
  • Positive attitude
  • Self-learner
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is checkbox
settingsquestionTypeStringQuestion type

Checkbox

settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion
  • Select one of the following options you disagree with? 
  • Select one of the following options you agree with? 
settingschoicesObjectThis object consists of all data points given choices related to the question
  • name
choicesnameStringGiven  choices to respond to the question
  • Excellent
  • Good
  • As expected
  • Below expectations 
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is star rating
settingsquestionTypeStringQuestion typeStar rating
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion
  • Rate your goals achievements
  • Employee meets deadlines in given time
settingschoicesObjectThis object consists of all data points given choices related to the question
  • name
choicesnameStringGiven  choices to respond to the question
  • Agree
  • Disagree
  • Partially agree
  • I don't know
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is dropdown
settingsquestionTypeStringQuestion typeDropdown
settingsquestionIdNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion
  • 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
settingschoicesObjectThis object consists of all data points given choices related to the question
  • name
choicesnameStringGiven  choices to respond to the question
  • Agree
  • Disagree
  • Partially agree
  • I don't know
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is yes/no
settingsquestionTypeStringQuestion typeYes / No
settingsquestionidNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion
  • Are you happy with your current project? 
  • Are you happy with your current responsibilities?
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc
Parameters for when question type is opinion scale
settingsquestionTypeStringQuestion typeOpinion scale
settingsquestionidNumberQuestion id1, 2, 3, 4, etc
settingsquestionStringQuestion
  • 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
settingsrangeNumberThis parameter is to define the range of the scaleAny range between 0-11 / 1-11 (depending on the current value of startAtOne parameter)
settingsstartAtOneStringThis parameter is to define whether scale starts at one or zero
  • Yes
  • No
settingsextremeLabelsStringThis 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
settingsinstructionsStringThis parameter is to add any instructions specific to the current questionAny instructions specific to the current question
settingsisMandatoryStringThis parameter is to define whether the question is madatory or optional
  • Yes
  • No
settingsaddCommentBoxStringThis parameter is to define whether the question has comment box or not
  • Yes
  • No
settingsscoreStringThis parameter is to define whether the question scorable or not scorable
  • Yes
  • No
settingssequenceIdNumberSequence id of the question in current template1, 2, 3, 4, etc


On this page

Table of Contents



In this section

Child pages (Children Display)
pageREST APIs