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
Parameter
Description
Input Parameter
Input type
startAt
The index of the first item returned in the page of results.
Start record from
Int
maxResults
The 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 page
Int
creator
The total number of items contained in all pages. This numbermay changeas the client requests the subsequentpages, therefore the client should always assume that the requested page can be empty.
Username
String
isLast
Indicates whether the page returned is the last one (Optional).
End record at
Int
receiver
Add any username/s who has access to Employee Success. You can retrieve data by using a comma-separated list of multiple users.
username
String
resource
Add 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 ID
String
label
Retrieves 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.
Id
Int
tag
Retrieves 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.
Id
Int
from
Retrieves data from a specific date.
Date
Date (only dd/M/yy)
to
Retrieves data to a specific date.
Date
Date (only dd/M/yy)
toModified
Retrieves data modified/edited from a specific date.
Date
Date (only dd/M/yy)
fromModified
Retrieves data modified/edited to a specific date.
Date
Date (only dd/M/yy)
All the parameters are case sensitive.
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
Parameter
Description
Input Parameter
Input type
SuperAdminView
Retrieves data from super admin view available on shared tab withing my feedback page of Employee Success.
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.
Parameter
Description
Input Parameter
Input type
total
The total number of items retrieved.
Total number of feedback
Int
id
This parameter receives feedback id or label id depending on the other parameters.
Feedback id or label id
Int
message
The message shows the entire text message shared as a feedback.
Message as a feedback.
Unstructured data
sharedWith
In 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 type
String
feedbackUserSharing
Type of feedback visibility option.
Feedback visibility type
String
feedbackTeamSharing
Type of feedback visibility option.
Feedback visibility type
String
name
The name parameter is used for the label name, tag name.
tag/label name
String
type
Jira issue type, when feedback is shared for a Jira issue.
Jira issue type
String
On this page
In this section
Unable to render {children}. Page not found: REST APIs For Employee Success Cloud Version.
Add Comment