AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:recordLocator Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Manage [[Record Locators]] for an object, to read and to specify fields that are used for [[Record]] lookups, searches, and indexing, via the [[REST API]].
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===
===Access Permissions===
:* [[Develop Tools]] permission must be enabled for the tenant.
{{permissionRef|Customize Objects|use the <tt>recordLocator</tt> Resource in the [[REST API]]}}
{{permissions|Customize Objects|use the <tt>recordLocator</tt> Resource in the [[REST API]]}}


===Read a recordLocator Record===
===Read a recordLocator Record===
;Method:GET
;Method:GET
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{objectId}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/recordLocator/{objectId}</tt>


;Response:
;Response:
Here's a sample response from the Order object, where:
Here's a sample response from the Order object:
:* <tt>lookupColumns</tt> - Record fields the user sees in a grid user when doing a lookup or search.
:* <tt>keyColumns</tt> - 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.)
:* <tt>searchColumns</tt> - The columns used for searching, internally. (The search is applied to the contenation of those columns.)
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
<platform>
<platform>
     <recordLocator>
     <recordLocator>
<lookupColumns>related_to_Customer</lookupColumns>
        <lookupColumns>related_to_Customer</lookupColumns>
<lookupColumns>order_number</lookupColumns>
        <lookupColumns>order_number</lookupColumns>
<keyColumns>related_to_Customer</keyColumns>
        <keyColumns>related_to_Customer</keyColumns>
<searchColumns>related_to_Customer</searchColumns>
        <searchColumns>related_to_Customer</searchColumns>
<searchColumns>order_number</searchColumns>
        <searchColumns>order_number</searchColumns>
     </recordLocator>
     </recordLocator>


Line 37: Line 33:
;Method:PUT
;Method:PUT
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{objectId}</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/recordLocator/{objectId}</tt>  


;Request:
;Request:
Add another column to the search fields:
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
<platform>
<platform>
     <recordLocator>
     <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>
     </recordLocator>
</platform>
</platform>
Line 62: Line 64:
===Fields===
===Fields===
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
! Name!!Type!!Attribute!!Required During Add!!Description!!Additional Information
! Name!!Type!!Attribute!!Description!!Additional Information
|-
|-
| objectId || String || align="center"|Read Only || || ||  
| 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.
|-
|-
|date_created||Date|| align="center"|Read Only || || || [[UTC Format]]
| 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
|-
|-
|created_id||Lookup|| align="center"|Read Only || || ||
| 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.
|-
|-
|date_modified||Date|| align="center"|Read Only || || || [[UTC Format]]
| colspan="6"|&nbsp;
|-
|-
|modified_id||Lookup || align="center"|Read Only || || ||
| objectId || String || align="center"|Read Only || ||
|-
|date_created||Date|| align="center"|Read Only ||  || [[UTC Format]]
|-
|created_id||Lookup|| align="center"|Read Only || ||
|-
|date_modified||Date|| align="center"|Read Only || || [[UTC Format]]
|-
|modified_id||Lookup || align="center"|Read Only || ||
|}
|}
<noinclude>
<noinclude>

Latest revision as of 20:02, 26 August 2013

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:

<syntaxhighlight lang="xml" enclose="div">

<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>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

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:

<syntaxhighlight lang="xml" enclose="div">

<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> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

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
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=REST_API:recordLocator_Resource&oldid=12368"