QBOS REST API documentation (workgroup_user)
(return to Main Document)
Introduction
The workgroup_user API allows client applications to maintain workgroup_user data including any part of its demographic record sets.
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
See details in Authentication Documentation.
workgroup_user 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 |
Filterable |
Description |
id |
bigint |
|
|
|
|
Required for GET(by id),PUT,DELETE |
parent_id |
bigint |
|
|
yes |
|
|
parent_type |
nvarchar |
50 |
|
yes |
|
|
type |
nvarchar |
50 |
|
|
|
Value is "workgroup_user" |
_localsw |
int |
|
|
|
|
|
_title |
nvarchar |
102 |
|
|
|
|
user_id |
bigint |
|
|
yes |
yes |
Id of a user / humanresource |
Read workgroup_user by id:
GET https:/.../v1/o/workgroup_user/{id}
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
Response data: GET https:/.../v1/o/workgroup_user/15166
{
"type" : "workgroup_user",
"parent_type" : "workgroup",
"parent_id" : 16117,
"id" : 15166,
"sub_type" : "",
"_localsw" : 1,
"_title" : "Lord, James",
"user_id" : 2,
"href" : "\/v1\/o\/workgroup_user\/15166"
}
Read workgroup_user from parent:
GET https:/.../v1/o/{parent_type}/{parent_id}/links/workgroup_user[?{filter}]
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
GET https:/.../v1/o/workgroup/16117/links/workgroup_user
Response example is shown in XML format here even though REST API returns JSON format:
<workgroup_user><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="8074" sub_type="" _title="Kaeppel, Steve" href="/v1/o/workgroup_user/8074"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="8741" sub_type="" _title="Mertens, Craig" href="/v1/o/workgroup_user/8741"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="15166" sub_type="" _title="Lord, James" href="/v1/o/workgroup_user/15166"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="15644" sub_type="" _title="Chacko, Vince" href="/v1/o/workgroup_user/15644"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="15752" sub_type="" _title="Walden, Leigh" href="/v1/o/workgroup_user/15752"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="19754" sub_type="" _title="TestMD, TestMD" href="/v1/o/workgroup_user/19754"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="20812" sub_type="" _title="Shrayber, Rita" href="/v1/o/workgroup_user/20812"/><workgroup_user parent_type="workgroup" parent_id="16117" type="workgroup_user" id="21862" sub_type="" _title="Karmazyn, Dan" href="/v1/o/workgroup_user/21862"/></workgroup_user>
Create workgroup_user:
POST
https:/.../v1/o/workgroup/16117/workgroup_user
Request data [See properties]:
{"workgroup_user": [ { "parent_type" : "workgroup", "parent_id" : 16117, "property_a" : "value-a", "property" : "See workgroup_user properties", "property_z" : "value-z" } ] }
Response codes:
Delete workgroup_user:
DELETE https:/.../v1/o/workgroup_user/{id}
The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe
{"workgroup_user": [{"id":15166}]}
Response codes:
- 400 - Client error
- 500 - Server error
- 204 - OK
- 404 - Not found