Difference between revisions of "REST API:index Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 6: | Line 6: | ||
{{permissions|Manage Develop Features|use this resource.}} | {{permissions|Manage Develop Features|use this resource.}} | ||
===Get a List of Indexes=== | ===Get a List of Object Indexes=== | ||
("Get" if complete records are returned. "List" if partial data is returned, requiring a second read to get a complete set of data. This comes before the GET, because typically it's called first to get the ID used in a specific-record GET.) | ("Get" if complete records are returned. "List" if partial data is returned, requiring a second read to get a complete set of data. This comes before the GET, because typically it's called first to get the ID used in a specific-record GET.) | ||
| Line 47: | Line 47: | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
===Get | ===Get an Object Index === | ||
;Method:GET | ;Method:GET | ||
| Line 78: | Line 78: | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
===Add | ===Add an Index to an Object=== | ||
;Method:POST | ;Method:POST | ||
| Line 107: | Line 107: | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
===Update | ===Update an Object Index === | ||
;Method:PUT | ;Method:PUT | ||
| Line 134: | Line 134: | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
===Delete | ===Delete an Object Index === | ||
;Method:DELETE | ;Method:DELETE | ||
Revision as of 20:40, 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
("Get" if complete records are returned. "List" if partial data is returned, requiring a second read to get a complete set of data. This comes before the GET, because typically it's called first to get the ID used in a specific-record GET.)
- Method
- GET
- URI
- https://{domain}/networking/rest/index
- Return all fields
- URI
- https://{domain}/networking/rest/index?{query_parameters}
- Query Parameters
- Introductory sentence, if any
- parameter1 - Description
- parameter2
- If TRUE, ...
- If FALSE, ...
- For more information, see: Specifying Query Parameters in REST APIs
- 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/{recordId}
- Return all fields
- URI
- https://{domain}/networking/rest/index/{recordId}?{query_parameters}
- Query Parameters
- Introductory sentence, if any
- parameter1 - Description
- parameter2
- If true, ...
- If false, ... (default)
- For more information, see: Specifying Query Parameters in REST APIs
- 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
- 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/{recordId}
- 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/{recordId}
- 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