Difference between revisions of "REST API:index Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
===Permissions=== | ===Permissions=== | ||
{{permissions| | {{permissions|Use Development Features|use this resource.}} | ||
===Get a List of Object Indexes=== | ===Get a List of Object Indexes=== | ||
| Line 162: | Line 162: | ||
|- | |- | ||
| colspan="6" bgcolor=" | | colspan="6" bgcolor="lightblue" style="height:7px" | <!-- SPACER ROW --> | ||
|- | |- | ||
Latest revision as of 00:38, 8 June 2012
Manage index metadata for an Object using the REST API.
- Learn more: REST API Conventions and Considerations.
Permissions
Users that have the Use Development Features permission can use this resource.
Get a List of Object Indexes
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/index/{objectName}
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<name>AuthorIndex</name>
<uniqueIndex>false</uniqueIndex>
<useInImportForMerge>false</useInImportForMerge>
<indexFields>author_name</indexFields>
</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://{yourDomain}/networking/rest/index/{objectName}/{indexName}
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<id>a5baa89caa064ed995c6c14f402db379</id>
<objectName>Books</objectName>
<name>AuthorIndex</name>
<uniqueIndex>false</uniqueIndex>
<useInImportForMerge>false</useInImportForMerge>
<indexFields>author_name</indexFields>
<date_created>2012-02-09T08:00:00.000Z</date_created>
<date_modified>2012-02-13T08:00:00.000Z</date_modified>
<modified_id
type="USER" uri="..."
displayValue="...">...userId...</modified_id>
</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://{yourDomain}/networking/rest/index/{objectName}
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<name>IBSN_Index</name>
<uniqueIndex>false</uniqueIndex>
<useInImportForMerge>false</useInImportForMerge>
<indexFields>ibsn_number</indexFields>
</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://{yourDomain}/networking/rest/index/{objectName}/{indexName}
- Request
- (Only one field can be updated.)
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<index>
<useInImportForMerge>true</useInImportForMerge>
</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://{yourDomain}/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 Index ID Record Id objectName String Read Only Object name name String Add Only 
Index name indexFields String Add Only Fields that make up the index Comma-separated list of field names uniqueIndex Boolean Add Only If true, index keys must be unique true or false (default) useInImportForMerge Boolean If true, index is used during an import merge true or false (default) 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
Error Codes
Platform Code with Http Status Description -7000 BAD_REQUEST (400) Invalid index name
Learn more:
- See the REST API:Error Codes for common Http error codes
- See the javadoc constants for a complete list of PlatformException error-code constants.