AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:Add a Note"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:
       <visible_to_customer>0</visible_to_customer>
       <visible_to_customer>0</visible_to_customer>
       <description>DESCRIPTION</description>
       <description>DESCRIPTION</description>
       <related_to type="OBJECT_NAME">RECORD_ID</related_to>
       <related_to type="OBJECT_NAME">RECORD_ID</related_to>
       <category>29</category>
       <category>29</category>
   </record>
   </record>
Line 22: Line 22:
:''Notes:''
:''Notes:''
::* To add a public note, set to <tt>visible_to_customer</tt> to <tt>1</tt>
::* To add a public note, set to <tt>visible_to_customer</tt> to <tt>1</tt>
::* Category 29 identifies a note in the record's activity history,<br>For other options, see [[History object]].
::* Category 29 identifies a note in the record's activity history,<br>For other options, see the [[History object]].

Latest revision as of 00:01, 19 May 2015

This examples uses the REST API to add a private note to an object record.

Method: POST
URI: https://{yourDomain}/networking/rest/record/history
Content Type: application/xml
Content:
<syntaxhighlight lang="xml" enclose="div">

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

  <record>
     <visible_to_customer>0</visible_to_customer>
     <description>DESCRIPTION</description>
     <related_to  type="OBJECT_NAME">RECORD_ID</related_to>
     <category>29</category>
  </record>

</platform> </syntaxhighlight>

Notes:
  • To add a public note, set to visible_to_customer to 1
  • Category 29 identifies a note in the record's activity history,
    For other options, see the History object.