Services module: What is 'Index' operation?

Question

D7 / Services 3.2

retrieve / create / update / delete are very straightforward, make senses to me that matching 'CRUD', I don't understand what 'index' here does?

Thanks.

Answer 1

'Index' in services module will list out an entity(node, users, taxonomy..) in descending Order of its created time, vid, name etc based on the arguments that are passed. The common arguments for the Index are

1. Page - Page number of results to return (in pages of 20).
2. Fields - The fields you want returned.
3. Parameters - An array containing fields and values used to build a sql WHERE clause indicating items to retrieve. (array)

4. Page size - number of items to be returned. (Integer)

   In case of retrieve, it returns the complete entity object of the passed 'entity_id'

UPDATED:

Sample URLS for Index is

• http://domain/endpoint/node?fields=nid,vid&parameters[nid]=7&parameters[uid]=1&page=2
• http://domain/endpoint/taxonomy_term?fields=tid,name&parameters[tid]=7&parameters[vid]=1
• http://domain/endpoint/user?fields=uid,name,mail&parameters[uid]=1

For documentation you can see the link http://drupal.org/node/109782