Milestones

Fields

id
discussion unique identifier number
title
discussion title string
description
discussion text
created-at
discussion creation time
updated-at
discussion last update time
tags
an array of tags. Only has the name field
ref_tags
an array of tags. Only has the name field

Methods

get_all

returns all milestones from the given project

Parameters

  • project: PROJECT_ALIAS (alias of a specific project) - mandatory
  • company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
  • format: xml | json - not mandatory, defaults to the HTTP Accept header.
  • callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/milestones/get_all - milestones
http://company_alias.goplanapp.com/project_alias/api/milestones/get_all?format=json&callback=handlerFunction

Output Formats

  • XML - all milestones

    
    <?xml version="1.0" encoding="UTF-8"?>
    <milestones type="array">
    	<milestone>
    		<cid type="integer">4</cid>
    		<company-id type="integer">1</company-id>
    		<created-at type="datetime">2009-05-18T01:18:13+01:00</created-at>
    		<description/>
    		<end-date type="date">2009-05-22</end-date>
    		<tasks-count type="integer">0</tasks-count>
    		<title>Sprint #1</title>
    		<updated-at type="datetime">2009-05-18T01:18:13+01:00</updated-at>
    		<tags type="array"/>
    	</milestone>
    	<milestone>
    		<cid type="integer">3</cid>
    		<company-id type="integer">1</company-id>
    		<created-at type="datetime">2009-05-16T20:11:55+01:00</created-at>
    		<description/>
    		<end-date type="date">2009-05-26</end-date>
    		<tasks-count type="integer">0</tasks-count>
    		<title>Sprint #2</title>
    		<updated-at type="datetime">2009-05-17T14:31:47+01:00</updated-at>
    		<tags type="array"/>
    	</milestone>
    	<milestone>
    		<cid type="integer">5</cid>
    		<company-id type="integer">1</company-id>
    		<created-at type="datetime">2009-06-25T19:31:42+01:00</created-at>
    		<description>Beta version</description>
    		<end-date type="date">2009-07-01</end-date>
    		<tasks-count type="integer">0</tasks-count>
    		<title>Sprint #3</title>
    		<updated-at type="datetime">2009-06-25T19:31:42+01:00</updated-at>
    		<tags type="array"/>
    	</milestone>
    	<milestone>
    		<cid type="integer">6</cid>
    		<company-id type="integer">1</company-id>
    		<created-at type="datetime">2009-07-03T13:46:05+01:00</created-at>
    		<description>
    			Small bugfixes
    		</description>
    		<end-date type="date">2009-07-14</end-date>
    		<tasks-count type="integer">0</tasks-count>
    		<title>Sprint #4</title>
    		<updated-at type="datetime">2009-07-03T13:51:34+01:00</updated-at>
    		<tags type="array"/>
    	</milestone>
    </milestones>
    		
  • JSON - all milestones

    
    [{"milestone": {"tags": [], "end_date": "2009/05/22", "updated_at": "2009/05/18 01:18:13 +0100", "tasks_count": 0, "title": "Sprint #1", "description": "", "company_id": 1, "cid": 4, "created_at": "2009/05/18 01:18:13 +0100"}}, {"milestone": {"tags": [], "end_date": "2009/05/26", "updated_at": "2009/05/17 14:31:47 +0100", "tasks_count": 0, "title": "Sprint #2", "description": "", "company_id": 1, "cid": 3, "created_at": "2009/05/16 20:11:55 +0100"}}, {"milestone": {"tags": [], "end_date": "2009/07/01", "updated_at": "2009/06/25 19:31:42 +0100", "tasks_count": 0, "title": "Sprint #3", "description": "Beta version", "company_id": 1, "cid": 5, "created_at": "2009/06/25 19:31:42 +0100"}}, {"milestone": {"tags": [], "end_date": "2009/07/14", "updated_at": "2009/07/03 13:51:34 +0100", "tasks_count": 0, "title": "Sprint #4", "description": "Small bugfixes", "company_id": 1, "cid": 6, "created_at": "2009/07/03 13:46:05 +0100"}}]
    		

get

returns a single milestone information

