Use forms to limit or extend the query response
-
- UpdatedJan 30, 2025
- 1 minute read
- Yokohama
- API implementation
On occasion, there is a need to limit the number of field values that a SOAP query returns.
- Limiting the response elements to contain only the fields on the view.
- Specifying reference record field values from referenced fields such as caller_id.email. This causes the value of the caller's email to be returned in the SOAP response.
To enable form views for SOAP queries, configure the com.glide.soap.view property to contain the name of the view that you want to use for all SOAP query responses. The default is soap_response. You can also specify the view name as a URL parameter, sysparm_view=<view name>, when making the SOAP call. For example:
By default, if a specified view name does not exist, the response contains all fields.
Related Content
- Return the display value for reference variables
When you query a record using a get or getRecords function, the instance returns all fields associated with that record. The fields are often reference fields that contain a sys_id for a record on another table.
- Clear values from a target instance
You can pass an empty value through a SOAP parameter to clear the respective value in the target instance.
- Retrieve journal entries using direct web services
To get the contents of a journal field, make a second soap request against the sys_journal_field table to pull the appropriate journal records back for the record in question.
- Retrieve choice fields using direct web services
To retrieve or set choice fields, use the choice Value, not the Label.
- Persist an HTTP session across all SOAP calls
In circumstances when a SOAP client makes many calls in a short amount of time, you may want to re-use a single HTTP session for all SOAP calls.
- SOAP direct web service API functions
The standard SOAP API is a set of small, globally defined functions that can be performed on a targeted resource.