Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Method for retrieving environments #94

Open
dsbegnoche opened this issue Apr 28, 2021 · 5 comments
Open

Method for retrieving environments #94

dsbegnoche opened this issue Apr 28, 2021 · 5 comments

Comments

@dsbegnoche
Copy link
Contributor

We are wanting to show a list of environments to the user so they can later filter down forms by environment. The SDK currently does not have a method for retrieving this information, but it appears the /forms-app-environments endpoint would work. Is their a reason to not include this in the SDK?

I am happy to open a PR to add potentially to the organizations client unless their is a reason to not include it.

@dsbegnoche
Copy link
Contributor Author

Update: It appears that the api tokens do not return the app environments, so potentially this idea would not be supported?

@kizaonline
Copy link
Collaborator

kizaonline commented Apr 28, 2021

Hi @dsbegnoche ,

Thanks for raising this issue, in terms of why /forms-app-environments is not already in the SDK, there has just not be a use case for it before.

If you already know the formsAppEnvironmentId to filter by, you could raise a PR to update the FormsClient.Search() function to allow optionally searching with formsAppEnvironmentId as a querystring filter as the underlying API route does already support this filtering

You are correct that the API does not currently allow keys access to search /forms-app-environments however I will add add a story to our backlog to allow keys to access forms-app-environments search and to add a FormsAppEnvironments class to our SDK's.

Are you able to provide some details/context about your use case to help us prioritize this issue?

@dsbegnoche
Copy link
Contributor Author

We are building out an integration tool at CivicPlus that will allow users to trigger an integration when a form submission event is fired. Our initial plan was to have them set this up by using a dropdown to choose an environment, and then will show available forms for that environment. I will follow up on our end and have Adam reach out about the priority of request if needed at all. We have another option to work around that. But I may push a PR for the Search filter as that could be useful for us as well.

@dsbegnoche dsbegnoche mentioned this issue Apr 30, 2021
@dsbegnoche
Copy link
Contributor Author

@kizaonline Opened PR for the search parameter. I believe the /forms-app-environments update to allow access from keys is something that is desired, but I think that it is being followed up with our POC. I am good with closing this Issue, unless you would like to keep open for tracking against that request. Thank you for your feedback and quick responses!

@kizaonline
Copy link
Collaborator

@dsbegnoche Thanks for the PR, we'll leave this open until we raise a PR and make the corresponding API changes for the /forms-app-environments feature

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants