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

Associating Books to REST API Resources


You can use the REST API to associate an existing book to existing supported REST API resources. You can see which books are supported by looking at the REST Integration Tags page in the Oracle CRM On Demand user interface. For more information about REST API Integration Tags, see Customizing REST API Integration Tags.

When you add a book child resource to an Oracle CRM On Demand resource, you must specify the BookExternalSystemId field value in the REST API request.

The following details are for a POST request to associate an existing CriticalAccounts book to an Account resource on the Oracle CRM On Demand Server:

  • URL: https://<host>/OnDemand/user/Rest/latest/Accounts/1QA2-238N93/child/AccountBooks
  • HTTP Method: POST
  • Content-Type: application/vnd.oracle.adf.resource+json
  • Request body:

{
   " AccountBooks":[
   {
     "BookExternalSystemId":"CriticalAccounts"
   }
  ]
}

The following are the details for the response to a successful request and the links to the associated book:

  • HTTP Code: 201
  • Content-Type: application/vnd.oracle.adf.resource+json
  • Response body:

{
   "AccountBooks":[
    {
      "BookExternalSystemId":"CriticalAccounts",
        "links":{
          "self":{
             "rel":"self",
             "href":"/OnDemand/user/Rest/028/Accounts/1QA2-238N93/child/AccountBooks/1QA2-2458T5"},
          "canonical":{
            "rel":"canonical",
             "href":"/OnDemand/user/Rest/028/Accounts/1QA2-238N93/child/AccountBooks/1QA2-2458T5"},
          "parent":{
             "rel":"parent",
             "href":"/OnDemand/user/Rest/028/Accounts/1QA2-238N93"
          }
       }
    }
  ]
}

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