Retrieving Metadata for All Oracle CRM On Demand Resources
The following details are for a request to retrieve metadata information for all resources. The example shows accounts along with some of the child resources for accounts such as account addresses, account books, and vehicles. This example uses the fields URL parameter to retrieve links metadata:
URL: https://<host>/OnDemand/user/Rest/latest/describe?fields=collection.links,children.links,item.links,links&offset=0&limit=1
Note: The limit field specifies the maximum number of resource items that are returned. You can set the limit field to a maximum value of 100. The default value is 2.HTTP Method: GET
Content-Type: None
Request body: None
For more information about the fields URL parameter, see Describe Fields Parameters.
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",
"collection": {
"links": {
"self": {
"rel": "self",
"href": "/OnDemand/user/Rest/latest/Accounts/"
"kind": "collection"
},
"canonical": {
"rel": "canonical",
"href": "/OnDemand/user/Rest/latest/Accounts/"
"kind": "collection"
}
}
},
"item": {
"links": {
"self": {
"rel": "self",
"href": "/OnDemand/user/Rest/latest/Accounts/{id}"
"kind": "item"
},
"canonical": {
"rel": "canonical",
"href": "/OnDemand/user/Rest/latest/Accounts/{id}"
"kind": "item"
},
"AccountAddresses": {
"rel": "child",
"href": "/OnDemand/user/Rest/latest/Accounts/{id}/child/AccountAddresses",
"kind": "collection",
"cardinality": {
"value": "1 to *",
"sourceAttributes": "Id",
"destinationAttributes": "AccountId"
}
},
"AccountBooks": {
"rel": "child",
"href": "/OnDemand/user/Rest/latest/Accounts/{id}/child/AccountBooks",
"kind": "collection",
"cardinality": {
"value": "1 to *",
"sourceAttributes": "Id",
"destinationAttributes": "ObjectId"
}
}
.
.
.
"Vehicles": {
"rel": "child",
"href": "/OnDemand/user/Rest/latest/Accounts/{id}/child/Vehicles",
"kind": "collection",
"cardinality": {
"value": "1 to *",
"sourceAttributes": "Id",
"destinationAttributes": "AccountId"
}
}
}
},
"children": {
"AccountAddresses": {
"title": "Account Address",
"titlePlural": "Account Addresses",
"CustomObjectTagName": "AccountAddresses",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountAddresses/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountAddresses/describe",
"kind": "describe"
}
}
},
"AccountBooks": {
"title": "Account Book",
"titlePlural": "Account Books",
"CustomObjectTagName": "AccountBooks",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountBooks/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountBooks/describe",
"kind": "describe"
}
}
},
.
.
.
"Vehicles": {
"title": "Vehicle",
"titlePlural": "Vehicles",
"CustomObjectTagName": "Vehicles",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/Vehicles/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Vehicles/describe",
"kind": "describe"
}
}
}
},
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/describe"
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/describe"
"kind": "describe"
}
}
}
},
"_contextInfo": {
"limit": 1,
"offset": 0,
"lastpage": false
}
}
Retrieving All Top-Level Resources
The following details are for a request to retrieve metadata information for all top-level resources for your company. The example uses the fields URL parameter to retrieve links metadata:
URL: https://<host>/OnDemand/user/Rest/latest/describe?fields=links&offset=0&limit=100
Note: The limit field specifies the maximum number of resource items that are returned. You can set the limit field to a maximum value of 100. The default value is 2.HTTP Method: GET
Content-Type: None
Request body: None
For more information about the fields URL parameter, see Describe Fields Parameters.
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",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/describe",
"kind": "describe"
}
}
},
"AccreditationRequests": {
"title": "Accreditation Request",
"titlePlural": "Accreditation Requests",
"CustomObjectTagName": "AccreditationRequests",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/AccreditationRequests/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/AccreditationRequests/describe",
"kind": "describe"
}
}
},
.
.
.
"Vehicles": {
"title": "Vehicle",
"titlePlural": "Vehicles",
"CustomObjectTagName": "Vehicles",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Vehicles/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Vehicles/describe",
"kind": "describe"
}
}
}
},
"_contextInfo": {
"limit": 100,
"offset": 0,
"lastpage": true
}
}
Retrieving All Child Resources
The following details are for a request to retrieve metadata information all child resources for your company. The example shows some of the child resources for accounts such as account addresses, account books, and some of the child resources for vehicles, such as custom object 10, custom object 11, and vehicle books.The example uses the fields URL parameter to retrieve links metadata:
URL: https://<host>/OnDemand/user/Rest/latest/describe?fields=children.links&limit=100
Note: The limit field specifies the maximum number of resource items that are returned. You can set the limit field to a maximum value of 100. The default value is 2.HTTP Method: GET
Content-Type: None
Request body: None
For more information about the fields URL parameter, see Describe Fields Parameters.
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",
"children": {
"AccountAddresses": {
"title": "Account Address",
"titlePlural": "Account Addresses",
"CustomObjectTagName": "AccountAddresses",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountAddresses/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountAddresses/describe",
"kind": "describe"
}
}
},
"AccountBooks": {
"title": "Account Book",
"titlePlural": "Account Books",
"CustomObjectTagName": "AccountBooks",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountBooks/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Accounts/child/AccountBooks/describe",
"kind": "describe"
}
}
},
.
.
.
"Vehicles": {
"title": "Vehicle",
"titlePlural": "Vehicles",
"CustomObjectTagName": "Vehicles",
"children": {
"CustomObjects10": {
"title": "Custom Object 10",
"titlePlural": "Custom Objects 10",
"CustomObjectTagName": "CustomObjects10",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Vehicles/child/CustomObjects10/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/CustomObjects10/describe",
"kind": "describe"
}
}
},
"CustomObjects11": {
"title": "Custom Object 11",
"titlePlural": "Custom Objects 11",
"CustomObjectTagName": "CustomObjects11",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Vehicles/child/CustomObjects11/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/CustomObjects11/describe",
"kind": "describe"
}
}
},
.
.
.
"VehicleBooks": {
"title": "Vehicle Book",
"titlePlural": "Vehicle Books",
"CustomObjectTagName": "VehicleBooks",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/Vehicles/child/VehicleBooks/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Vehicles/child/VehicleBooks/describe",
"kind": "describe"
}
}
}
}
}
},
"_contextInfo": {
"limit": 100,
"offset": 0,
"lastpage": true
}
}
Retrieving Child Resources for a Top-Level Resource
The following details are for a request to retrieve metadata information for a given top-level resource object, for example, Business Plan. The example shows some of the child resources for a business plan such as accreditation requests, activities, and plan opportunities. The example uses the fields URL parameter to retrieve links metadata:
URL: https://<host>/OnDemand/user/Rest/latest/BusinessPlans/describe?fields=children.links
Note: The limit field specifies the maximum number of resource items that are returned. You can set the limit field to a maximum value of 100. The default value is 2.HTTP Method: GET
Content-Type: None
Request body: None
For more information about the fields URL parameter, see Describe Fields Parameters.
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": {
"BusinessPlans": {
"title": "Business Plan",
"titlePlural": "Business Plans",
"CustomObjectTagName": "BusinessPlans",
"children": {
"AccreditationRequests": {
"title": "Accreditation Request",
"titlePlural": "Accreditation Requests",
"CustomObjectTagName": "AccreditationRequests",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/BusinessPlans/child/AccreditationRequests/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/AccreditationRequests/describe",
"kind": "describe"
}
}
},
"Activities": {
"title": "Activity",
"titlePlural": "Activities",
"CustomObjectTagName": "Activities",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/BusinessPlans/child/Activities/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/Activities/describe",
"kind": "describe"
}
}
},
.
.
.
"PlanOpportunities": {
"title": "Plan Opportunity",
"titlePlural": "Plan Opportunities",
"CustomObjectTagName": "PlanOpportunities",
"links": {
"describe": {
"rel": "describe",
"href": "/OnDemand/user/Rest/latest/BusinessPlans/child/PlanOpportunities/describe",
"kind": "describe"
},
"canonicalDescribe": {
"rel": "canonicalDescribe",
"href": "/OnDemand/user/Rest/latest/PlanOpportunities/describe",
"kind": "describe"
}
}
}
}
}
},
"_contextInfo": {
"limit": 1,
"offset": 0,
"lastpage": true
}
}