Tickets

Fields

cid: ticket's project-wide unique identifier number
status: ticket's status (0 = open, 1 = assigned, 2 = completed, 3 = won't fix, 4 = can't reproduce, 5 = duplicate)
priority: ticket's status (1 = lowest, 2 = low, 3 = medium, 4 = high, 5 = highest)
comments-count: ticket's number of comments
description: ticket's description
title: ticket's title string
created-at: ticket's creation time
updated-at: ticket's last update time
closed_by: ticket's closer identifier number
assignee_id: ticket's assignee identifier number - only when returning an array of tickets
author_id: ticket's author identifier number - only when returning an array of tickets
author: See User's Fields - only when returning the specific ticket
assignee: See User's Fields - only when returning the specific ticket
comments: an array of comments. See Comment's Fields - only when returning the specific ticket
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 tickets in a 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://companydomain.goplanapp.com/project_alias/api/tickets/get_all 

	http://companydomain.goplanapp.com/api/tickets/get_all?format=json&callback;=handlerFunction&project;=project_alias

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>

<tickets type="array">

	<ticket>

		<assignee-id type="integer" nil="true"></assignee-id>

		<author-id type="integer">1</author-id>

		<cid type="integer">6</cid>

		<closed-by type="integer" nil="true"></closed-by>

		<comments-count type="integer">0</comments-count>

		<created-at type="datetime">2009-03-19T15:40:47+00:00</created-at>

		<description>ahahah</description>

		<priority type="integer">3</priority>

		<status type="integer">2</status>

		<title>hhaahah</title>

		<updated-at type="datetime">2009-03-19T17:05:41+00:00</updated-at>

		<ref-tags type="array"/>

		<tags type="array">

			<tag>

				<name>tetes</name>

			</tag>

		</tags>

	</ticket>

	<ticket>

		<assignee-id type="integer" nil="true"></assignee-id>

		<author-id type="integer">1</author-id>

		<cid type="integer">20</cid>

		<closed-by type="integer" nil="true"></closed-by>

		<comments-count type="integer">0</comments-count>

		<created-at type="datetime">2009-03-24T16:29:41+00:00</created-at>

		<description>ggg</description>

		<priority type="integer">3</priority>

		<status type="integer">0</status>

		<title>ggg</title>

		<updated-at type="datetime">2009-03-24T17:54:34+00:00</updated-at>

		<ref-tags type="array"/>

		<tags type="array">

			<tag>

				<name>cena</name>

			</tag>

		</tags>

	</ticket>

	<ticket>

		<assignee-id type="integer">1</assignee-id>

		<author-id type="integer">1</author-id>

		<cid type="integer">21</cid>

		<closed-by type="integer" nil="true"></closed-by>

		<comments-count type="integer">0</comments-count>

		<created-at type="datetime">2009-03-26T16:04:48+00:00</created-at>

		<description>asdasda</description>

		<priority type="integer">3</priority>

		<status type="integer">1</status>

		<title>dadada</title>

		<updated-at type="datetime">2009-03-26T16:04:48+00:00</updated-at>

		<ref-tags type="array"/>

		<tags type="array">

			<tag>

				<name>dev</name>

			</tag>

		</tags>

	</ticket>

</tickets>

JSON


handler_function([{"ticket": {"ref_tags": [], "created_at": "2021/03/19 15:40:47 +0000", "closed_by": null, "title": "hhaahah", "assignee_id": null, "updated_at": "2021/03/19 17:05:41 +0000", "priority": 3, "description": "ahahah", "comments_count": 0, "cid": 6, "author_id": 1, "tags": [{"name": "tetes"}], "status": 2}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/19 18:12:52 +0000", "closed_by": null, "title": "hdhddh", "assignee_id": 1, "updated_at": "2021/04/03 18:55:46 +0100", "priority": 3, "description": "hddhhd", "comments_count": 3, "cid": 8, "author_id": 1, "tags": [{"name": "cena"}], "status": 1}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/19 18:22:38 +0000", "closed_by": null, "title": "wywywy", "assignee_id": null, "updated_at": "2021/03/19 18:22:50 +0000", "priority": 3, "description": "wywyyw", "comments_count": 1, "cid": 10, "author_id": 1, "tags": [], "status": 0}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/20 14:39:24 +0000", "closed_by": null, "title": "gagaag", "assignee_id": 2, "updated_at": "2021/04/03 18:48:22 +0100", "priority": 4, "description": "gaaggaag", "comments_count": 1, "cid": 12, "author_id": 4, "tags": [{"name": "ssss"}], "status": 1}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/20 19:10:16 +0000", "closed_by": null, "title": "vzvzv", "assignee_id": 4, "updated_at": "2021/03/25 19:38:29 +0000", "priority": 3, "description": "zvzv", "comments_count": 0, "cid": 13, "author_id": 1, "tags": [], "status": 1}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/20 19:11:47 +0000", "closed_by": null, "title": "fafaffaafaf", "assignee_id": null, "updated_at": "2021/03/20 19:11:47 +0000", "priority": 3, "description": "afaf", "comments_count": 0, "cid": 14, "author_id": 1, "tags": [{"name": "fafa"}], "status": 0}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/20 19:18:16 +0000", "closed_by": null, "title": "dgdggd", "assignee_id": null, "updated_at": "2021/03/20 19:18:16 +0000", "priority": 3, "description": "dggddg", "comments_count": 0, "cid": 16, "author_id": 1, "tags": [], "status": 0}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/24 16:29:41 +0000", "closed_by": null, "title": "ggg", "assignee_id": null, "updated_at": "2021/03/24 17:54:34 +0000", "priority": 3, "description": "ggg", "comments_count": 0, "cid": 20, "author_id": 1, "tags": [{"name": "cena"}], "status": 0}}, {"ticket": {"ref_tags": [], "created_at": "2021/03/26 16:04:48 +0000", "closed_by": null, "title": "dadada", "assignee_id": 1, "updated_at": "2021/03/26 16:04:48 +0000", "priority": 3, "description": "asdasda", "comments_count": 0, "cid": 21, "author_id": 1, "tags": [{"name": "dev"}], "status": 1}}])

