Agile Central: WSAPI - Display Colors of Work Items

Document ID : KB000011610
Last Modified Date : 14/02/2018
Show Technical Document Details

How to create a filter or query on the Display Color of an Artifact in CA Agile Central?


The hex codes for the colors are used for the display colors on the Artifact.  They are stored in the DisplayColor attribute on the Artifact Object.

HierarchicalRequirement, Defect, Task and other work item types inherit from Artifact type, and can be queried by DisplayColor attribute since it exists on the parent abstract type:

User-added image

An example of the query you would use for them is:

( DisplayColor = "#105cab" )  or ( DisplayColor != null )


Kanban Display Colors
 ColorHex code
User-added imageDark Blue#105cab
User-added imageBlue#21a2e0
User-added imageGreen#107c1e
User-added imagePurple#4a1d7e
User-added imagePink#df1a7b
User-added imageBurnt Orange#ee6c19
User-added imageOrange#f9a814
User-added imageYellow#fce205
User-added imageGrey#848689


Example to find out the color of an artifact via WS API. 
In this example a Feature F123 is used.The steps below apply to any object that inherits from Artifact abstract type (e.g. HierarchicalRequirement, Defect, Task)

1. Open details page of one of the features, e.g. F123

2. Set the color to the first color available in the Display Color field

3. Click outside of the color picker, let CA Agile Central's Editable Details Page to save the value

4. In another tab of the same browser go to WS API interactive document

5. Run a query on PortifoliItem/Feature by FormattedID: (FormattedID = F123)
Check the "fetch full objects" checkbox to make sure DisplayColor is returned

6. DisplayColor is included in the result's json.

NOTE: DisplayColor attribute was introduced in WS API in version 1.43. Version 1.43 and below are currently deprecated.
WS API queries against versions prior to WS API 1.43 will not return DisplayColor. 

NOTE: The white square with the diagonal red line means default color or "null" value.
When a card is set to default color or null value, the color displayed will be the same color as the lighter blue color, even though the attribute value will be listed as "null" as opposed to "#21a2e0".

Additional Information:
Also see:
Agile Central: Is there a User Story/Task Color Key Legend?