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

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 5: Line 5:
:'''URI::''' <tt>{{platformURL}}/rest/record/history</tt>
:'''URI::''' <tt>{{platformURL}}/rest/record/history</tt>


:'''xx::'''  
:'''Content Type:''' <tt>application/xml</tt>
 
:'''Content:'''  
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
Line 18: Line 20:
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 23:59, 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
Content Type: application/xml
Content:
<?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>

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 History object.