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 URL Format


The supported Oracle CRM On Demand resources are accessed by using a URL. The Oracle CRM On Demand REST API uses the following URL formats for top-level and child resources:

The top-level format is as follows:

OnDemand/user/Rest/latest/<objects>

The child format is as follows:

OnDemand/user/Rest/latest/<ParentObject>/<ParentRowId>/child/<childobjects>

An example top-level resource structure is as follows:

OnDemand/user/Rest/latest/Accounts

An example child resource structure is as follows:

OnDemand/user/Rest/latest/Accounts/1QA2-21SEF/child/AccountAddresses

where:

  • OnDemand indicates the name of the integration product, Oracle CRM On Demand.
  • user is always user and cannot be modified.
  • Rest is the endpoint for the REST API URL.
  • latest indicates the version number for Oracle CRM On Demand.
  • <objects> indicates the name of the Oracle CRM On Demand REST API resource. For more information about supported Oracle CRM On Demand resources, see Oracle CRM On Demand REST API Supported Resources.
  • <ParentObject> indicates the name of the Oracle CRM On Demand REST API parent resource.
  • <ParentRowID> indicates the row ID for the parent resource.
  • child indicates that a child resource is referenced.
  • <childobjects> indicates the name of the Oracle CRM On Demand REST API child resource. For more information about the supported Oracle CRM On Demand child resources, see Oracle CRM On Demand REST API Supported Resources.
Oracle CRM On Demand REST API Developer's Guide, Release 32 Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.