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

Oracle CRM On Demand REST API Supported Resources

A REST API resource is a piece of information, such as a data record or a list of records. Each Oracle CRM On Demand REST API resource is identified by a named URL, and it is accessed using standard HTTP methods. For more information about URL format, see Oracle CRM On Demand REST API URL Format.

NOTE:  When you use the Oracle CRM On Demand REST API to call Oracle CRM On Demand resources, you must use the plural form. For example, use Accounts and not Account. If you customized the resource name, then use the custom resource name. For more information about customizing resource names, see Customizing REST API Integration Tags.

The REST API supports top-level and child resources. A supported top-level resource will also appear as a child of another supported object provided it is a one-to-many relationship. You can see which parent and child resources are supported by running describe requests. For more information about describe requests, see Retrieving Metadata about Oracle CRM On Demand Resources. In addition, see the describe request examples provided in Retrieving All Top-Level Resources and Retrieving All Child Resources.

The REST API supports the relationship between accounts, contacts, and their opportunities as a many-to-many parent-child relationship. For more information about associating accounts to contact resources, see Associating Accounts to Contacts Resources. For more information about associating contacts to accounts and opportunities, see Associating Contacts to Accounts and Opportunities Resources.

The REST API supports create, retrieve, update and delete actions on book and team child resources. Existing book and team resources can also be associated with other resources for which book relationships are supported. For information about associating books to REST API resources, see Associating Books to REST API Resources. For information about associating teams to REST API resources, see Associating Teams to REST API Resources.

The REST API supports not only core Oracle CRM On Demand top-level and child resources, but also industry-specific resources. Top-level and child resources and resources available with industry-specific editions of the application are covered in the following topics:

• Supported Core Oracle CRM On Demand Resources
• Supported Partner Relation Management Edition Resources
• Supported Life Sciences Edition Resources
• Supported Financial Services Edition Resources
• Supported Automotive Edition Resources

About Working with Oracle CRM On Demand Resources

You can use Oracle CRM On Demand REST API resources to interact with Oracle CRM On Demand. For example, you can:

• Use the Oracle CRM On Demand REST API versions request to return either a list of supported versions of Oracle CRM On Demand or get a description of a specific version of Oracle CRM On Demand. For more information about supported Oracle CRM On Demand REST API versions, see Getting a List of Available Oracle CRM On Demand Versions.
• Create top-level and child resources on the Oracle CRM On Demand Server. For more information about creating resources, see Creating Oracle CRM On Demand Resources.
• Retrieve top-level and child resources on the Oracle CRM On Demand Server. For more information about retrieving resources, see Retrieving Oracle CRM On Demand Resources.
• Update top-level and child resources on the Oracle CRM On Demand Server. For more information about updating resources, see Updating Oracle CRM On Demand Resources.
• Delete top-level and child resources on the Oracle CRM On Demand Server. For more information about deleting resources, see Deleting Oracle CRM On Demand Resources.
• Retrieve information about collection resource lists. For more information about retrieving collection resources, see Retrieving Oracle CRM On Demand REST API Collection Lists.
• Query a collection resource. For more information about querying a collection resource, see Querying a Collection Resource.
• Use the describe request to retrieve detailed metadata information about an Oracle CRM On Demand resource, such as an Account. For more information about retrieving metadata information about an Oracle CRM On Demand resource, see Retrieving Metadata about Oracle CRM On Demand Resources.
• Use the enclosure URL keyword to perform actions on attachments. For more information about working with attachments, see Working with Resource Attachments.
• Convert a lead to an opportunity and create new account and contact records for the lead on the Oracle CRM On Demand Server. For more information about converting leads, see Converting Oracle CRM On Demand Leads.
• Associate an existing book to REST API resources. For more information about associating books to REST API resources, see Associating Books to REST API Resources.
• Associate an existing team to REST API resources. For more information about associating teams to REST API resources, see Associating Teams to REST API Resources.
• Associate Accounts to Contacts resources. For more information associating accounts to contacts resources, see Associating Accounts to Contacts Resources.
• Associate Contacts to Accounts and Opportunities resources. For more information about associating contacts to accounts and opportunities resources, see Associating Contacts to Accounts and Opportunities Resources.
• Work with Account Contact Role resources. For more information about Account Contact Role resources, see Working with Account Contact Role Resources.