Retrieving Metadata for an Oracle CRM On Demand Child Resource

The following details are for a request to retrieve metadata information about an Account Notes child resource:

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

  • HTTP Method: GET

  • Content-Type: None

  • Request body: None

The following are the details for the response to a successful request:

  • HTTP Code: 200

  • Content-Type: application/vnd.oracle.adf.resource+json

  • Response body:

{"Resources":{"AccountNotes":
   {"title":"Account Note",
   "titlePlural":"Account Notes",
   "CustomObjectTagName":"AccountNotes",
   "attributes":[
     {
      "name":"AccountId",
      "type":"string",
      "updatable":true,
      "mandatory":true,
      "queryable":true,
      "title":"MyAccount Id",
      "maxLength":15,
      "markfortranslation":false,
      "copyenabled":false,
      "optimized":false,
      "postdefault":false,
      "casesensitivity":false,
      "htmlfieldtag":"Account Id",
      "wscustomintegrationtag":"AccountId"},
     {
      "name":"Description",
      "type":"string",
      "updatable":true,
      "mandatory":false,
      "queryable":true,
      "title":"Note",
      "maxLength":16350,
      "markfortranslation":false,
      "copyenabled":true,
      "optimized":false,
      "postdefault":false,
      "casesensitivity":false,
      "htmlfieldtag":"Note",
      "wscustomintegrationtag":"Description"},
     {
      "name":"ExternalSystemId",
      "type":"string",
      "updatable":true,
      "mandatory":false,
      "queryable":true,
      "title":"ExternalUniqueID",
      "maxLength":30,
      "markfortranslation":false,
      "copyenabled":true,
      "optimized":false,
      "postdefault":false,
      "casesensitivity":false,
      "htmlfieldtag":"External System Id",
      "wscustomintegrationtag":"ExternalSystemId"},
     {
      "name":"Id",
      "type":"string",
      "updatable":false,
      "mandatory":true,
      "queryable":true,
      "title":"RowId",
      "maxLength":15,
      "markfortranslation":false,
      "copyenabled":false,
      "optimized":false,
      "postdefault":false,
      "casesensitivity":false,
      "htmlfieldtag":"Id",
      "wscustomintegrationtag":"Id"},
     {
      "name":"Subject",
      "type":"string",
      "updatable":true,
      "mandatory":true,
      "queryable":true,
      "title":"Subject",
      "maxLength":150,
      "markfortranslation":false,
      "copyenabled":true,
      "optimized":false,
      "postdefault":false,
      "casesensitivity":false,
      "htmlfieldtag":"Note Type",
      "wscustomintegrationtag":"Subject"}],
      "item":
        {
        "links":{
           "self":{
              "rel":"self",
              "href":"/OnDemand/user/Rest/latest/Accounts/1QA2-22789P/child/AccountNotes/{id}"},
            "canonical":{
               "rel":"canonical",
               "href":"/OnDemand/user/Rest/latest/Accounts/1QA2-22789P/child/AccountNotes/{id}"}},
        "actions":[{
             "name":"get",
             "method":"GET",
             "responseType":["application/vnd.oracle.adf.resource+json"]},
            {
               "name":"update",
               "method":"PATCH",
               "responseType":["application/vnd.oracle.adf.resource+json"],
               "requestType":["application/vnd.oracle.adf.resource+json"]},
           {
              "name":"delete",
              "method":"DELETE"}]
        },
      "links":{
          "describe":{
             "rel":"describe",
             "href":"/OnDemand/user/Rest/latest/Accounts/1QA2-22789P/child/AccountNotes/describe"},
            "canonicalDescribe":{
              "rel":"canonicalDescribe",
              "href":"/OnDemand/user/Rest/latest/Accounts/1QA2-22789P/child/AccountNotes/describe"}
      }
    }
  },
  "_contextInfo":
  {
   "limit":1,
   "offset":0,
   "lastpage":true}
}