QBOS REST API documentation

The VALUELIST API allows client applications to retrieve and maintain value lists that are used as option selections for fields on other objects.

Audience

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.

Additional resources, information about this guide

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.

Getting Started

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

About Type 1 Value Lists

Type 1 Value Lists are those lists that are used by a single data column to indicate the set of values that are allowable for that column. These value lists are actually stored on the particular data column schema definition record in ADS (Application Design Studio).

The valueListIdentifier for Type 1 value lists is the negative value of the data column's published column id. This number can be obtained by hovering the mouse over the column name in the Data Fields section of the ADS.

VALUELIST properties

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	Description
_valueListIdentifier	nvarchar	50		yes	Required for GET, PUT, POST, DELETE. Identifies *WHICH* value list is being used (by either numerical id or value list name). For Type 1 [Data Column Extended Properties Value List]: use the negative published id number of the object field data column that contains the actual value list within the it's extended properties. For Type 2 [Named Value List (stored in Org_Object_NQ_Lists)]: use either the id number or the name of the list as it is stored in the Org_Object_NQ_Lists table. For Type 3 [Query List (SQL is stored in Org_Object_NQ_Lists)]: use either the id number or the name of the query as it is stored in the Org_Object_NQ_Lists table.
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.

Read VALUELIST by valueListIdentifier:

GET https:/.../v1/517090/VALUELIST/{valueListIdentifier}

Response codes:

400 - Client error
500 - Server error
404 - Not found or user does not have permission to access resources of this type.
200 - OK

This example retrieves up to the first 10 values of the list that supports the IsNewCAHPS column on the Hospice Control Panel object.

Response data for: GET https:/.../v1/517090/VALUELIST/-25243

11TRUE00FALSE

Create VALUELIST entry:

POST https:/.../v1//VALUELIST/{valueListIdentifier}?{list_value=list_display_value}

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:

400 - Client error
500 - Server error
201 - OK (content returned)

Delete VALUELIST entry:

DELETE https:/.../v1/VALUELIST/{valueListIdentifier}?{list_value}

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.