AgileApps Support Wiki Pre Release

REST API:recordLocator Resource

From AgileApps Support Wiki

Manage the object's Record Locator, to read and to specify fields that are used for Record lookups, searches, and indexing, via the REST API.

Access Permissions

Lock-tiny.gif

Users that have the Customize Objects permission can use the recordLocator Resource in the REST API

Read a recordLocator Record

Method
GET
URI
https://{yourDomain}/networking/rest/recordLocator/{objectId}
Response

Here's a sample response from the Order object:

<platform>
    <recordLocator>
        <lookupColumns>related_to_Customer</lookupColumns>
        <lookupColumns>order_number</lookupColumns>
        <keyColumns>related_to_Customer</keyColumns>
        <searchColumns>related_to_Customer</searchColumns>
        <searchColumns>order_number</searchColumns>
    </recordLocator>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Update a recordLocator Record

Method
PUT
URI
https://{yourDomain}/networking/rest/recordLocator/{objectId}
Request

Add another column to the search fields:

<platform>
    <recordLocator>
        <lookupColumns>related_to_Customer</lookupColumns>
        <lookupColumns>order_number</lookupColumns>
        <keyColumns>related_to_Customer</keyColumns>
        <searchColumns>related_to_Customer</searchColumns>
        <searchColumns>order_number</searchColumns>
        <searchColumns>date_created</searchColumns>
    </recordLocator>
</platform>
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Fields

Name Type Attribute Description Additional Information
lookupColumns String Fields the user sees in a grid user when doing a lookup or search.
  • Each field is specified in its own element tag.
keyColumns String Field(s) displayed as the value of a Lookup field, to identify the record the lookup field points to. When multiple fields are specified, their values are separated by hyphens.)
  • Each field is specified in its own element tag.
  • One Lookup field can be specified.
  • File, Image, Custom Control, Url, Text Area, and Rich Text Area fields are not supported
searchColumns String Fields used for searching, internally. (The search is applied to the contenation of those fields.)
  • Each field is specified in its own element tag.
  • One Lookup field can be specified.
  • File, Image, Custom Control, Check box, and Roll up Summary fields are not supported.
 
objectId String Read Only
date_created Date Read Only UTC Format
created_id Lookup Read Only
date_modified Date Read Only UTC Format
modified_id Lookup Read Only