The VALUELIST API allows client applications to retrieve and maintain value lists that are used as option selections for fields on other objects.
This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.
Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us. We appreciate your help.
To place any request in QBOS API application from third party application you need to authenticate user account and set/calculate values for the following request headers:
x-qbos-id
, x-qbos-nonce
, x-qbos-date-utc
, x-qbos-hash-version
, x-qbos-auth
See details in Authentication Documentation.
Type 3 Value Lists are also lists that are used by more than a single data column to indicate the set of values that are allowable for those columns. However, these value lists are stored either in their own specific tables or are dynamically derived upon every use analyzing more complex data. As a result, type 3 value lists are referred to as Query Lists. The special values list table that stores Named Lists (type 2 value lists) store Query Lists as well, but only as the SQL necessary to then retrieve the actual value list data.
The valueListIdentifier for Type 3 value lists is the id of the row containing the query in the special value lists table. This number can be obtained by hovering the mouse over the name of the query list in the drop-down list of Query Lists in any data field Extended Properties section of the ADS.
Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.
Name | Type | Max length | Numeric | Required For POST |
Filterable | Description |
---|---|---|---|---|---|---|
_valueListIdentifier |
nvarchar |
50 |
|
yes |
|
Required for GET, PUT, POST, DELETE. |
list_value |
nvarchar |
100 |
yes |
|
|
The actual value that is stored in any object data field using this list as an extended property. |
list_display_value |
nvarchar |
200 |
yes |
|
|
The value as it is seen by the end-user when interacting with the UI. |
Type 3 Value Lists Only -- Adding a Filter for GET:
Pass the list item value (and its display value) to be inserted as a query string.
No JSON payload is required to insert an entry in a type 1 or type 2 value list.
Response codes:
Pass the list item value to be deleted as a simple query string entry.
No JSON payload is required to delete an entry in a type 1 or type 2 value list.
Response codes: