Retrieve choice fields using direct web services
-
- UpdatedJan 30, 2025
- 1 minute read
- Yokohama
- API implementation
To retrieve or set choice fields, use the choice Value, not the Label.
For example, if you want to retrieve a list of all closed incidents, use the numerical value for Closed, which is 7 by default.
- Navigate to the form containing the choice field. For example, navigate to Incident > Open and select an incident.
- Right-click the choice value field and select Configure Dictionary. For example, configure the dictionary for the State field.
- From the Choices related list, note the value for the label you want to query. For example, note that the Closed choice has a value of 7.
Related Content
- Use forms to limit or extend the query response
On occasion, there is a need to limit the number of field values that a SOAP query returns.
- 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.
- 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.