Release Notes

April 26, 2022

We have made updates to Karbon's public API that impact 3 endpoints: ClientRequests, ClientTaskComments and ClientTasks

High level summary

This document outlines the changes to Karbon's public API as a result of the Karbon release on April 26, 2022.

In summary, the API changes impact only 3 endpoints:

  1. JSONCopied!
    ClientRequests
  2. JSONCopied!
    ClientTaskComments
  3. JSONCopied!
    ClientTasks

ClientRequests

Use parentheses syntax instead of slash to request a single entity:

JSONCopied!
/v3/ClientRequests('{key}')

In a previous release of the API, individual entities were requested by slash syntax:

JSONCopied!
/v3/ClientRequests/{key}

The response from this endpoint will now have the same format whether querying it as a collection with

JSONCopied!
$filter
parameters or querying an individual client request.

In particular, the

JSONCopied!
ClientRequestRecipientKey
property will now appear as a member of the
JSONCopied!
Recipient
property regardless of whether the endpoint was accessed as a collection or a single entity.

In a previous release of the API, the

JSONCopied!
ClientRequestRecipientKey
appeared at the root level when accessing the endpoint as a collection.

It is now possible to search for client requests with a given

JSONCopied!
ClientRequestRecipientKey
with a
JSONCopied!
$filter
parameter using a new property path:

JSONCopied!
/v3/ClientRequests/?$filter=Recipient/ClientRequestRecipientKey eq 'ABC123'


ClientTaskComments, ClientTasks

Use parentheses syntax instead of slash to request a single entity. This applies to all verbs already supported by these endpoints (

JSONCopied!
GET
and
JSONCopied!
PATCH
for
JSONCopied!
ClientTasks
;
JSONCopied!
GET
,
JSONCopied!
POST
,
JSONCopied!
PATCH
, and
JSONCopied!
DELETE
for
JSONCopied!
ClientTaskComments
).

JSONCopied!
/v3/ClientTasks('{key}')

JSONCopied!
/v3/ClientTaskComments('{key}')

In a previous release of the API, individual entities were requested by slash syntax:

JSONCopied!
/v3/ClientTasks/{key}

JSONCopied!
/v3/ClientTaskComments/{key}