View source for REST API:record Resource

Manage [[Object]] records using the [[REST API]].

:''See also:''
::* The REST [[REST API:bulk record Resource|bulk record]] resource to work with multiple records at one time.
::* The REST [[REST API:composite record Resource|composite record]] resource to work with a record and related records in other objects.

=== About the Record Resource ===

==== Available Objects ====
:These objects are available in the record Resource
::*{{Type}}s (except the special {{Type}}s, listed below)
::*{{Type|}}s

==== Predefined Custom Object Fields====
:Every [[Custom Object]] is created with a number of fields that are automatically modified for each record.

:''Learn more:'' [[Custom Object#Predefined Fields]]

==== Data Format for Different Field Types ====
:When adding and updating records, the field type determines the data format.
:''Learn more:'' [[REST API:Field Type Reference]]  

====Special Considerations for Enumerated Fields====
:When a record contains [[Enumerated Fields]], there are additional factors to take into account.
:''Learn more:'' [[Enumerated Field Behavior For REST Web Services]]

==== Special {{Typenolink}}s ====
:These {{Type}}s can not be retrieved using the record Resource. They have specific resource URLs, instead:
:* User - use the [[REST_API:user_Resource|user Resource]]
:* Role - use the [[REST_API:role_Resource|role Resource]]
:* Team - use the [[REST_API:team_Resource|team Resource]]
:* USER_TEAM use the [[REST_API:userTeam_Resource|userTeam Resource]]

==== Requirements ====
:* The logged-in user must have the permissions needed to access and/or modify the object in question.
{{:Record Access Permissions}}

===Retrieve a Record===
Identifies and retrieves a single record in an [[Object]]

;Method:GET
;URI:
:<tt>{{platformURL}}/rest/record/{objectName}/{recordId}</tt>
:<tt>{{platformURL}}/rest/record/{objectName}/{recordId}?retrieveRecordPermissions=true</tt>

:where the optional [[REST API:Retrieve Record Permissions Query Parameter|Retrieve Record Permissions Query Parameter]] adds extra data that tells whether the user has add or delete capabilities.

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
  <record>
    <field1>...value...</field1>
    <field2>...value...</field2>
    <field3 displayValue="...">...value...</field3>
        …
  </record>
</platform> 
</syntaxhighlight>
:'''Notes:'''
:* An enumerated field returns the field label in the <tt>displayValue</tt> attribute. The field value is returned as the data inside the tag.
:* A [[Multi Object Lookup]] field has two attributes, in addition to the <tt>type</tt> attribute that is specified when you do an add or update. The syntax looks like this:
::<syntaxhighlight lang="java" enclose="div">
<field_name type="{objectName}" 
    uri="{REST_resource_record_id}" 
    display_value="{textual_record_identifier}">{record_id}</field>
</syntaxhighlight>
::where the [[Record Locator]] is the information that is displayed for the selected record.
:* For example, in the [[Sample Order Processing System]], if priority tags were in a separate table, then the contents of the tag field might look like this:
::<syntaxhighlight lang="java" enclose="div">
<tag type="Priority_Tag" 
    uri="https://{{domain}}/networking/rest/record/Priority_Tag/9467890" 
    displayValue="Rush, Overnight">9467890</tag>
</syntaxhighlight>

===Dynamic Search===
;Method:GET

;URI:
:<tt>{{platformURL}}/rest/record/{objectName}?{query_params}</tt>
:<tt>{{platformURL}}/rest/record/{objectName}?{query_params}&retrieveRecordPermissions=true</tt>
:where:
::* <tt>{objectName}</tt> is an [[Object Type Identifier]] or [[Database View | Database View ID]]
::* The optional [[REST API:Retrieve Record Permissions Query Parameter|Retrieve Record Permissions Query Parameter]] adds extra data that tells whether the user has add or delete capabilities. 

:;Sample Search:
:: <tt><nowiki>?fieldList=name,id&filter=name contains 'smith' & sortBy=id</nowiki></tt>
:: (See the object or view being searched for a list of field names.)

{{:REST API:Dynamic Search}}
:'''Note:''' When searching a multi-object lookup field, the object ID (not name) must be specified.<br>Syntax: <tt>{object_id}:{record_id}</tt>
  
;Response: Here is the response for a search on a custom object where ObjectName is the name of the custom object:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <record>
        <field1>...value...</field1>
        <field2>...value...</field2>
        <field3 displayValue="...">...value...</field3>
    </record>
    ...
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>30</recordCount>
</platform>
</syntaxhighlight>
:'''Notes:'''
:* An enumerated field returns the field label in the <tt>displayValue</tt> attribute. The field value is returned as the data inside the tag.

;Response: Here is the response for a search on a database view where ObjectName is the DatabaseViewId:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <record>
        <alias1.fileName1>value1</alias1.fileName1>
        <alias1.fileName2>value1</alias1.fileName2>
        <alias2.fileName1>value1</alias2.fileName1>
        <alias2.fileName2>value1</alias2.fileName2>
        ...
    </record>
    <record>
    ...
    </record>
        <message>
            <code>0</code>
            <description>Success</description>
        </message>
    <recordCount>30</recordCount>
</platform>
</syntaxhighlight>

===Add a Record===
Adds a record to an [[Object]]

;Method:POST
;URI:<tt>{{platformURL}}/rest/record/{objectName}?{query_parameters}</tt>

{{Query Parameters|
:* <tt>retrieveRecord</tt> (optional)
:**<tt>true</tt>: the record is also returned
:**'''<tt>false</tt>''': the record is not returned (default)}}

;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <record>
        <field1>...</field1>
        <field2>...</field2>
        ...
        ...
    </record>
</platform>
</syntaxhighlight>
:'''Notes:'''
:{{:Common:record fields}}

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <id>...</id>     <!-- record ID -->  
</platform>
</syntaxhighlight>

==== Create record with specific ID ====
You can define your own record ID while creating a record through REST. If the record ID you provide already exists, then the record creation fails. If you do not provide the record ID, then the system will automatically generate the record ID. 
;Method:POST
;URI:<tt>https://<domain>/networking/rest/record/{objectName}</tt>
;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
   <record>
      <field1>…</field1>
      <field2>…</field2>…
      <PLATFORM.PARAMS.RECORD.RECORD_ID_IN_PARAMS>{recordId}</PLATFORM.PARAMS.RECORD.RECORD_ID_IN_PARAMS>
   </record>
</platform>
</syntaxhighlight>

===Update a Record===
Updates a record in an [[Object]].

;Method:PUT

;URI:<tt>{{platformURL}}/rest/record/{objectName}/{recordId}?{query_parameters}</tt>

{{Query Parameters|
:* <tt>retrieveRecord</tt> (optional)
:**<tt>true</tt>: the record is also returned
:**'''<tt>false</tt>''': the record is not returned (default)}}

;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <record>
        <field1>...</field1>
        <field2>...</field2>
        ...
        ...
    </record>
</platform>
</syntaxhighlight>

:'''Notes:'''
:{{:Common:record fields}}

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

If the <tt><nowiki>?retrieveRecord=true</nowiki></tt> query is included:
:*If <tt><nowiki>?retrieveRecord=true</nowiki></tt>, the record is also returned
:*If <tt><nowiki>?retrieveRecord=false</nowiki></tt> or is not present, the record is not returned
=== Update a record using filter ===
You can update a record using filter criteria.
;URI:<tt>{{platformURL}}/networking/rest/record/{objectName}?filter=someField equals 'test'</tt>
;Method:PUT
;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
<record>
  <field1>…</field1>
  <field2>…</field2>…
</record>
</platform>
</syntaxhighlight>
'''Notes:'''
:1. For more examples on filtering criteria to filter records, see [[REST API:Filter Expressions in REST APIs]] and the [[REST API]] Examples.
:2. In case the filter criteria (filter=someField equals '123') matches multiple records, '''only the first record gets updated''' based on '''sortOrder''' and '''sortBy''' parameters.
::Example: filter=someField equals ‘test’&sortBy=<columnName>&sortOrder=<asc/desc>
::By default '''sortOrder''' is '''‘desc’''' & '''sortBy'''(Column to be sorted) is '''‘date_modified’'''.

===Delete a Record===
Deletes a record in an [[Object]]

;Method:DELETE
;URI:<tt>{{platformURL}}/rest/record/{objectName}/{recordId}{query_parameters}</tt>

{{Query Parameters|
:* <tt>recordFormAttachmentId</tt> (Attachment ID)
:* <tt>isRecordFormImageField</tt> 
:**<tt>true</tt>: if it is an image field
:**'''<tt>false</tt>: if it is not an image field 
:* <tt>recordFormAttachmentColumnName</tt> (Attachment field name) }}

;Request:
No request body accompanies the resource. 

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

==Multipart Operations for Raw Data==
To include binary data in an XML stream, it is encoded and included in a ''multipart'' REST request (a request that contains a normal XML segment and an additional segment for each request field that holds raw data).

===Add a Multipart Record===
Adds a record to an [[Object]] when one or more fields contain raw data.

;Method:POST

;URI:<tt>{{platformURL}}/rest/record/{objectName}?{query_parameters}</tt>

{{Query Parameters|
:* <tt>isBase64Encoded</tt> (optional)
::*  <tt>true</tt>: File content is encoded binary data For example, an image.
::*  '''<tt>false</tt>''': File content is not encoded. For example, a text file. (default)
:* <tt>retrieveRecord</tt> (optional)
::*  <tt>true</tt>: the record is also returned
::*  '''<tt>false</tt>''': the record is not returned (default)}}

;Request:
:<syntaxhighlight lang="xml" enclose="div">
Content-Type: multipart/form-data; boundary=.............................103832778631715

--.............................103832778631715
Content-Disposition: form-data; name="__xml_data__"
content-type: application/xml

    <platform>
        <record>
            <field1>...</field1>
            <field2>...</field2>
            <image_field>image1.jpg</image_field>
             ...
        </record>
    </platform>
.............................103832778631715
Content-Disposition: form-data; name="image_field"; filename="image1.jpg"
content-type: application/octet-stream

{encoded contents of file}
.............................103832778631715--
</syntaxhighlight>

:The Content-type of the request is set to <tt>multipart/form-data</tt> with an appropriate boundary. 

:The first part contains the xml record post request and has a Content-type <tt>application/xml</tt> or <tt>application/json</tt>. The name of the part is either <tt>__xml_data__</tt> or <tt>__json_data__</tt>.

:The <tt><image_field></tt> field contains the file name: <tt>image1.jpg</tt>. 

:The next part of the request is the actual file. The Content-type is <tt>application/octet-stream</tt>. Note that the 'name' attribute in the content disposition points to the image field tag in the xml of the first part (ie. 'image_field'). This links the file part to the respective field in the xml. The 'filename' attribute of the content disposition is the file name of the file being uploaded to that field (i.e. <tt>image1.jpg</tt>).

:Multiple files can be attached to their respective fields in that manner.

;Response:
:<syntaxhighlight lang="xml" enclose="div">
 <platform>
     <message>
         <code>0</code>
         <description>Success</description>
     </message>
 </platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

;Sample Client:Here is a sample client that uploads an image to an image field.

:<syntaxhighlight lang="java" enclose="div">
import java.io.File;

import javax.ws.rs.core.MediaType;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.URI;
import org.apache.commons.httpclient.methods.PutMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.StringPart;

public class MultipartRecord
{
    public static void main(String[] args)
    {
        try
        {
            File f = new File("c:\\csvs\\image1.jpg");
            
            HttpClient client = new HttpClient();

            //Add a record to a custom object called "HOMEPAGE"
            PostMethod postMethod = new 
                PostMethod("https://{{domain}}/networking/rest/record/HOMEPAGE/");
            
            //Set the session for this request.
            postMethod.setRequestHeader("Cookie", "JSESSIONID=A741270662A86F796DA16646F0708C43");

            //The first attribute of the FilePart constructor refers to the image field name 
            //ie.image_field
            FilePart filePart = new FilePart("image_field", f);
            
            //Set the content type of the filePart
            filePart.setContentType(MediaType.APPLICATION_OCTET_STREAM);

            //Create the xml part of the request
            // __xml_data__ is required for the name attribute 
            // If the content type is json, use __json_data__
            StringPart sp = new StringPart("__xml_data__",
              "<platform><record><field1>Some text field</field1>"
            + "<image_field>image1.jpg</image_field></record></platform>");
            
            //Set the Content-type of the xml part
            sp.setContentType(MediaType.APPLICATION_XML);
            
            final Part[] parts = { sp, filePart };

            postMethod.setRequestEntity(new MultipartRequestEntity(parts, postMethod.getParams()));

            int executeMethod = client.executeMethod(postMethod);
        }
        catch(Exception e)
        {
            System.out.println("Exception");
        }
    }
}
</syntaxhighlight>

===Update a Multipart Record===
Updates a record in an [[Object]] when one or more fields contain raw data.

{{Note|Normal update rules are observed. For example, if an image field is specified, and the existing record field already contains an image, then the old image is deleted and the new one is uploaded in it's place.}}

;Method:PUT

;URI:<tt>{{platformURL}}/rest/record/{objectName}/{recordId}?{query_parameters}</tt>

{{Query Parameters|
:* <tt>isBase64Encoded</tt> (optional)
::*  <tt>true</tt>: File content is encoded binary data For example, an image.
::*  '''<tt>false</tt>''': File content is not encoded. For example, a text file. (default)
:* <tt>retrieveRecord</tt> (optional)
::*  <tt>true</tt>: the record is also returned
::*  '''<tt>false</tt>''': the record is not returned (default)}}

;Request:
:The format of the request is identical to that shown in [[#Add a Multipart Record|Add a Multipart Record]].

;Response:
:<syntaxhighlight lang="xml" enclose="div">
      <platform>
          <message>
              <code>0</code>
              <description>Success</description>
          </message>
      </platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

;Sample Client:Here is a sample client that updates an image in an image field.
:<syntaxhighlight lang="java" enclose="div">
import java.io.File;

import javax.ws.rs.core.MediaType;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.URI;
import org.apache.commons.httpclient.methods.PutMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.StringPart;


public class MultipartRecord
{
    public static void main(String[] args)
    {
        try
        {
            File f = new File("c:\\csvs\\image1.jpg");
            
            HttpClient client = new HttpClient();

            //Update a record in a custom object called "HOMEPAGE"
            PutMethod PutMethod = 
               new PutMethod("https://{{domain}}/networking/rest/record/HOMEPAGE/{recordId}");
            
            //Set the session for this request.
            PutMethod.setRequestHeader("Cookie", "JSESSIONID=A741270662A86F796DA16646F0708C43");

            //The first attribute of the FilePart constructor refers to 
            //the image field name ie.image_field
            FilePart filePart = new FilePart("image_field", f);
            
            //Set the content type of the filePart
            filePart.setContentType(MediaType.APPLICATION_OCTET_STREAM);

            //Create the xml part of the request
            // __xml_data__ is required for the name attribute 
            // If the content type is json, use __json_data__
            StringPart sp = new StringPart("__xml_data__",
                "<platform><record><field1>Some text field</field1>"
              + "<image_field>image1.jpg</image_field></record></platform>");
            
            //Set the Content-type of the xml part
            sp.setContentType(MediaType.APPLICATION_XML);
            
            final Part[] parts = { sp, filePart };

            PutMethod.setRequestEntity(new MultipartRequestEntity(parts, PutMethod.getParams()));

            int executeMethod = client.executeMethod(PutMethod);
        }
        catch(Exception e)
        {
            System.out.println("Exception");
        }
    }
}
</syntaxhighlight>
<noinclude>

[[Category:REST API|record Resource]]
</noinclude>