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

From AgileApps Support Wiki
imported>Aeric
(Created page with "This examples uses the REST API to add a private note to an object record. :'''Method:''' <tt>POST</tt> :'''URI::''' <tt>{{platformURL}}/rest/record/history</tt> :'''xx::'...")
 
imported>Aeric
Line 7: Line 7:
:'''xx::'''  
:'''xx::'''  
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<platform>
<platform>
   <login>
   <record>
      <userName>jim@acme.com</userName>
      <visible_to_customer>0</visible_to_customer>
      <password>jimacme</password>
      <description>DESCRIPTION</description>
   </login>
      <related_to type="OBJECT_NAME">RECORD_ID</related_to>
      <category>29</category>
   </record>
</platform>
</platform>
</syntaxhighlight>
</syntaxhighlight>
:''Notes:''
::* To add a public note, set to visible_to_customer to 1

Revision as of 23:56, 18 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
xx::
<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