Difference between revisions of "REST API:recordLocator Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 1: | Line 1: | ||
Manage [[Record Locators]] to specify fields that are used for [[Record]] lookups, searches, and indexing, via the [[REST API]]. | 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]]. | ||
===Access Permissions=== | ===Access Permissions=== | ||
| Line 8: | Line 8: | ||
;Method:GET | ;Method:GET | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{ | ;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{objectId}</nowiki></tt> | ||
;Response: | ;Response: | ||
Here's a sample response from the Order object, where: | |||
:* <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>order_number</lookupColumns> | |||
<keyColumns>related_to_Customer</keyColumns> | |||
<searchColumns>related_to_Customer</searchColumns> | |||
<searchColumns>order_number</searchColumns> | |||
</recordLocator> | </recordLocator> | ||
| Line 30: | Line 37: | ||
;Method:PUT | ;Method:PUT | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{ | ;URI:<tt><nowiki>https://{domain}/networking/rest/recordLocator/{objectId}</nowiki></tt> | ||
;Request: | ;Request: | ||
Revision as of 18:25, 9 September 2011
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.
Access Permissions
- Develop Tools permission must be enabled for the tenant.
Users that have the Customize Objects permission can use the recordLocator Resource in the REST API
Read a recordLocator Record
- Method
- GET
- URI
- https://{domain}/networking/rest/recordLocator/{objectId}
- Response
Here's a sample response from the Order object, where:
- lookupColumns - Record fields the user sees in a grid user when doing a lookup or search.
- keyColumns - 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.)
- searchColumns - The columns used for searching, internally. (The search is applied to the contenation of those columns.)
- <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://{domain}/networking/rest/recordLocator/{objectId}
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<recordLocator>
...
</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 Required During Add Description Additional Information 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