Miscellaneous

https://work.planbox.com/api/get_events

Returns Planbox events in the given date range for the given products. An event can be an iteration start or end, or an story which has a deadline.

POST Arguments

  • product_ids[]: An array of product ids .
  • start: A start date.
  • end: An end date.

Result

Returns this JSON object:

{code:<result_code>, content:<result>}

Where <result_code> will be 'ok' on success, or 'error' on failure.
Where <result> is an array of event objects on success or an error message string upon failure.

An event object has these properties:

  • id: Unique event identifier.
    NOTE: Unique within the returned set only.
  • object: Type of object: iteration or story
  • object_id: Unique iteration or story id.
  • image: URI to 20x20 pixel image representing the event.
  • due_on: Date of the event.
  • product_id: Parent product id.
  • name: Name or iteration or story.
  • status: Story status. Emtpy string if iteration.
  • type: Story type. Will be start or end if iteration.

Javascript Example

Uses jQuery's post function to fetch event objects in August 2011 for product id 1234.

$.post('https://work.planbox.com/api/get_events',
	{product_ids:[1234], start:"2011-08-01", end:"2011-08-31"}, 'json');

https://work.planbox.com/api/get_impediments

Returns blocked and rejected stories in the Current iteration of the given products.

POST Arguments

  • product_ids[]: An array of product ids .

Result

Returns this JSON object:

{code:<result_code>, content:<result>}

Where <result_code> will be 'ok' on success, or 'error' on failure.
Where <result> is an array of impediment objects on success or an error message string upon failure.

An impediment object has these properties:

  • id: Unique event identifier.
    NOTE: Unique within the returned set only.
  • object: Type of object. Will be story
  • object_id: Story id.
  • image: URI to 20x20 pixel image representing the story type.
  • due_on: Story due date.
  • product_id: Parent product id.
  • name: Story name.
  • status: Story status.
  • comment: Reason to why story is blocked or rejected.
  • type: Story type.

Javascript Example

Uses jQuery's post function to fetch impediments in the Current iteration of product id 1234.

$.post('https://work.planbox.com/api/get_impediments', {product_ids:[1234]}, 'json');


NOTE: We are in the midst of publishing our API. More to come soon... Email us at help@planbox.com to help us prioritize.

Feedback and Knowledge Base