Get templates
Use below endpoint to get details UpRaise form templates.
Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/form/getTemplates
Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getTemplates
This API returns data about all forms templates in UpRaise.
Response
No other inputs are needed in the request in the endpoint URL.
Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
| startAt | Number | This parameter is to define starting index for the search results | 10, 15, 20, etc |
| maxResults | Number | This parameter to define max results on each page | 10, 20, etc |
| total | Number | Total number of results | 100, 50, 250. 300, etc |
| results | Object | This objective consist of all data points of returned results |
|
results | id | Number | Template id | 1, 2, 3, 5, etc |
results | name |
| Template name | Quarterly performance review for managers |
results | description |
| Template description | Example - This template is created for performance reviews of all managers in the company. This templated will be distributed every quarter |
results | status | Object | This objective consist of all data points of template status |
|
status | id | Number | Status id |
|
status | name | String | Status name |
|
results | baseTemplate | String | Base template name |
|
results | modifiedBy | Object | This objective consist of all data points of user details who modified the template at last |
|
results | workflow | String | Workflow name |
|
results | noOfDistributions | Number | Total number of template distributions | 10,15, 25, 30, etc |
results | categories | Object | This objective consist of all data point of template categories |
|
categories | id | Number | Category id | 1, 20, 25, 50, etc |
categories | name | String | Category name | Manager reviews, team reviews, etc |
results | getQuestionsUrl | String | Url endpoint to retrieve template questions | http://upraise-jira7.amoeboids.com/rest/amoeboids-upraise/1.0/form/getTemplateQuestions/306 |