Parameters

  • id: MILESTONE_CID (project-wide unique milestone identifier #) - mandatory
  • project: PROJECT_ALIAS (alias of a specific project) - mandatory
  • company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
  • format: xml | json - not mandatory, defaults to the HTTP Accept header.
  • callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples

	
		http://company_alias.goplanapp.com/project_alias/api/milestones/get/6

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <milestone>
    	<cid type="integer">6</cid>
    	<company-id type="integer">1</company-id>
    	<created-at type="datetime">2009-07-03T13:46:05+01:00</created-at>
    	<description>
    		Small bugfixes
    	</description>
    	<end-date type="date">2009-07-14</end-date>
    	<tasks-count type="integer">0</tasks-count>
    	<title>Sprint #4</title>
    	<updated-at type="datetime">2009-07-03T13:51:34+01:00</updated-at>
    	<tags type="array"/>
    	<tasks type="array">
    		<task>
    			<cid type="integer">27</cid>
    			<created-at type="datetime">2009-06-19T16:43:08+01:00</created-at>
    			<description>Yet another task</description>
    			<due-date type="date" nil="true"/>
    			<id type="integer">31</id>
    			<parent-id type="integer" nil="true"/>
    			<status type="integer">0</status>
    			<title>Test dummy task</title>
    			<updated-at type="datetime">2009-07-13T18:23:35+01:00</updated-at>
    		</task>
    	</tasks>
    </milestone>
    		
    	
  • JSON

    
    {"milestone": {"tags": [], "end_date": "2009/07/14", "updated_at": "2009/07/03 13:51:34 +0100", "tasks_count": 1, "title": "Sprint #4", "tasks": [{"status": 0, "updated_at": "2009/07/13 18:23:35 +0100", "title": "Test dummy task", "id": 31, "description": "Yet another task", "due_date": null, "cid": 27, "parent_id": null, "created_at": "2009/06/19 16:43:08 +0100"}], "description": "Small bugfixes", "company_id": 1, "cid": 6, "created_at": "2009/07/03 13:46:05 +0100"}}
    		

create

creates a new milestone and returns it

Parameters

  • milestone[title]: DISCUSSION_TITLE (title of the new milestone) - mandatory
  • milestone[description]: DISCUSSION_DESCRIPTION (description of the new milestone) - not mandatory
  • milestone[end_date]: MILESTONE_END_DATE (end date of the new milestone) - mandatory
  • tags[]: TAG_TEXT (use one tags[]=tagtext for each tag on the item. Specify project-wide hot-links with the notation ITEM_TYPE:ITEM_CID i.e.: ticket:3) - not mandatory
  • project: PROJECT_ALIAS (alias of a specific project) - mandatory
  • company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
  • format: xml | json - not mandatory, defaults to the HTTP Accept header.
  • callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/milestones/create - pass the other parameters by POST
http://company_alias.goplanapp.com/project_alias/api/milestones/create?milestone[title]=Sprint 6&milestone[description]=Yet another milestone&milestone[end_date]=Tue Apr 07 2009 19:08:36 GMT+0100 (CET)
http://company_alias.goplanapp.com/project_alias/api/milestones/create?format=json&milestone[title]=Development&milestone[description]=Yet another milestone&milestone[end_date]=Tue Apr 07 2009 19:08:36 GMT+0100 (CET)&tags[]=development&tags[]=brainstorm&tags[]=methodologies - a milestone with tags

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <milestone>
    	<cid type="integer">8</cid>
    	<company-id type="integer">1</company-id>
    	<created-at type="datetime">2009-07-13T18:36:29+01:00</created-at>
    	<description nil="true"/>
    	<end-date type="date">2009-04-07</end-date>
    	<tasks-count type="integer">0</tasks-count>
    	<title>Sprint 6</title>
    	<updated-at type="datetime">2009-07-13T18:36:29+01:00</updated-at>
    	<tags type="array">
    		<tag>
    			<name>development</name>
    		</tag>
    		<tag>
    			<name>brainstorm</name>
    		</tag>
    		<tag>
    			<name>methodologies</name>
    		</tag>
    	</tags>
    </milestone>
    		
  • JSON

    
    {"milestone": {"tags": [{"name": "development"}, {"name": "brainstorm"}, {"name": "methodologies"}], "end_date": "2009/07/14", "updated_at": "2009-06-13T18:36:29+01:00", "tasks_count": 1, "title": "Sprint 6", "description": "", "company_id": 1, "cid": 8, "created_at": "2009-06-13T18:36:29+01:00"}}
    		

update

updates an existing milestone and returns it

Parameters

  • id: MILESTONE_CID (project-wide unique milestone identifier #) - mandatory
  • milestone[title]: DISCUSSION_TITLE (title of the new milestone) - mandatory
  • milestone[description]: DISCUSSION_DESCRIPTION (description of the new milestone) - not mandatory
  • milestone[end_date]: MILESTONE_END_DATE (end date of the new milestone) - mandatory
  • tags[]: TAG_TEXT (use one tags[]=tagtext for each tag on the item. Specify project-wide hot-links with the notation ITEM_TYPE:ITEM_CID i.e.: ticket:3) - not mandatory
  • project: PROJECT_ALIAS (alias of a specific project) - mandatory
  • company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
  • format: xml | json - not mandatory, defaults to the HTTP Accept header.
  • callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/milestones/update - pass the other parameters by POST
http://company_alias.goplanapp.com/project_alias/api/milestones/update?id=8&milestone[title]=Sprint 6&milestone[description]=Yet another milestone with a different end date&milestone[end_date]=Tue Apr 16 2009 19:08:36 GMT+0100 (CET)
http://company_alias.goplanapp.com/project_alias/api/milestones/update?format=json&id=8&milestone[title]=Development&milestone[description]=Yet another milestone with less one tag&milestone[end_date]=Tue Apr 07 2009 19:08:36 GMT+0100 (CET)&tags[]=development&tags[]=brainstorm&

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <milestone>
    	<cid type="integer">8</cid>
    	<company-id type="integer">1</company-id>
    	<created-at type="datetime">2009-07-13T18:36:29+01:00</created-at>
    	<description>Yet another milestone with less one tag</description>
    	<end-date type="date">2009-04-07</end-date>
    	<tasks-count type="integer">0</tasks-count>
    	<title>Development</title>
    	<updated-at type="datetime">2009-07-13T18:49:32+01:00</updated-at>
    	<tags type="array">
    		<tag>
    			<name>development</name>
    		</tag>
    		<tag>
    			<name>brainstorm</name>
    		</tag>
    	</tags>
    </milestone>
    		
  • JSON

    
    {"milestone": {"tags": [{"name": "development"}, {"name": "brainstorm"}], "end_date": "2009/04/07", "updated_at": "2009/07/13 18:49:32 +0100", "tasks_count": 0, "title": "Development", "description": "Yet another milestone with less one tag", "company_id": 1, "cid": 8, "created_at": "2009/07/13 18:36:29 +0100"}}
    		

destroy

deletes a milestone from the project and returns it

Parameters

  • id: MILESTONE_CID (project-wide unique milestone identifier #) - mandatory
  • project: PROJECT_ALIAS (alias of a specific project) - mandatory
  • company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
  • format: xml | json - not mandatory, defaults to the HTTP Accept header.
  • callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/milestone/destroy/8

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <milestone>
    	<cid type="integer">8</cid>
    	<company-id type="integer">1</company-id>
    	<created-at type="datetime">2009-07-13T18:36:29+01:00</created-at>
    	<description>Yet another milestone with less one tag</description>
    	<end-date type="date">2009-04-07</end-date>
    	<tasks-count type="integer">0</tasks-count>
    	<title>Development</title>
    	<updated-at type="datetime">2009-07-13T18:49:32+01:00</updated-at>
    </milestone>
    		
  • JSON

    
    {"milestone": {"end_date": "2009/04/07", "updated_at": "2009/07/13 18:49:32 +0100", "tasks_count": 0, "title": "Development", "description": "Yet another milestone with less one tag", "company_id": 1, "cid": 8, "created_at": "2009/07/13 18:36:29 +0100"}}
    		

Follow us on Twitter and Facebook. Talk to us and Get Satisfaction.

Goplan is a product of Webreakstuff | Contact support | Terms of Service