get

returns a single ticket information

Parameters

id: ticket_CID (project-wide unique ticket 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://companydomain.goplanapp.com/projectalias/api/tickets/get/6

	http://companydomain.goplanapp.com/api/tickets/get?id=6&project;=projectalias&format;=json&callback;=handler

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>

<ticket>

	<cid type="integer">6</cid>

	<comments-count type="integer">0</comments-count>

	<created-at type="datetime">2009-03-19T15:40:47+00:00</created-at>

	<description>ahahah</description>

	<priority type="integer">3</priority>

	<status type="integer">2</status>

	<title>hhaahah</title>

	<updated-at type="datetime">2009-03-19T17:05:41+00:00</updated-at>

	<ref-tags type="array"/>

	<author>

		<alias>john</alias>

		<created-at type="datetime">2009-03-17T15:05:51+00:00</created-at>

		<email>john@user_email.com</email>

		<name>John</name>

		<picture-url>http://goplanapp.com/content/server.jpg</picture-url>

		<time-zone>Lisbon</time-zone>

		<updated-at type="datetime">2009-04-06T13:17:08+01:00</updated-at>

		<user-type type="integer">0</user-type>

	</author>

	<tags type="array">

		<tag>

			<name>tetes</name>

		</tag>

	</tags>

	<comments type="array"/>

</ticket>

JSON


{"ticket": {"ref_tags": [], "created_at": "2021/03/19 15:40:47 +0000", "author": {"name": "John", "created_at": "2021/03/17 15:05:51 +0000", "updated_at": "2021/04/06 13:17:08 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "alias": "john", "time_zone": "Lisbon", "email": "john@user_email.com"}, "title": "hhaahah", "updated_at": "2021/03/19 17:05:41 +0000", "priority": 3, "description": "ahahah", "comments_count": 0, "cid": 6, "tags": [{"name": "tetes"}], "status": 2, "comments": []}}

create

creates a new ticket (or sub-ticket) and returns it

Parameters

ticket[title]: ticket_TITLE (title of the new ticket) - mandatory
ticket[description]: ticket_DESCRIPTION (description of the new ticket) - not mandatory (accepts textile)
ticket[priority]: ticket_PRIORITY (priority of the new ticket) - mandatory
ticket[assignee_id]: ticket_ASSIGNEE_ID (assignee_id of the new ticket - ID of the assigned user) - not 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/tickets/create - pass the other parameters by POST

	http://company_alias.goplanapp.com/api/tickets/create?format=json&callback;=handlerfunction&project;=project_alias&ticket;[title]=design&ticket;[description]=designing&ticket;[priority]=3&assignee;_id=5&tags;[]=design&tags;[]=development

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>

<ticket>

	<cid type="integer">6</cid>

	<comments-count type="integer">0</comments-count>

	<created-at type="datetime">2009-03-19T15:40:47+00:00</created-at>

	<description>ahahah</description>

	<priority type="integer">3</priority>

	<status type="integer">2</status>

	<title>hhaahah</title>

	<updated-at type="datetime">2009-03-19T17:05:41+00:00</updated-at>

	<ref-tags type="array"/>

	<author>

		<alias>john</alias>

		<created-at type="datetime">2009-03-17T15:05:51+00:00</created-at>

		<email>john@user_email.com</email>

		<name>John</name>

		<picture-url>http://goplanapp.com/content/server.jpg</picture-url>

		<time-zone>Lisbon</time-zone>

		<updated-at type="datetime">2009-04-06T13:17:08+01:00</updated-at>

		<user-type type="integer">0</user-type>

	</author>

	<tags type="array">

		<tag>

			<name>tetes</name>

		</tag>

	</tags>

	<comments type="array"/>

</ticket>

JSON


{"ticket": {"ref_tags": [], "created_at": "2021/03/19 15:40:47 +0000", "author": {"name": "John", "created_at": "2021/03/17 15:05:51 +0000", "updated_at": "2021/04/06 13:17:08 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "alias": "john", "time_zone": "Lisbon", "email": "john@user_email.com"}, "title": "hhaahah", "updated_at": "2021/03/19 17:05:41 +0000", "priority": 3, "description": "ahahah", "comments_count": 0, "cid": 6, "tags": [{"name": "tetes"}], "status": 2, "comments": []}}

destroy

deletes a ticket from the project and returns it

Parameters

id: ticket_CID (project-wide unique ticket 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/projectalias/api/tickets/destroy/6

	http://company_alias.goplanapp.com/api/tickets/destroy?id=6&project;=projectalias&format;=json&callback;=handler

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>

<ticket>

	<cid type="integer">6</cid>

	<comments-count type="integer">0</comments-count>

	<created-at type="datetime">2009-03-19T15:40:47+00:00</created-at>

	<description>ahahah</description>

	<priority type="integer">3</priority>

	<status type="integer">2</status>

	<title>hhaahah</title>

	<updated-at type="datetime">2009-03-19T17:05:41+00:00</updated-at>

	<ref-tags type="array"/>

	<author>

		<alias>john</alias>

		<created-at type="datetime">2009-03-17T15:05:51+00:00</created-at>

		<email>john@user_email.com</email>

		<name>John</name>

		<picture-url>http://goplanapp.com/content/server.jpg</picture-url>

		<time-zone>Lisbon</time-zone>

		<updated-at type="datetime">2009-04-06T13:17:08+01:00</updated-at>

		<user-type type="integer">0</user-type>

	</author>

	<tags type="array">

		<tag>

			<name>tetes</name>

		</tag>

	</tags>

	<comments type="array"/>

</ticket>

JSON


{"ticket": {"ref_tags": [], "created_at": "2021/03/19 15:40:47 +0000", "author": {"name": "John", "created_at": "2021/03/17 15:05:51 +0000", "updated_at": "2021/04/06 13:17:08 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "alias": "john", "time_zone": "Lisbon", "email": "john@user_email.com"}, "title": "hhaahah", "updated_at": "2021/03/19 17:05:41 +0000", "priority": 3, "description": "ahahah", "comments_count": 0, "cid": 6, "tags": [{"name": "tetes"}], "status": 2, "comments": []}}

update

updates an existing ticket and returns it

Parameters

id: ticket_CID (project-wide unique ticket identifier #) - mandatory
ticket[title]: ticket_TITLE (title of the new ticket) - mandatory
ticket[description]: ticket_DESCRIPTION (description of the new ticket) - not mandatory (accepts textile)
ticket[priority]: ticket_PRIORITY (priority of the new ticket) - mandatory
ticket[assignee_id]: ticket_ASSIGNEE_ID (assignee_id of the new ticket - ID of the assigned user) - not 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/tickets/update/3 - pass the other parameters by POST

	http://company_alias.goplanapp.com/api/tickets/update?id=3&format;=json&callback;=handlerfunction&project;=project_alias&ticket;[title]=design&ticket;[description]=designing&ticket;[priority]=3&assignee;_id=5&tags;[]=design&tags;[]=development

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>

<ticket>

	<cid type="integer">6</cid>

	<comments-count type="integer">0</comments-count>

	<created-at type="datetime">2009-03-19T15:40:47+00:00</created-at>

	<description>ahahah</description>

	<priority type="integer">3</priority>

	<status type="integer">2</status>

	<title>hhaahah</title>

	<updated-at type="datetime">2009-03-19T17:05:41+00:00</updated-at>

	<ref-tags type="array"/>

	<author>

		<alias>john</alias>

		<created-at type="datetime">2009-03-17T15:05:51+00:00</created-at>

		<email>john@user_email.com</email>

		<name>John</name>

		<picture-url>http://goplanapp.com/content/server.jpg</picture-url>

		<time-zone>Lisbon</time-zone>

		<updated-at type="datetime">2009-04-06T13:17:08+01:00</updated-at>

		<user-type type="integer">0</user-type>

	</author>

	<tags type="array">

		<tag>

			<name>tetes</name>

		</tag>

	</tags>

	<comments type="array"/>

</ticket>

JSON


{"ticket": {"ref_tags": [], "created_at": "2021/03/19 15:40:47 +0000", "author": {"name": "John", "created_at": "2021/03/17 15:05:51 +0000", "updated_at": "2021/04/06 13:17:08 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "alias": "john", "time_zone": "Lisbon", "email": "@user_email.com@user_email.com"}, "title": "hhaahah", "updated_at": "2021/03/19 17:05:41 +0000", "priority": 3, "description": "ahahah", "comments_count": 0, "cid": 6, "tags": [{"name": "tetes"}], "status": 2, "comments": []}}

Goplan is a product of Reinhardt Media, Ltd. | Contact support | Terms of Service

Developer account:

API reference:

Tickets

Fields

Methods

get_all

Parameters

Endpoint examples

Output Formats

get

Parameters

Endpoint examples

Output Formats

create

Parameters

Endpoint examples

Output Formats

destroy

Parameters

Endpoint examples

Output Formats

update

Parameters

Endpoint examples

Output Formats