Oracle CRM On Demand Documentation Library: Describe Fields Parameters

By default, the describe request returns all field values in the REST API response. You can use the fields URL parameter to limit your response output. You can use more than one fields URL parameter as long as values are separated with commas.

You can also use paging parameters with fields URL parameters to manage REST API response output. For more information about paging parameters, see Paging Collection Resources.

Table 16 contains the fields URL parameter values that you can use with describe requests.

Table 16. Fields URL Parameter Values for Describe Requests
Fields URL Parameter Values	Description	URL Example
attributes	Returns additional information about field attributes, for example, whether the field is read-only or required or if the field has a custom integration tag.	OnDemand/user/Rest/latest/describe?fields=attributes
collection.finders	Returns all the finders. Finders refers to managed lists or predefined queries.	OnDemand/user/Rest/latest/describe?fields=collection.finders
collection.links	Returns the collection links.	OnDemand/user/Rest/latest/describe?fields=collection.links
collection.actions	Returns available actions, such as, GET, POST, PUT, and DELETE.	OnDemand/user/Rest/latest/describe?fields=collection.actions
item.links	Returns item links.	OnDemand/user/Rest/latest/describe?fields=item.links
item.actions	Returns the item actions.	OnDemand/user/Rest/latest/describe?fields=item.actions
children.attributes	Returns the children attributes.	OnDemand/user/Rest/latest/describe?fields=children.attributes
children.collection	Returns the children collections.	OnDemand/user/Rest/latest/describe?fields=children.collection
children.item	Returns the children items.	OnDemand/user/Rest/latest/describe?fields=children.item
children.links	Returns the children links.	OnDemand/user/Rest/latest/describe?fields=childrenlinks
links	Returns all the links.	OnDemand/user/Rest/latest/describe?fields=links

Oracle CRM On Demand REST API Developer's Guide, Release 33		Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.