Get distributions

Use below endpoint to get UpRaise form distributions.

Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/form/getDistributions
Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributions

This API returns data about all distributed templates in UpRaise.

Request

No other inputs are needed in the request in the endpoint URL.

Response

Parent	Parameter	Type	Description	Possible values
	startAt	Number	Use this parameter to define starting index for the search results	10, 20, etc
	maxResults	Number	Use this parameter to define max results on each page	20, 40, etc
	total	Number	Total number of given feedback for logged in user	23, 50, 100, 1000, etc
	dateTimeFormat	String	Format definition of date fields returned in response.
	dateFormat	Date	Format definition of date fields returned in response.
	results	Object	This objective consist of all data points of returned results
results	id	Number	Distribution id	23, 1, 2, 4, etc
results	name	String	Distribution name	Q1 performance review for software team Employee satisfaction survey 2019
results	description	String	Distribution description	This form is distributed to gather the opinions of our employees about organizational growth
results	processEndDate	Date	The date on which system stops accepting inputs for current distribution	Any date
results	reviewPeriodStartDate	Date	Start date of the period which is under consideration for review	Any date
results	reviewPeriodEndDate	Date	End date of the period which is under consideration for review	Any date
results	Reminders	Date	Date/s on which system should sends auto-reminders to current form assignees who have not responded the form	Any date/s
results	template	Object	This object consists of all data points related to template associated with the current distribution	id name
template	id	Number	Template id	1, 20, 25, 30, etc
template	name	String	Template name	Growth survey Performance review for software team members
results	getTemplateQuestionsUrl	String	Url endpoint to get template questions associated with current distribution.	http://jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getTemplateQuestions/178
results	distributedOn	Date	Date on which the template is distributed	Any date
results	distributedBy	Object	This object consists of all details related to user who has created the distribution
results	status	Object	This object consists of all details related to status of the current distribution	id name
status	id	Number	status id	0 1 5 4
status	name	String	status name	Config draft Distributed Scheduled Closed
results	DistributionUsersCount	Number	Count of the users involved in this distribution	1, 10, 50, 200, etc
results	getDistributionUsersUrl	String	Url endpoint to get user details of current distribution.	http://jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributionUsers/494
results	anonymity	Object	This object consists of all data points related to the anonymity settings of the distribution when the 360 review template is distributed	type details
anonymity	type	String	Anonymity type	Anonymity Self-assessment
anonymity	details	Object	This object consists of all data points related to the anonymity & self assessment settings of the distribution when the 360 review template is distributed	name value
details	name	String	Anonymity type name	Admins and Super Admins can identify reviewers Admins and Super Admins can identify reviewer types Managers can identify reviewers Managers can identify reviewer types Team Member can identify reviewers Team Member can identify reviewer types
details	value	String	Anonymity value	True False
results	dueDate	Date	Due date of the distribution	Any date

On this page

In this section

UpRaise for Employee Success - Documentation

Get distributions

Request

Response

Related pages