Get Child Bars

Response body

object

results

array of objects

required

results*

object

id

integer

required

The bar's unique database identifier.

name

string

required

Title of the bar.

description

string | null

required

In-depth explanation of what the bar represents.

roadmap

object | null

required

Related roadmap resource, to which the bar belongs.

starts_on

date | null

required

Date for which work associated with the bar is to begin.

ends_on

date | null

required

Date for which work associated with the bar is to end.

strategic_value

string | null

required

Why this bar is important.

notes

string | null

required

Additional information to be shared.

percent_done

integer | null

required

0 to 100

Determines the shading of the bar to indicate progress. Null is fully saturated. 0-100 displays a gradual shading until fully saturated.

tags

array of strings

required

Keywords and terms associated with the bar.

tags*

lane

string | null

required

The lane assigned to the bar.

legend

string | null

required

The legend assigned to the bar.

custom_text_fields

array of objects

required

custom_text_fields*

object

label

string

required

The field's label

value

string | null

required

Value assigned to the field

custom_dropdown_fields

array of objects

required

custom_dropdown_fields*

object

label

string

required

The field's label

value

string | null

required

Value assigned to the field

url

string

required

URL to view the bar in a browser.

is_container

boolean

required

Whether or not this bar is a container

parent

object | null

required

Container of the bar.

parked

boolean

required

Defaults to true

Whether or not this bar is parked

created_at

date-time

required

Date and time the bar was first created.

updated_at

date-time

required

Date and time the bar was last updated.

child_bar_count

integer

required

The number of child bars associated with the container.

comment_count

integer

required

The number of comments associated with the bar.

link_count

integer

required

The number of links associated with the bar.

requires_connection_count

integer

required

The number of requires connections associated with the bar.

required_by_connection_count

integer

required

The number of required by connections associated with the bar.

paging

object

required

record_count

integer

required

The total number of elements existing in the collection (pre-paging)

page_count

integer

required

The total number of pages

current_page

integer

required

The current page

page_size

integer

required

The number of elements returned in the current page

200lists child bars

401authentication failed

403forbidden

404bar not found

422bad pagination parameters