REST API:recordLocator Resource

Manage Record Locators 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/{recordId}

Response

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

<platform>

   <recordLocator>
       <field>data</field>
        ...
   </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/{recordId}

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