text
stringlengths 65
20k
|
|---|
onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response Made With Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "items" : [ { "DepartmentId" : 10, "Employee" : {Chapter 4 Retrieving Business Objects 4-4 "items" : [ { { "FirstName" : "Jennifer" } } ], " count " : 1, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/10/child/Employee ", "name" : "Employee", "kind" : "collection" }, ] }, { "DepartmentId" : 20, "Employee" : { "items" : [ { { "FirstName" : "Michael" }, { "FirstName" : "Pat" } } ], " count " : 2, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/20/child/Employee ", "name" : "Employee", "kind" : "collection" }, ] }, { ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, several requests will be required to fetch all items.The following samples fetch the attribute values of the Department and Employee collections.The query parameter fields ensures the response payload contains only the specifiedChapter 4 Retrieving Business Objects 4-5attributes.Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName . |
Content-Type none Payload none Response Made With Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "items" : [ { "DepartmentId" : 10, "Employee" : {Chapter 4 Retrieving Business Objects 4-4 "items" : [ { { "FirstName" : "Jennifer" } } ], " count " : 1, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/10/child/Employee ", "name" : "Employee", "kind" : "collection" }, ] }, { "DepartmentId" : 20, "Employee" : { "items" : [ { { "FirstName" : "Michael" }, { "FirstName" : "Pat" } } ], " count " : 2, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/20/child/Employee ", "name" : "Employee", "kind" : "collection" }, ] }, { ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, several requests will be required to fetch all items.The following samples fetch the attribute values of the Department and Employee collections.The query parameter fields ensures the response payload contains only the specifiedChapter 4 Retrieving Business Objects 4-5attributes.Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list. |
If the resource collection being fetched is large, several requests will be required to fetch all items.The following samples fetch the attribute values of the Department and Employee collections.The query parameter fields ensures the response payload contains only the specifiedChapter 4 Retrieving Business Objects 4-5attributes.Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ? |
The following samples fetch the attribute values of the Department and Employee collections.The query parameter fields ensures the response payload contains only the specifiedChapter 4 Retrieving Business Objects 4-5attributes.Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId . |
The query parameter fields ensures the response payload contains only the specifiedChapter 4 Retrieving Business Objects 4-5attributes.Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources. |
Note that a GET request may return no values for any resource in the URL that does not specify an attribute value.The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter. |
The first request (URL 1) fetches the items for employee 101.The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered. |
The query parameter fields ensures the response payload contains only the specified attributes: FirstName , LastName , and Email .The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned. |
The second request (URL 2) fetches the department DepartmentId and the FirstName item for employees of each department.The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection. |
The query parameter onlyData filters the response to hide child links.The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName . |
The third request (URL 3) fetches the department DepartmentId , the FirstName item for employees of each department, and the JobId history for each employee.The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list. |
The query parameter onlyData again filters the response to hide child links.Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId . |
Request 1 Made With Framework Version 1 or 2 URL 1 <base_url>/Employee/101?fields=FirstName,LastName,Email HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources. |
The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter. |
Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered. |
When filtering multiple resources, the resource names are followed by a colon and the comma-separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example). |
Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department? |
fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned. |
Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection. |
This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName . |
If both are provided, only fields will be considered.Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list. |
Content-Type none Payload none Response 1 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "FirstName" : "Neena", "LastName" : "Smith", "Email" : "NSMITH", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-6 "href" : "<base_url>/Employee/101", "name" : "Employee", "kind" : "item" } ] } Request 2 Made With Framework Version 1 or 2 URL 2 <base_url>/Department?fields=DepartmentId;Employee:FirstName&onlyData=true HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId . |
The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources. |
Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter. |
When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered. |
Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example). |
Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item. |
This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50. |
If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource. |
onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets. |
Content-Type none Payload none Response 2 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 2 { "items" : [ { "DepartmentId" : 10, "Employee" : [ { "FirstName" : "Jennifer" } ] }, { "DepartmentId" : 20,Chapter 4 Retrieving Business Objects 4-7 "Employee" : [ { "FirstName" : "Michael" }, { "FirstName" : "Pat" } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den" }, { "FirstName" : "Alexander" }, { "FirstName" : "Shelli" }, { "FirstName" : "Sigal" }, { "FirstName" : "Guy" }, { "FirstName" : "Karen" } ] }, { "DepartmentId" : 40, "Employee" : [ { "FirstName" : "Susan" } ] }, ... ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] Request 3 Made With Framework Version 1 or 2 URL 3 <base_url>/Department?fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection. |
fields=DepartmentId;Employee:FirstName;Employee.JobHistory:JobId&onlyD ata=trueChapter 4 Retrieving Business Objects 4-8HTTP Method GET Query Parameters fields This parameter filters resource attributes so that only the specified attributes are returned.The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources. |
The parameter value is a comma-separated list of attribute names when filtering a single resource collection.Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned. |
Example: ?fields=FirstName,LastName .When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position). |
When filtering multiple resources, the resource names are followed by a colon and the comma- separated attribute names list with a semi-colon separating each resource filter list.Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection. |
Example: ?fields=Employee:FirstName;Employee.JobHistory:JobId .Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned. |
Note that dot notation allows access to nested resources.This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item. |
This parameter cannot be combined with expand query parameter.If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4). |
If both are provided, only fields will be considered.onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection. |
onlyData This parameter filters the resource item payload to contain only data (no links section, for example).Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved. |
Content-Type none Payload none Response 3 From Framework Version 1 or 2 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 3 { "items" : [ { "DepartmentId" : 10, "Employee\" : [ { "FirstName" : "Jennifer", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 20, "Employee" : [ {Chapter 4 Retrieving Business Objects 4-9 "FirstName" : "Michael", "JobHistory" : [ { "JobId" : "MK_REP" } ] }, { "FirstName" : "Pat", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] } ] }, { "DepartmentId" : 30, "Employee" : [ { "FirstName" : "Den", "JobHistory" : [ { "JobId" : "ST_CLERK" } ] }, { "FirstName" : "Alexander", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] }, { "FirstName" : "Shelli", "JobHistory" : [ { "JobId" : "AD_ASST" }, { "JobId" : "AC_ACCOUNT" } ] ] ... ], "count" : 25, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [Chapter 4 Retrieving Business Objects 4-10 { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object Item REST APIs support fetching a resource item.The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition). |
The following sample fetches Department resource item 50.The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request. |
The response includes a link to the nested child Employee resource.Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more. |
Request URL <base_url>/Department/50 HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] }Chapter 4 Retrieving Business Objects 4-11Paging a Business Object REST APIs support retrieving resource collections with pagination to display the resource items in sets.Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection. |
Paging is performed using the following URI query parameters: limit restricts the number of resources returned inside the resource collection.If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned. |
If the limit exceeds the resource count, then the framework will return all available resources.The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection. |
The value is the maximum number of resources to be returned.offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position. |
offset defines a zero-based index into the collection (where 0 is the first position).The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned. |
The index identifies the starting position of the resource collection.If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items. |
If offset exceeds the resource count, then no resources are returned.In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names. |
In the following sample, where a Department resource collection has five items, the first request (URL1) retrieves two items (at index 0 and 1), and because offset is omitted, the starting position of the response is the first item.To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order. |
To display another set of resource items, a second request (URL2) may be made with an offset of 2 to correspond to the third item and a limit of 2 to retrieve only two more items (at index 2 and 3), and the last request (URL3) with an offset of 4 returns the last item of the five item resource collection (at index 4).Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order. |
Each time a new set of resource items is retrieved, the hasMore attribute of the response indicates whether more items may be returned from the collection.In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute. |
In this example, because the collection contains only five items, the response for URL3 shows hasMore set to false , indicating that the last set of items had been retrieved.Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute. |
Note that when the limit parameter is omitted from the paging URL, the REST API assumes a limit of 25 (as determined by the default RangeSize value on the business object definition).In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order. |
In this case, up to twenty-five items will be returned with each request.For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes. |
For this reason, it is a best practice when paging through a collection to always include the limit query parameter to ensure only the desired number of resource items are returned and not more.Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc. |
Requests URL 1 <base_url>/Department?limit=2 URL 2 <base_url>/Department?offset=2&limit=2 URL 3 <base_url>/Department?offset=4&limit=2 HTTP Method GET Query Parameters limit This parameter is an integer value that restricts the number of resource returned inside the resource collection.If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending. |
If the limit exceeds the resource total results, then the available resources will be returned.offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc. |
offsetChapter 4 Retrieving Business Objects 4-12This parameter is an integer value that defines the starting position of the resource collection.The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc . |
The default ( 0) specifies the first position.If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection. |
If the offset exceeds the resource count, then no resources are returned.Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application. |
Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-13 } ] } Payload 2 { "items" : [ { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : true, "limit" : 2, "offset" : 2, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 3 { "items" : [ { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection"Chapter 4 Retrieving Business Objects 4-14 } ] } ], "count" : 1 "hasMore" : false, "limit" : 2 "offset" : 4, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department, "kind" : "collection" } ] } Sorting a Business Object REST APIs support sorting the fetched resource items.Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions . |
Sorting is performed using the orderBy query string parameter in combination with one or more attribute names.The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource. |
The following optional sort order flags may be associated with each attribute: asc sorts in ascending order.(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2. |
(Default) desc sorts in descending order.The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later). |
The orderBy query string parameter format is: <orderBy_attribute1_name>:<(asc/desc)>, <orderBy_attribute2_name>:<(asc/desc)> Example: attribute1:desc,attribute2 The following sample (URL1) fetches the Department collection sorted by the DepartmentName attribute.The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource. |
The second sample (URL2) fetches the child Employee collection sorted by the salary attribute.Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items. |
Since the sort order flag is not specified for either request sample, the response is ascending order.Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request. |
Request URL 1 <base_url>/Department?orderBy=DepartmentName URL 2 <base_url>/Department/50/child/Employee?orderBy=Salary HTTP Method GET Query Parameter orderBy This parameter orders a resource collection based on the specified attributes.The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection. |
The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and asc or desc.Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object . |
Specify asc for ascending and desc for descending.The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later). |
The default value is asc.For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes. |
For example, ?orderBy=attr1:asc,attr2:desc .Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items. |
Content-Type noneChapter 4 Retrieving Business Objects 4-15Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload 1 { "items" : [ { "DepartmentId" : 10, "DepartmentName" : "Administration", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/10/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 40, "DepartmentName" : "Human Resources", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/40", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/40/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 20, "DepartmentName" : "Marketing", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/20", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/20/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 30, "DepartmentName" : "Purchasing", "links" : [ { "rel" : "self",Chapter 4 Retrieving Business Objects 4-16 "href" : "<base_url>/Department/30", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/30/child/Employee", "name" : "Employee", "kind" : "collection" } ] }, { "DepartmentId" : 50, "DepartmentName" : "Shipping", "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" }, { "rel" : "child", "href" : "<base_url>/Department/50/child/Employee", "name" : "Employee", "kind" : "collection" } ] } ], "count" : 5, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Payload 2 { "items" : [ { "EmployeeId" : 132, "FirstName" : "TJ", "LastName" : "Olson", "Email" : "TJOLSON", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 2100, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee/132", "name" : "Employee", "kind" : "item" } ] }, { "EmployeeId" : 136, "FirstName" : "Hazel", "LastName" : "Philtanker", "Email" : "HPHILTAN", "JobId" : "ST_CLERK", "DepartmentId" : 50, "Salary" : 3100, "links" : [ {Chapter 4 Retrieving Business Objects 4-17 "rel" : "self", "href" : "<base_url>/Employee/136", "name" : "Employee", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Employee", "name" : "Employee", "kind" : "collection" } ] } Fetching a Child Business Object REST APIs support retrieving a nested child resource collection.The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload. |
The payload structure of a nested child resource collection differs depending on the Oracle Business Object REST API framework version that has been registered for the web application.For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched. |
For details about the Oracle Business Object REST API framework versions, see Working with REST API Framework Versions .The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link). |
The following samples are based on two different versions of the Employee resource.The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. . |
The URL samples showing resource 1.0 reflect a response payload structure supported by REST API framework versions 1 and 2.While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload. |
While the URL samples showing resource 2.0, reflect the response payload structure supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator. |
In both framework scenarios, the samples fetch the Employee resource nested within the Department resource.REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ? |
REST API Framework Version 3 (and later) Starting with version 3 of the REST API framework, the REST API returns a nested child resource in the response payload as a resource collection, instead of as an array of resource items.This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization . |
This functionality, available in framework version 3 (and later), allows web applications to make a request for additional records after determining how many items were left unfetched in the initial request.The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ). |
The attributes hasMore and count on the nested resource indicate whether more items may be returned from the resource collection.For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly. |
For details about using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object .The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ? |
The following sample illustrates functionality for REST API framework version 3 (and later).The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ). |
The response payload represents the nested child resource as a resource collection, where the collection object includes the hasMore and count attributes.A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter. |
A link is provided should it be necessary to query the nested resource for additional resource items.In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered. |
In this sample, items of the Employee nested resource are fetched with a count of 3 in the payload.The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items. |
The response payload shows the hasMore attribute is false , suggesting that no items remain unfetched.Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit. |
Request Made With Framework Version 3 URL <base_url>/Department/50?expand=EmployeeChapter 4 Retrieving Business Objects 4-18HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 2 or later, the specified children are included in the resource payload (instead of just a link).The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2. |
The value of this query parameter is all or <accessor1>,<accessor2>,.. .When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120. |
When all is specified, only the top-level children will be included in the resource payload.More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee . |
More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80. |
Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload. |
expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload.The value of this query parameter is all or <accessor1>,<accessor2>,.. . |
Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ).If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload.The value of this query parameter is all or <accessor1>,<accessor2>,.. .More than one child can be specified using comma as a separator. |
If a nested child is provided (Example: Employee.Manager ), the missing children will be processed implicitly.For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload.The value of this query parameter is all or <accessor1>,<accessor2>,.. .More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization . |
For example, ?expand=Employee.Manager is the same as ?expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload.The value of this query parameter is all or <accessor1>,<accessor2>,.. .More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ? |
expand=Employee,Employee.Manager (which will expand Employee and Manager ).Note the expand parameter cannot be combined with the fields parameter.If both parameters are provided, only fields will be considered.Content-Type none Payload none Response From Framework Version 3 HTTP Code 200 Content-Type application/vnd.oracle.adf.resourceitem+json Payload { "DepartmentId" : 50, "DepartmentName" : "Shipping", "Employee" : { "items" : [ { "EmployeeId" : 120, "FirstName" : "Matthew", "LastName" : "Weiss", "Email" : "MWEISS", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8000, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/120", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item"Chapter 4 Retrieving Business Objects 4-19 } ] }, { "EmployeeId" : 121, "FirstName" : "Adam", "LastName" : "Fripp", "Email" : "AFRIPP", "JobId" : "ST_MAN", "DepartmentId" : 50, "Salary" : 8200, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50/child/Employee/121", "name" : "Employee", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] }, { ... } ] } ], " count " : 3, " hasMore " : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", " href" : "<base_url>/Department/50/child/Employee ", "name" : "Employee", "kind" : "collection" } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/50", "name" : "Department", "kind" : "item" } ] } REST API Framework Version 1 or Version 2 Version 1 and version 2 of the REST API framework return the nested child resource expanded in the response payload as an array of resource items.If the resource collection being fetched is large, you may have to make several requests since the array of resource items has a limit.The following samples illustrate functionality for REST API framework version 1 and version 2.The first request sample (URL 1) retrieves a single child resource item identified by employee 120.The URL parameter child identifies the relationship of the requested resource Employee .The second request (URL 2) shows the use of the query parameter expand to ensure that all nested Employee resource items will be returned with Department resource collection 50.Chapter 4 Retrieving Business Objects 4-20The third request (URL 3) shows the use of accessor dot notation (for example, Employee.JobHistory ) in combination with the query parameter expand to ensure that all nested JobHistory resource items will be returned with the Employee resource items for the Department resource collection 80.Request Made With Framework Version 1 or Version 2 URL 1 <base_url>/Department/50/child/Employee/120 URL 2 <base_url>/Department/50?expand=Employee URL 3 <base_url>/Department/80?expand=Employee.JobHistory&onlyData=true HTTP Method GET Query Parameter expand When this parameter is provided in combination with REST API framework version 1, the specified children are included as links in the resource payload.The value of this query parameter is all or <accessor1>,<accessor2>,.. .More than one child can be specified using comma as a separator.Example: ?expand=Employee,Localization .Nested children can also be provided following the format " Child.NestedChild " (Example: ?expand=Employee.Manager ). |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.