Add support for API Points #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ole and ACL feat: Added new SI for API support, staring with support for name/ID as input feat: Added support for multiple points in an API request fix: Added a semicolon on a line in PointsThing because the linter warning bothered me
Lacah
reviewed
Oct 19, 2023
| @@ -110,7 +110,7 @@ PointsThing.prototype = { | |||
| if (response_body.user.name) { | |||
| var grupdate = new GlideRecord('x_snc_pointsthing_user'); | |||
| grupdate.get(record_id); | |||
| var name = response_body.user.profile[gs.getProperty('x_snc_pointsthing.leaderboard_name')] ? response_body.user.profile[gs.getProperty('x_snc_pointsthing.leaderboard_name')] : response_body.user.profile['real_name'] | |||
| var name = response_body.user.profile[gs.getProperty('x_snc_pointsthing.leaderboard_name')] ? response_body.user.profile[gs.getProperty('x_snc_pointsthing.leaderboard_name')] : response_body.user.profile['real_name']; | |||
Lacah
approved these changes
Oct 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements support for API points with a Scripted REST API. This API is bound to a specific role ACL, and allows invocation with varying payloads. This resolves #2.
Invocation
The SR API endpoint is
/api/x_snc_pointsthing/points_thing/api_pointand this accepts a POST with Content-Typeapplication/json. The payload is formatted as follows:{ "reason": "Testing", "target": "U0K4BD8DC", "targetType": "slack_id", "points": 2, "sender": "Slacker" }Payload notes
slack_idorname.slacker.api_point_giver, which you can use if you would like to have points reflecting their source.Sample Call
POST /api/x_snc_pointsthing/points_thing/api_point HTTP/1.1
Content-Type: application/json
Host: instance.service-now.com
{
"reason": "Testing",
"target": "U0K4BD8DC",
"targetType": "slack_id",
"points":2
}
Notes
I also added a Points field to the API Points table, tweaked the lists slightly, and extended the PointsThing SI for API-specific methods/behaviour. Because of who I am I also added a semicolon on a line in PointsThing because the linter warning bothered me.