Get distribution users
- Annu
Use below endpoint to get users in the distribution of UpRaise form templates.
Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/form/getDistributionUsers/{distribution id}
Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributionUsers/500
This API returns data about all users in the form distributions UpRaise.
Response are returned based on user’s role in the system
Normal users, users with no access would get an error to the effect of ‘You do not have access to this data’
Admins would only be able to get only those responses whose distributions they can access
Super admins would get all distribution users on that instance
Request
Distribution id is needed in the request in the endpoint URL.
Response
Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
distributionId | Number | Distribution id | 1, 2, 3, 4, etc | |
distributionName | String | Distribution name |
| |
distributionDescription | String | Distribution description | Any description relevant to distribution | |
getDistributionDetailsUrl | String | Url endpoint to retrieve distribution details | http://jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributions?id=500 | |
startAt | Number | Use this parameter to define starting index for the search results | Use this parameter to define starting index for the search results | |
maxResults | Number | Use this parameter to define max results on each page | Use this parameter to define max results on each page | |
total | Number | Total number of given feedback for logged in user | Total number of given feedback for logged in user | |
results | Object | This objective consist of all data points of returned results | This objective consist of all data points of returned results | |
results | id | Number | Individual form id in current distribution | 1, 20, 35, 50, etc |
results | isOpen | String | Status of the individual form in current distribution |
|
results | teamMember | Object | This objective consists of all data points of user details who is the team member in the individual form of the current distribution modified the template at last | |
results | reviewer | Object | This objective consists of all data points of user details who is the reviewer in the individual form of the current distribution modified the template at last | |
results | status | Object | Status of the individual form of current distribution |
|
status | id | Number | status id | |
status | name | String | status name | Statuses are returned based on template types and workflows, a few examples are as below -
|
results | hrUser | Object | This objective consists of all data points of user details who is the HR user in the individual form of the current distribution modified the template at last | |
results | assignedTo | Object | This objective consists of all data points of user details who is the current assignee of the individual form of the current distribution modified the template at last | |
results | getDistributionUserResponseUrl | String | Url endpoint to retrieve user responses | http://jira.amoeboids.com/rest/amoeboids-upraise/1.0/form/getDistributionUserResponses/3800 |