Difference between revisions of "REST API:index Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 39: | Line 39: | ||
;Method:GET | ;Method:GET | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/index/{ | ;URI:<tt><nowiki>https://{domain}/networking/rest/index/{objectName}/{indexName}</nowiki></tt> | ||
;Response: | ;Response: | ||
| Line 71: | Line 63: | ||
;Method:POST | ;Method:POST | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/index</nowiki></tt> | ;URI:<tt><nowiki>https://{domain}/networking/rest/index/{objectName}</nowiki></tt> | ||
;Request: | ;Request: | ||
| Line 99: | Line 91: | ||
;Method:PUT | ;Method:PUT | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/index/{ | ;URI:<tt><nowiki>https://{domain}/networking/rest/index/{objectName}/{indexName}</nowiki></tt> | ||
;Request: | ;Request: | ||
| Line 127: | Line 119: | ||
;Method:DELETE | ;Method:DELETE | ||
;URI:<tt><nowiki>https://{domain}/networking/rest/index/{ | ;URI:<tt><nowiki>https://{domain}/networking/rest/index/{objectName}/{indexName}</nowiki></tt> | ||
;Response: | ;Response: | ||
Revision as of 20:42, 15 February 2012
Manage index metadata for an Object using the REST API.
- Learn more: REST API Conventions and Considerations.
Permissions
Users that have the Manage Develop Features permission can use this resource.
Get a List of Object Indexes
- Method
- GET
- URI
- https://{domain}/networking/rest/index/{objectName}
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<id>...</id>
<field>data</field>
...
</index>
<index>
...
</index>
...
<message>
0
<description>Success</description>
</message>
<recordCount>N</recordCount>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Get an Object Index
- Method
- GET
- URI
- https://{domain}/networking/rest/index/{objectName}/{indexName}
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<id>...</id>
<field>data</field>
...
</index>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Add an Index to an Object
- Method
- POST
- URI
- https://{domain}/networking/rest/index/{objectName}
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<field>data</field>
...
</index>
</platform> </syntaxhighlight>
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<message>
0
<description>Success</description>
<id>...</id>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Update an Object Index
- Method
- PUT
- URI
- https://{domain}/networking/rest/index/{objectName}/{indexName}
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<id>{recordId}</id>
...
</index>
</platform> </syntaxhighlight>
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Delete an Object Index
- Method
- DELETE
- URI
- https://{domain}/networking/rest/index/{objectName}/{indexName}
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Fields
- Note: Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".
Name Type Attribute Required on Add Description Additional Information id String Read Only Record Id name String 
description String ... ... ... ... ... ... tag String Read Only description AddlInfo tag String description AddlInfo tag String description AddlInfo tag String Writable on Add only description AddlInfo ... ... ... ... ... ... ... ... ... ... ... ... date_modified Date Read Only UTC Format date_created Date Read Only UTC Format created_id Lookup Read Only User ID modified_id Lookup Read Only User ID