Retrieving Metadata for a Specific Oracle CRM On Demand Resource

The following details are for a request to retrieve metadata information for an accounts resource. This example uses the fields URL parameter to retrieve attribute values for the resource and shows metadata for only two of the many fields for account:

  • URL: https://<host>/OnDemand/user/Rest/latest/Accounts/describe?fields=attributes&offset=0&limit=1

  • HTTP Method: GET

  • Content-Type: None

  • Request body: None

For more information about describe attributes, see Describe Field Attributes.

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": {
        "Accounts": {
            "title": "Account",
            "titlePlural": "Accounts",
            "CustomObjectTagName": "Accounts",
                "attributes": [
                {
                   "name": "FuriganaName", // default tag name
                   "type": "string", // field type
                   "updatable": true, // readonly = false
                   "mandatory": false, // required = true
                   "queryable": true, // searchable
                   "title": "Furigana Name", // display name
                   "maxLength": 100,
                   "markfortranslation": false,
                   "copyenabled": true,
                   "optimized": false,
                   "postdefault": false,
                   "casesensitivity": false,
                   "htmlfieldtag": "Furigana Name",
                   "customwsintegrationtag": "FuriganaName"
                },
                {
                   "name": "PrimaryGroup",
                   "type": "string",
                   "updatable": false,
                   "mandatory": false,
                   "queryable": true,
                   "title": "Primary Group",
                   "maxLength": 50,
                   "markfortranslation": false,
                   "copyenabled": false,
                   "optimized": false,
                   "postdefault": false,
                   "casesensitivity": false,
                   "htmlfieldtag": "Owner Group Name",
                   "customwsintegrationtag": "PrimaryGroup"
                }
           ]
        }
     },
     "_contextInfo": {
         "limit": 1,
         "offset": 0,
         "lastpage": false
   }
}