ClientSpace API Change Log
This topic consolidates ClientSpace API changes published in the release notes. Use it to look up when a method, field or behavior was introduced.
Swagger remains the reference for current request and response detail. For access and sign-in details, see Using Swagger with ClientSpace APIs.
Version Coverage
The three API versions coexist and a new version has never replaced an older one, so an integration built against version 1.0 keeps working. The versions are also cumulative: version 3.0 includes every change introduced in versions 1.0 and 2.0.
Important: The version columns in the table below mark the version in which a change was first introduced, not every version it is available in. A blank in the v3.0 column does not mean the change is absent from version 3.0. Everything listed below is available in version 3.0.
However, every change from Release 132 (R132) onward has been made in version 3.0 alone.
Note: A dash (—) means the change was not tied to a version. Those entries affect API access, configuration or platform behavior whichever version is called.
Change Log
The following changes are listed newest first. Case numbers match the release-note entry each change came from.
|
Release |
Version |
Area |
Change |
Case |
||
|---|---|---|---|---|---|---|
|
v1.0 |
v2.0 |
v3.0 |
||||
|
R168 |
|
|
✓ |
Task |
GET /api/task/v3.0/find and GET /api/task/v3.0/{id} return isRecurring, isPrimaryRecurringTaskTemplate and RecurrenceSourceTask. The find method filters on these and returns Date Created and Date Updated. |
76808 |
|
R168 |
|
|
✓ |
Dataform, Organization, Task |
SaveAnyway: true in a POST, PUT or PATCH payload bypasses "Save Anyway?" soft errors. |
76771 |
|
R168 |
|
|
✓ |
Task |
Version 3.0 PATCH and POST support Group Users in the Owner and Assigned To fields. |
79086 |
|
R166 |
|
|
✓ |
Task |
GET /api/task/v3.0/find returns OwnerName ("Last Name, First Name") plus OwnerUserID, UpdatedByUserID, AssignedToUserID and CompletedByUserID. |
76543 |
|
R165 |
— |
— |
— |
Access |
Global administrators with an Advanced Admin license can view the API Users Proc Access tab. View-only. |
72254 |
|
R164 |
— |
— |
— |
Access |
The Disallow UI Login checkbox on User Details prevents API users signing in through the ClientSpace login window. Off by default. |
77871 |
|
R164 |
— |
— |
— |
Access |
Include in API moved to the Actions fieldset of Dataform Properties, letting global administrators make a form API-enabled. |
77547 |
|
R162 |
|
|
✓ |
Organization |
POST /api/organization/v3.0 returns pkOrganizationID in the response body. |
76767 |
|
R160 |
|
|
✓ |
Contact |
GET /api/contact/v3.0/search accepts dateUpdated.from and dateUpdated.to (date-time, inclusive, invalid ranges rejected). |
73199 |
|
R159 |
|
|
✓ |
Organization |
Version 3.0 Organization methods added: GET /search, GET /{id}, PATCH /{id} and POST. The POST hdraction parameter can create a workspace. |
53548 |
|
R154 |
|
|
✓ |
User |
GET /api/user/v3.0/{id} added, returning one user and associated details across 18 exposed fields. |
67772 |
|
R151 |
✓ |
✓ |
✓ |
Dataform |
PUT /api/dataform/v1.0/{tableName}/{id} returns a 400 instead of a 200 when the document is incomplete. Applied to versions 1.0, 2.0 and 3.0. |
70451 |
|
R151 |
— |
— |
— |
Access |
API roles are no longer listed under System Admin > Users > Roles. They are still managed on the Proc Access tab. |
72265 |
|
R150 |
|
|
✓ |
Dataform |
GET /api/dataform/v3.0/listupdated respects DateTime search parameters, which were previously treated as dates only. |
68700 |
|
R149 |
|
|
✓ |
Versions |
Version 3.0 became the default version shown when Swagger opens. |
70674 |
|
R148 |
— |
— |
— |
Access |
API custom stored procedure security added, managed on the Proc Access tab of the API User dataform. |
70536 |
|
R148 |
— |
— |
— |
Access |
API-enabled fields are set per API user pipeline, so each API user can have its own required-field set. |
62477 |
|
R145 |
|
|
✓ |
Dataform |
The version 3.0 Dataform Query endpoint selects and filters on DateCreated, DateUpdated, CreatedByUserID and UpdatedByUserID. |
70389 |
|
R142 |
— |
— |
— |
Behavior |
Fixed an error that occurred when a ClientSpace API business rule created Client Site Visit records. The rule failed with a NULL value error on the luAttendeeType column. |
67947 |
|
R141 |
— |
— |
— |
Dataform |
Fixed a PATCH on a form with tabs marking omitted tabs as changed, which incorrectly triggered email notifications. |
68650 |
|
R132 |
|
|
✓ |
Dataform |
Version 3.0 introduced with methods for child (tabbed) forms: POST /add3.0/{tableName}/{workspaceID}, PUT /update3.0/{id} and PATCH /patch3.0/{id}. |
64168 |
|
R130 |
✓ |
|
|
Documentation |
Version 1.0 Swagger documentation rewritten to version 2.0 standards, giving every method a description, implementation notes, model definitions and example values. |
61286 |
|
R129 |
— |
— |
— |
Behavior |
The {"APITimeBehavior":"AppTZ"} parameter was extended to respect Date Time fields and adjust Date Time data imported through the API to the correct time zone. |
62594 |
|
R129 |
|
✓ |
|
Dataform |
GET /api/dataform/v2.0/describe/{tableName} added, a query language for defining searches on the fly. |
57862 |
|
R128 |
|
✓ |
|
Dataform |
GET /api/dataform/v2.0/listupdated added, returning primary key IDs for a table name and date range. |
57240 |
|
R126 |
|
✓ |
|
Task |
Task Type to Task Category validation added to the version 2.0 POST and PATCH task methods. |
60172 |
|
R124 |
— |
— |
— |
Dataform |
The Case Type Position Tags lookup group and its values are included in the ClientSpace API, which consumes them to filter case types by position classification. |
59723 |
|
R124 |
✓ |
✓ |
|
Dataform |
PATCH /api/dataform/v2.0/{tableName}/{id}/active/{active} added to set Active status. |
49491 |
|
R123 |
|
✓ |
|
Task |
Task section added to version 2.0: GET search, GET by ID, PATCH and POST. Not present in version 1.0. |
53552 |
|
R123 |
|
✓ |
|
Time Tracker |
Time Tracker section added to version 2.0: GET search, GET by ID, PATCH and POST with linking to a record ID. Not present in version 1.0. |
57773 |
|
R123 |
|
✓ |
|
File |
Versioned file methods added to version 2.0: insert, update and delete by file or link GUID, and download a specific file by file GUID. |
57530, 59779 |
|
R116 |
— |
— |
— |
Behavior |
API time zone settings override ClientSpace settings only when the advanced dataform field parameter {"APITimeBehavior":"AppTZ"} is set. |
55842 |
|
R115 |
✓ |
✓ |
|
Behavior |
Methods binding a request parameter [FromBody] return a message explaining invalid JSON instead of throwing a null reference exception. |
55395 |
|
R104 |
— |
— |
— |
Dataform |
Fixed three issues with log fields written through the PATCH and PUT methods: apostrophes were stored as "u0027" and are now encoded correctly; a null or empty user name now records as "null"; and the appended time stamp uses the abbreviation matching the date (EDT or EST) rather than always the server setting. |
50872 |
|
R102 |
— |
— |
— |
Dataform |
Added the FormatLogTypes method, allowing data to be appended to a dataform log field through the API. Appended entries are added at the top and record the save date and time and the person who made the change. |
48295 |