REST - Revision history

Robl at 18:19, 6 March 2025

2025-03-06T18:19:33Z

← Older revision		Revision as of 14:19, 6 March 2025
Line 5:		Line 5:
	Though you may see references to older 3.x releases of RT below, the REST 1.0 interface has not changed in any significant way in 4.x.		Though you may see references to older 3.x releases of RT below, the REST 1.0 interface has not changed in any significant way in 4.x.

	This page is for REST version 1.0. The next version of the RT REST interface, version 2.0, is available as an [https://metacpan.org/pod/RT::Extension::REST2 extension] for RT 4.4 and above~~, and~~ is core in RT 5.0.0 and above. See: [[REST2]]		This page is for REST version 1.0.

			The next version of the RT REST interface, version 2.0, is available as an [https://metacpan.org/pod/RT::Extension::REST2 extension] for RT 4.4 and above.

			REST2 is core in RT 5.0.0 and above. See: [[REST2]]

	[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.		[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.

Robl at 18:18, 6 March 2025

2025-03-06T18:18:07Z

← Older revision		Revision as of 14:18, 6 March 2025
Line 5:		Line 5:
	Though you may see references to older 3.x releases of RT below, the REST 1.0 interface has not changed in any significant way in 4.x.		Though you may see references to older 3.x releases of RT below, the REST 1.0 interface has not changed in any significant way in 4.x.

	This page is for REST version 1.0. The next version of the RT REST interface, version 2.0, is available as an [https://metacpan.org/pod/RT::Extension::REST2 extension].		This page is for REST version 1.0. The next version of the RT REST interface, version 2.0, is available as an [https://metacpan.org/pod/RT::Extension::REST2 extension] for RT 4.4 and above, and is core in RT 5.0.0 and above. See: [[REST2]]

	[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.		[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.

Phanousk: /* Ticket Search */

2023-08-17T14:54:58Z

Ticket Search

← Older revision		Revision as of 10:54, 17 August 2023
Line 252:		Line 252:
	* i: ticket/<ticket-id>		* i: ticket/<ticket-id>
	* s: <ticket-id>: <ticket-subject>		* s: <ticket-id>: <ticket-subject>
	* l: a multi-line format		* l: a multi-line format (Full ticket details without content)
	Example:		Example:
	<code>/REST/1.0/search/ticket?query=Queue='fooQueue'&orderby=+Created&format=i</code>		<code>/REST/1.0/search/ticket?query=Queue='fooQueue'&orderby=+Created&format=i</code>

Rabin: /* Ticket Edit */

2021-02-23T20:40:15Z

Ticket Edit

← Older revision		Revision as of 16:40, 23 February 2021
Line 339:		Line 339:
	</pre>		</pre>
	*PHP		*PHP
	<~~pre~~>		<syntaxhighlight lang="php">
	$username = rt_user;		$username = rt_user;
	$password = rt_pass;		$password = rt_pass;
	$url = "http://server.domain.tld/REST/1.0/ticket/<ticket id>/edit?user=$username&pass=$password";		$url = "http://server.domain.tld/REST/1.0/ticket/<ticket id>/edit?user=$username&pass=$password";
	$request = new HttpRequest($url, HTTP_METH_POST);
	$post_data=array("content"=>"AdminCc: userX\nText: This is a REST test edit ticket\n");		$request = new HttpRequest($url, HTTP_METH_POST);
			$post_data=array("content"=>"AdminCc: userX\nText: This is a REST test edit ticket\n");
	// add the post fields
	$request->addPostFields($postData);		// add the post fields
	// response from RT		$request->addPostFields($postData);
	$response = $request->send()->getBody();
	print_r($response);		// response from RT
	</~~pre~~>		$response = $request->send()->getBody();
			print_r($response);
			</syntaxhighlight>

	==== Tickets History Reply ====		==== Tickets History Reply ====

Rabin: /* Python */

2021-02-16T20:18:56Z

Python

← Older revision		Revision as of 16:18, 16 February 2021
Line 602:		Line 602:

	=== Python ===		=== Python ===
	<~~pre~~>		<SyntaxHighlight lang="python">
	import cookielib		import cookielib
	import urllib		import urllib
	import urllib2		import urllib2

	# creates a cookie for the rtserver with the credentials given at initialization.		# creates a cookie for the rtserver with the credentials given at initialization.
	# define your credentials here		# define your credentials here
	access_user = 'your_login'		access_user = 'your_login'
	access_password = 'your_password'		access_password = 'your_password'

	# here is the RequestTracker URI we try to access		# here is the RequestTracker URI we try to access
	uri = 'http://your-rt-instance.com/REST/1.0/'		uri = 'http://your-rt-instance.com/REST/1.0/'

	# trying login on rt server		# trying login on rt server
	cj = cookielib.LWPCookieJar()		cj = cookielib.LWPCookieJar()
	opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))		opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
Line 629:		Line 629:
	# could not connect to server		# could not connect to server
	print "Not able to login"		print "Not able to login"
	</~~pre~~>		</SyntaxHighlight>

	=== Ruby ===		=== Ruby ===

Rabin: /* PHP */

2021-02-16T20:16:08Z

PHP

← Older revision		Revision as of 16:16, 16 February 2021
Line 668:		Line 668:

	=== PHP ===		=== PHP ===
	<~~pre~~>		<SyntaxHighlight lang="php">
	$username = rt_user;		$username = rt_user;
	$password = rt_pass;		$password = rt_pass;
Line 677:		Line 677:
	$response = $request->send();		$response = $request->send();
	print_r($response);		print_r($response);
	</~~pre~~> OR<~~pre~~>		</SyntaxHighlight>

			OR

			<SyntaxHighlight lang="php">
	$username = rt_user;		$username = rt_user;
	$password = rt_pass;		$password = rt_pass;
Line 685:		Line 689:
	// in $post_data array		// in $post_data array
	// Example : \nCF-customfield1:testdata		// Example : \nCF-customfield1:testdata
	$post_data=array("content"=>"Queue: General~~\nRequestor~~: user@domain~~\nSubject~~: REST test 1~~\nOwner~~: userX~~\nAdminCc~~: userX~~\nText~~: This is a REST test\n");		$post_data = array(
			"content" =>
			"Queue: General" . PHP_EOL .
			"Requestor: user@domain" . PHP_EOL .
			"Subject: REST test 1" . PHP_EOL .
			"Owner: userX" . PHP_EOL .
			"AdminCc: userX" . PHP_EOL .
			"Text: This is a REST test" . PHP_EOL
			);
	$request->addPostFields($post_data);		$request->addPostFields($post_data);

	try		try
	{		{
	response = $request->send()->getBody();		response = $request->send()->getBody();
	print_r($response);		print_r($response);
	}catch (HttpException $ex) {		} catch (HttpException $ex) {
	echo $ex;		echo $ex;
	}</~~pre~~>		}
			</SyntaxHighlight>

	=== C# ===		=== C# ===

Phanousk: /* Interface */

2019-12-09T13:49:07Z

Interface

← Older revision		Revision as of 09:49, 9 December 2019
Line 421:		Line 421:


			=== User ===
	=== ===

	==== User Create ====		==== User Create ====
Line 431:		Line 430:
	To update an existing user: post on <code>/REST/1.0/user/<user-id>/edit</code> with a variable named "content", containing "key: value" line by line (like the one displayed when issuing <code>user/<user-id>/show</code>).		To update an existing user: post on <code>/REST/1.0/user/<user-id>/edit</code> with a variable named "content", containing "key: value" line by line (like the one displayed when issuing <code>user/<user-id>/show</code>).

			=== Queue ===
			Search for all queues mail addresses like thist:
			/REST/1.0/search/queue?query=\&fields=CorrespondAddress,CommentAddress

			==== Single queue properties ====
	=== ~~Queue Properties~~ ===

	Gets the data for a single queue.		Gets the data for a single queue.

Jbrandt at 17:10, 2 May 2019

2019-05-02T17:10:00Z

← Older revision		Revision as of 13:10, 2 May 2019
Line 3:		Line 3:
	The REST Interface gives you access to your RT Database. The complete communication is encapsulated in the HTTP protocol. The interface should be accessible in your installation.		The REST Interface gives you access to your RT Database. The complete communication is encapsulated in the HTTP protocol. The interface should be accessible in your installation.

	Though you may see references to older 3.x releases of RT below, ~~Best Practice indicates that~~ the REST ~~stuff~~ has not changed in any significant way in 4.x as of, ~~at least~~, 1/~~2012~~.		Though you may see references to older 3.x releases of RT below, the REST 1.0 interface has not changed in any significant way in 4.x.

			This page is for REST version 1.0. The next version of the RT REST interface, version 2.0, is available as an [https://metacpan.org/pod/RT::Extension::REST2 extension].

	[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.		[{{SERVER}}/index.php?search={{TALKPAGENAME}}&title=Special:Search Legacy Comments] are available from the previous Wikia instance.

Alexguichet: Added ticket merges (because I had to dive in to the RT source to figure out if it even exists, oh god)

2018-11-30T14:44:48Z

Added ticket merges (because I had to dive in to the RT source to figure out if it even exists, oh god)

← Older revision		Revision as of 10:44, 30 November 2018
Line 395:		Line 395:
	RefersTo: http://some.external/link		RefersTo: http://some.external/link
	</pre>		</pre>

			==== Ticket Merge ====
			To merge tickets: POST on "<code>/REST/1.0/ticket/<origin-ticket-id>/merge/<into-ticket-id></code>". (I don't think any content is required, but I send "id" and "into" anyway.)

	=== User Properties ===		=== User Properties ===

Jbrandt at 14:25, 1 November 2018

2018-11-01T14:25:33Z

← Older revision		Revision as of 10:25, 1 November 2018
Line 489:		Line 489:
	== Miscellaneous ==		== Miscellaneous ==
	=== Data format ===		=== Data format ===
	History entries time returns in UTC, boolean returns as <code>1</code> (true) and <code>0</code>(false).
	Use only <code>"\n"</code>, not <code>"\r\n"</code>in post content.		* History entries time returns in UTC, boolean returns as <code>1</code> (true) and <code>0</code>(false).
	Comments in response body starts with <code> </code>
	#symbol.		* Use only <code>"\n"</code>, not <code>"\r\n"</code>in post content.

			* Comments in response body starts with with a hash (<code>#</code>) symbol.

	=== Request status ===		=== Request status ===