Difference between revisions of "REST API:Add a Note"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
:'''Method:''' <tt>POST</tt> | :'''Method:''' <tt>POST</tt> | ||
:'''URI | :'''URI:''' <tt>{{platformURL}}/rest/record/history</tt> | ||
:'''Content Type:''' <tt>application/xml</tt> | :'''Content Type:''' <tt>application/xml</tt> | ||
:'''Content:''' | :'''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"?> | ||
<platform> | <platform> | ||
| 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 20: | 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 <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.