[Rt-commit] rt branch, 5.0/rest2-record-links, updated. rt-5.0.0-56-ga8cf2347c7

[Jim Brandt]

The branch, 5.0/rest2-record-links has been updated
       via  a8cf2347c78f43ede527c7ea2cd6177775eeb120 (commit)
      from  605115b27be80ae184fe35b21af9b39e555982e3 (commit)

Summary of changes:
 lib/RT/REST2.pm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

- Log -----------------------------------------------------------------
commit a8cf2347c78f43ede527c7ea2cd6177775eeb120
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Mon Jan 4 16:54:04 2021 -0500

    Explain the options for modifying links via REST2

diff --git a/lib/RT/REST2.pm b/lib/RT/REST2.pm
index c4b4fab285..133aaa1561 100644
--- a/lib/RT/REST2.pm
+++ b/lib/RT/REST2.pm
@@ -539,6 +539,28 @@ Below are some examples using the endpoints above.
     -d '[{ "field" : "id", "operator" : ">=", "value" : 0 }]'
     'https://myrt.com/REST/2.0/asset'
 
+=head3 Ticket Fields
+
+The following describes some of the values you can send when creating and updating
+tickets as shown in the examples above.
+
+=over 4
+
+=item Ticket Links
+
+As shown above, you can update links on a ticket with a C<PUT> and passing the link
+relationship you want to create. The available keys are Parent, Child, RefersTo,
+ReferredToBy, DependsOn, and DependedOnBy. These correspond with the standard link
+types on a ticket. The value can be a single ticket id or an array of ticket ids.
+The indicated link relationship will be set to the value passed, adding or removing
+as needed.
+
+You can specifically add or remove a link by prepending C<Add> or C<Delete> to
+the link type, like C<AddParent> or C<DeleteParent>. These versions also accept
+a single ticket id or an array.
+
+=back
+
 =head3 Transactions
 
     GET /transactions?query=<JSON>

-----------------------------------------------------------------------