Oracle CRM On Demand REST API Developer's Guide > Using the Oracle CRM On Demand REST API >

Retrieving Metadata about Oracle CRM On Demand Resources

You can use the describe request to return metadata information about Oracle CRM On Demand resources. The metadata information includes additional information about fields, for example, which fields are read-only and which fields are required.

The describe request can be used to show metadata information about:

• All resources. You can use the describe request to show more information about all supported Oracle CRM On Demand resources, including the actions (create, retrieve, update, and delete) supported for the resource, and links to retrieve the parent and child resources.

  An example URL to show all resources:

  https://<host>/OnDemand/user/Rest/latest/describe

  For more information and a code sample using the describe request to show all resources, see Retrieving Metadata for All Oracle CRM On Demand Resources.

• A resource. You can use the describe request to show more information about a particular resource, such as Accounts, including information about attachments and custom content.

  An example URL to show an Accounts resource:

  https://<host>/OnDemand/user/Rest/latest/Accounts/1QA2-22789P/describe

  For more information and a code sample using the describe request to show a specific resource, see Retrieving Metadata for a Specific Oracle CRM On Demand Resource.

• A collection. You can use the describe request to show more information about a collection, such as an accounts collection, including the actions (create, retrieve, update, and delete) supported for the resource, and links to retrieve the parent and child resources. The describe request does not return information about attachments or custom content.

  An example URL to show an Accounts collection:

  https://<host>/OnDemand/user/Rest/latest/Accounts/describe

  For more information and a code sample using the describe request to show a collection, see Retrieving Metadata for an Oracle CRM On Demand Collection.

• A child resource: You can use the describe request to show more information about a child resource.

  An example URL to show an Account Notes child resource:

  https://<host>/OnDemand/user/Rest/latest/Accounts/1QA2-213442/AccountNotes/describe

  For more information and a code sample using the describe request to show a child resource, see Retrieving Metadata for an Oracle CRM On Demand Child Resource.