Troubleshoot Common Vista API Issues

What should I do if I’m getting a failure?

If you tried making an API call and cannot get a response, try entering that same data manually in the corresponding Vista form to see if Vista accepts it. If you get an error in Vista after manually entering the data, you may be missing some required fields. Check to see if there are additional required fields.

Why is my API action failing to post to Vista when I provide the required API properties?

Your actions may be failing because you have not modified your API calls based on your custom Vista configuration.

Consider custom required fields

The required properties indicated in the API reference documentation are the minimum properties required to send an action to an out-of-the-box Vista environment. These properties do not take into consideration any customizations.

If your organization customized Vista forms in a way that marked optional fields as required, you must modify your API calls based on your custom Vista settings.

If a Vista field can be defaulted (filled with a default value), it is not marked as a required API property. You can indicate to use Vista defaulting by not providing a property value. However, if Vista is customized in such a way that a required value is not defaulted, the record will fail as it would for a user in Vista.

Consider custom stored procedures

Additionally, actions are processed using Vista stored procedures. You need to consider how your organization’s custom stored procedures (if you have any) might impact action processing.

Familiarize yourself with Vista forms corresponding to API actions

While designing your action inputs, you should be familiar with the Vista form(s) the action represents. To test, manually walk through adding data to the Vista form(s) to understand required fields, default behaviors, and any other validations that may have been customized by your organization.

It is up to each organization to understand their specific Vista settings and define a successful API payload.