Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

All feedback data from different tabs

  • Then use these different APIs to get data from relevant tabs from my feedback page.  
    • /api/1/feedback/given
    • /api/1/feedback/received
    • /api/1/feedback/shared
    • /api/1/feedback/notes

Specific/filtered data

Above APIs would help you to get the entire data from different tabs which is kind of a generic feedback data. As my feedback page within the app has a different filter to search for specific data, so the REST APIs too. Use following API & parameters to fetch specific feedback data.

  • /api/1/feedback/shared
 
ParameterDescription Input ParameterInput type
startAtThe index of the first item returned in the page of results.Start record fromInt
maxResultsThe maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice.Max results on pageInt
creatorThe total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.UsernameString
isLastIndicates whether the page returned is the last one (Optional).End record atInt
receiverAdd any username/s who has access to Employee Success. You can retrieve data by using a comma-separated list of multiple users. usernameString
resourceAdd any username/s who has access to Employee Success. You can retrieve data by using a comma-separated list of multiple users. You can retrieve data by using a comma-separated list of multiple Jira issue ids. Jira issue IDString
labelRetrieves classified feedback on the basis of given label ids. Label ids are exposed in JSON, can be picked up from there and used in the APIs. You can retrieve data by using a comma-separated list of multiple label ids. IdInt
tagRetrieves feedback classified on the basis of given tag ids. Tag ids are exposed in JSON, can be picked up from there and used in the APIs. You can retrieve data by using a comma-separated list of multiple tag ids. IdInt
fromRetrieves data from a specific date.DateDate (only dd/M/yy)
toRetrieves data to a specific date.DateDate (only dd/M/yy)
toModifiedRetrieves data modified/edited from a specific date.DateDate (only dd/M/yy)
fromModifiedRetrieves data modified/edited to a specific date.DateDate (only dd/M/yy)

All the parameters are case sensitive. 

Feedback comments

In Employee Success, you can add comments on different feedback. When you want to retrieve such comments, you can make use of the following API & parameters. 

  • /api/1/feedback-comments
ParameterDescription Input ParameterInput type
idIts Employee Success feedback id that is exposed in JSON & can be picked up from there and used in the APIs. You can retrieve comments by using a comma-separated list of multiple feedback ids.IdInt

Super admin view

Employee Success has a super admin view option on my feedback page >> shared tab. To make use of super admin view use following API and its parameters from the table. 

  • /api/1/feedback/shared
ParameterDescription Input ParameterInput type
SuperAdminViewRetrieves data from super admin view available on shared tab withing my feedback page of Employee Success. true / falseboolean

Along with these parameters, you need to use the Employee Success API authentication key that needs to be generated from the app. Read How to generate an API authentication key from Employee Success?

How to use these APIs?

Syntax - https://atlassian-connect.upraise.io/(relevant API)/(parameter/s)?key=(Employee Success authentication key)

Example - https://atlassian-connect.upraise.io/api/1/feedback/given?key=GRUPO6HRFJZRXIYK3LKNLVBWLEOMYNXSUINCTD5TDWBGYHKTEJKUOM======&receiver=admin&tag=123

Other Key-value pairs 

Above are the different parameters those you can use with given APIs. However, in the data, there are other important parameters and their values can be used in the APIs to get specific data. Eg. If you are using an API for comments, you will need the exact feedback id to fetch comments in the other system. So the feedback id here is the KVP that you may want to make use of. Let us what other KVPs are there. 


ParameterDescription Input ParameterInput type
totalThe total number of items retrieved. Total number of feedbackInt
id

This parameter receives feedback id or label id depending on the other parameters. 

Feedback id or label idInt
messageThe message shows the entire text message shared as a feedback. Message as a feedback. Unstructured data
sharedWithIn Employee Success, there are three options for feedback sharing, all users, shared with the team and shared with users. This parameter returns the type of visibility. Feedback visibility typeString
feedbackUserSharingType of feedback visibility option. Feedback visibility typeString
feedbackTeamSharingType of feedback visibility option. Feedback visibility typeString
nameThe name parameter is used for the label name, tag name. tag/label nameString
typeJira issue type, when feedback is shared for a Jira issue.Jira issue typeString



On this page



In this section

Unable to render {children}. Page not found: REST APIs For Employee Success Cloud Version.


  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.