ALERT: Some images may not load properly within the Knowledge Base Article. If you see a broken image, please right-click and select 'Open image in a new tab'. We apologize for this inconvenience.

Rally: WSAPI - Display Colors of Work Items

book

Article ID: 11610

calendar_today

Updated On:

Products

CA Agile Central On Premise (Rally) CA Agile Central SaaS (Rally)

Issue/Introduction



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

Resolution

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:

<Please see attached file for image>

User-added image

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

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

 



Kanban Display Colors
 ColorHex code

<Please see attached file for image>

User-added image
Dark Blue#105cab

<Please see attached file for image>

User-added image
Blue#21a2e0

<Please see attached file for image>

User-added image
Green#107c1e

<Please see attached file for image>

User-added image
Purple#4a1d7e

<Please see attached file for image>

User-added image
Pink#df1a7b

<Please see attached file for image>

User-added image
Burnt Orange#ee6c19

<Please see attached file for image>

User-added image
Orange#f9a814

<Please see attached file for image>

User-added image
Yellow#fce205

<Please see attached file for image>

User-added image
Grey#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 Rally'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:

Rally: Is there a User Story/Task Color Key Legend?



CA Agile Central

Attachments

1558700405871000011610_sktwi1f5rjvs16p1k.png get_app
1558700404088000011610_sktwi1f5rjvs16p1j.png get_app
1558700401974000011610_sktwi1f5rjvs16p1i.png get_app
1558700400067000011610_sktwi1f5rjvs16p1h.png get_app
1558700398150000011610_sktwi1f5rjvs16p1g.png get_app
1558700396267000011610_sktwi1f5rjvs16p1f.png get_app
1558700394339000011610_sktwi1f5rjvs16p1e.png get_app
1558700392508000011610_sktwi1f5rjvs16p1d.png get_app
1558700390731000011610_sktwi1f5rjvs16p1c.png get_app
1558700388652000011610_sktwi1f5rjvs16p1b.png get_app