Access to the Private Preview of Queries in SKY API for R.E.
Hello, I was wondering what the steps were to get access to the private preview for this endpoint:
I have a use case for my application that would utilize this endpoint.
Thanks!
Jon
Comments
-
@Jon Crain
It is already publicly available.1 -
@Alex Wong I believe I linked the wrong endpoint, I meant this one:
https://developer.sky.blackbaud.com/api#api=query&operation=StartQueryExecutionJobByID
1 -
@Jon Crain
All of query api is publicly available1 -
I contacted support and got the following reply after getting an error using this endpoint:
"I wanted to provide some clarification regarding the Query End Point. It is currently functioning as intended, but please note that it is in a private preview and is only accessible to a limited number of selected developers and partners.
If you or your team would like to be considered for this group, you'll need to post to the Sky API Community to request access.
Let me know if you have any questions or need further assistance!"
1 -
@Jon Crain
Hi, I don't know what error you encountered, so post that to get help.Query API is Publicly (Generally) Available:
https://community.blackbaud.com/blogs/69/9628
This is announced back in 6/12/2024.
Blackbaud Support may be confused about “Query webview” which is still in preview.
1 -
@Alex Wong and @Jon Crain While the API is publicly available, if you don't have access to Query in webview your calls will fail, at least that was what happened when I first tried to use @Ashley Moose's template the first time. Once I got access to the Query preview it worked.
@Erik Leaver and @David Springer maybe you can help Jon?
0 -
@Dan Snyder
That is a surprise.If something is Generally Available. it is available to all, without need for the software company doing any “config”. If it is a “client” config, then client will need to know the config needed to activate or allow the use of Query API.
Erik/David, please confirm Query API has truly GA'-ed.
0 -
@Jon Crain Query API is GA as of 6/12 this year. I looked at your support case and have followed up with the analyst to confirm the GA status.
However, I see the error message you received is about the application scope:This application has insufficient scope to perform the operation. This application's scopes configuration is either insufficient for the request or the Blackbaud Environment Admin has not yet approved the application's updated access configuration. Learn more: https://developer.blackbaud.com/skyapi/docs/applications/scopes"
Did you take steps to update your application's scope?
cc: @Alex Wong @Dan Snyder0 -
@Erik Leaver
Hello Erik, I did update my application scope to include write as I see in the docs that is required for POST calls, and then refreshed my token0 -
@Erik Leaver
Thanks Erik for confirming that the Query API is GA-ed and available to everyone, but yes, client do need to confirm access on their end is granted. This is the problem with BB Support when it comes to SKY API, they provide wrong info and then tell everyone to come to Community.0 -
@Jon Crain
As previously mentioned, please screenshot to show how you are making the call, and the resulting errors you received.0 -
@Jon Crain Customer must also approve the scope change. As per documentation:
When you add new functionality to your application, you can re-define your scopes and get approval for the new data access from the customer. In the customer environment, this approval is provided by a user that has the Marketplace permissions to approve scope changes.0 -
@Erik Leaver The scope makes sense, but Jon would not be able to write or read if his environment does not have access to Query if I am thinking about this correctly? It could be above my low-code knowledge. ?
0 -
@Erik Leaver
Hi Erik,Do you have a link I can provide my customer where they can approve those changes?
All the help is much appreciated!
0 -
@Dan Snyder The error Jon received was regarding scopes, not access to the Query API. Query API is GA and there is no dependency on Query in the UI.
1 -
@Erik Leaver Thanks!
0 -
Hello all,
Thank you for all the help, it was that the customer needed to go into Marketplace > Manage and approve my scope changes, the API is now working as expected!
Best,
Jon
0 -
@Jon Crain Sure!
We require environment admins to approve of scope changes when they occur after the application has been connected. We do this so the application isn't automatically granted access beyond the comfort level of the environment admin. Once the admin approves your scope change, your application should have the access it needs.
0
Categories
- All Categories
- 6 Blackbaud Community Help
- 206 bbcon®
- 1.4K Blackbaud Altru®
- 394 Blackbaud Award Management™ and Blackbaud Stewardship Management™
- 1.1K Blackbaud CRM™ and Blackbaud Internet Solutions™
- 15 donorCentrics®
- 357 Blackbaud eTapestry®
- 2.5K Blackbaud Financial Edge NXT®
- 646 Blackbaud Grantmaking™
- 561 Blackbaud Education Management Solutions for Higher Education
- 3.2K Blackbaud Education Management Solutions for K-12 Schools
- 934 Blackbaud Luminate Online® and Blackbaud TeamRaiser®
- 84 JustGiving® from Blackbaud®
- 6.4K Blackbaud Raiser's Edge NXT®
- 3.6K SKY Developer
- 242 ResearchPoint™
- 117 Blackbaud Tuition Management™
- 165 Organizational Best Practices
- 238 The Tap (Just for Fun)
- 33 Blackbaud Community Challenges
- 28 PowerUp Challenges
- 3 (Open) Raiser's Edge NXT PowerUp Challenge: Product Update Briefing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports+
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Email Marketing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Gift Management
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Event Management
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Home Page
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Query
- 777 Community News
- 2.9K Jobs Board
- 53 Blackbaud SKY® Reporting Announcements
- 47 Blackbaud CRM Higher Ed Product Advisory Group (HE PAG)
- 19 Blackbaud CRM Product Advisory Group (BBCRM PAG)