text
stringlengths 65
20k
|
|---|
Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items . |
Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object . |
Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified. |
Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types. |
Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure. |
In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error. |
GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure. |
GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled. |
Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response. |
To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date. |
Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm." |
If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response. |
In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure. |
When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application.For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date. |
For an example of the new payload structure for nested child resources introduced in version 3, see Fetching a Child Business Object and Fetching a Business Object with a Subset of Items .For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm. |
For details about paginating a resource collection using the hasMore attribute, see Paging a Business Object .Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services. |
Framework Version 4 Version 4 is the default version that the REST APIs will use to process requests for web applications when no other version is specified.In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers. |
In addition to HTTP status codes and error messages, it is possible to obtain exception details in the response when your request is enabled to use REST API framework version 4 and the request is made for either application/vnd.oracle.adf.error+json or application/json media types.With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context . |
With framework version 4, the response will be in the form an exception detail payload which provides the following benefits to the web application: If multiple errors occur in a single request, the details of each error are presented in a hierarchical structure.An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers . |
An application-specific error code may be present that identifies the exception corresponding to each error.An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string. |
An error path may be present that identifies the location of each error in the request payload structure.Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services. |
Note: The exception detail may or may not present certain details, such as the application-specific error code and the request payloads error path.Chapter 3 Understanding REST API Framework Version Support 3-3For example, compare the error response for a POST submitted with a payload that contains the following incorrectly formatted date field when framework version 3 (or earlier) is enable and when framework version 4 (or later) is enabled.{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries. |
{ "EmpNum" : 5027, "EmpName" : "John", "EmpHireDate" : "not a date" } Standard Error Response Without framework version 4, no response payload is generated and instead only a single error message that does not reference the request payload will be returned in the response."An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding. |
"An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value. |
The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm."Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields. |
Exception Payload Error Response With framework version 4 (or later) enabled, the following exception detail payload is generated for the response.The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values. |
The payload includes the usual HTTP status code and formats the details of one or more exceptions in an array structure.{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values. |
{ "title" : "Bad Request", "status" : "400", "o:errorDetails" : [ { "detail" : "An instance of type oracle.jbo.domain.Date cannot be created from string not a date.The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values. |
The string value must be in format YYYY-MM- DDTHH:MI:SS.sss+hh:mm.", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path. |
", "o:errorCode" : "26099", "o:errorPath" : "/EmpHireDate" } ] } Framework Version 5 Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1. |
Framework Version 6 The purpose of this framework version is to easily differentiate between the resource fields and item information like links and headers.A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path. |
A new element @context is introduced in this version and all the information for an item is moved under @context .The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2. |
The changeIndicator value is moved to ETag, which is under headers .A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path. |
A new context information key is included under @context that contains the unique identifier of the specific resource item as a string.The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values. |
The new payload for a resource item in a response payload and collection response payload will be similar to the one below: { "field1": "value1", "field2": "value2",Chapter 3 Understanding REST API Framework Version Support 3-4 ... "@context" : { "key" : "AB8765BCD", "headers" : { "ETag" : "ACED00057372001..." }, "links": [ { "rel": "self", "href": "https://<baseurl>/accounts/CDRM_53640", "name": "accounts", "kind": "item" }, { // other links }} ] } } Framework Version 7 The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits. |
Framework Version 8 Framework version 8 enhances support for ClobDomain fields, multi-select LOV fields, and primary key values in queries.ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type. |
ClobDomain fields used in REST GET/POST/PATCH requests now make use of string values without the need for base64 encoding/decoding.Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed. |
Earlier framework versions rely on base64 encoding of ClobDomain fields and therefore require base64 decoding to return a text value.Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings. |
Multi-select LOV fields are now represented in the describe as array type, and request and response will have array values for multi-select LOV fields.Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ? |
Earlier framework versions return multi-select LOV fields as one string with comma-separated values.Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL. |
Starting with framework version 8, when creating or updating (POST/PATCH) multi-select LOV fields, the payload expects an array of values.Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor. |
Several changes were made to support special use cases when working with primary key values.Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ? |
Specifically, framework version 8 and above supports encoding key values in REST queries to enable the use of special characters and composite values in the URL path.1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character. |
1.In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ? |
In the case of a simple key, where the primary key has only one string/number attribute, framework version 8 and above allows special characters in key values and these values should be encoded in the URL path.Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version. |
Where OrderName is a key attribute with a value that contains a slash: "Sales/Marketing" With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%252FMarketing 2.In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework. |
In the case of a composite primary key, framework version 8 and above allows concatenation of the key values in a comma separated list and these values should be encoded in the URL path.Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support . |
Where OrderItem is a key attribute with the composite key value: "Sales/Marketing", LineItemId: 1, Status: "New"Chapter 3 Understanding REST API Framework Version Support 3-5With framework version 8 or above, you can encode the value so the URL path looks like: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C1%2CNew Or, where the composite contains a null value: "Sales/Marketing", LineItemId: 2, Status: null" The URL path looks like this: /orders/Sales%2FMarketing/child/items/Sales%252FMarketing%2C2%2C Framework Version 9 Framework version 9 enhances support for high-precision numeric fields, accessors in a URL, and queries using a LIKE operator: High-precision view attributes rely on deserialization by JavaScript clients to represent values.With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified. |
With deserialization, some loss of precision is possible for values greater than 15 digits.To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header. |
To avoid a potential loss of precision, starting with framework version 9, high-precision numeric values are converted to JSON string type.The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application. |
The REST client needs to convert the value from string type to a big integer or big decimal before any numeric computation is performed.If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports. |
If numeric computation is not required, then treat these values as strings.Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE. |
Nested child resources may be accessed using accessor dot notation in the ?field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection. |
field and ?expand query parameters of the REST URL.Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload. |
Starting with framework version 9, the REST client will return 400 Bad Request when an accessor is referenced in the URL and that accessor has not been previously exposed by the REST resource developer as a view link accessor.Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items. |
Starting with framework version 9, ?q queries that involve a LIKE operator, may use a \ (backslash) character as an escape character to support queries for these wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload. |
(question mark) and also for the \ (backslash) character.For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection. |
For example: ?q=Dname like '%\%%' - query for Dname containing % ?q=Dname like '%\*%' - query for Dname containing * ?q=Dname like '%\_%' - query for Dname containing _ ?q=Dname like '%\?%' - query for Dname containing ??q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection. |
?q=Dname like '%\\%' - query for Dname containing \ Using the Request Header to Specify the REST API Framework Version REST APIs support executing individual requests on the service endpoint using a custom header to affect the processing of the payload with the functionality specific to a particular Oracle Business Object REST API framework version.The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload. |
The framework version specified by the custom header overrides the default framework version declaration that may exist in the client application.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-6Note: A framework version refers to a specific version of the Oracle Business Object REST API framework.For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload. |
For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters. |
To process a request using a specific REST API framework version, the request must pass the custom header REST-Framework-Version with the framework version number specified.For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items. |
For example, the following header specifies framework version 2 will be used to process the request that passes this version header.REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection. |
REST-Framework-Version: 2 If the custom header is omitted on the request, then REST APIs will use the applications default framework version, as defined in the web application.When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items. |
When the application does not define a default framework version and the request omits the version header, then the base version (version 1) of the REST API framework is assumed.Chapter 3 Using the Request Header to Specify the REST API Framework Version 3-7Part II Tasks To use the REST API you should be familiar with the use cases that the REST API supports.Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request. |
Topics CRUD Tasks Data Consistency Tasks Advanced Tasks 4 CRUD Tasks You can access business object using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support . |
Topics Retrieving Business Objects Creating Business Object Items Updating a Business Object Item Deleting a Business Object Item Retrieving Business Objects REST APIs support the GET method on REST resources to retrieve a resource or nested resource, page a resource, filter a resource collection with a query, or sort a resource collection.REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later). |
REST APIs support the following GET method use cases: Fetching a resource collection payload.Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of the Department resource. |
Fetching a resource collection payload with a subset of resource items.Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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. |
Fetching a resource item payload.Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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. |
Fetching a paged resource collection.Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection. |
Fetching a sorted resource collection.Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using the pagination attributes from the response payload when you opt into REST API framework version 3, see Paging a Business Object . |
Fetching a nested child resource item payload.Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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). |
Fetching data only in a resource item payload.Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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. |
Filtering a resource item payload with query parameters.Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items. |
Fetching a Business Object REST APIs support fetching a resource collection without filtering items.The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20. |
The following sample fetches the Department resource collection and all five items of the collection.Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <base_url>/Department? |
Request URL <base_url>/Department HTTP Method GET Content-Type 4-1none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.resourcecollection+json Payload { "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" } ] }, { "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",Chapter 4 Retrieving Business Objects 4-2 "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" : 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" : 5, "offset" : 0, "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "Department", "kind" : "collection" } ] } Fetching a Business Object with a Subset of Items REST APIs support fetching a resource collection with a subset of items.The payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 payload structure of nested child resource differs depending on the REST API framework version that has been registered for the request.For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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. |
For details about the REST API framework versions, see Understanding REST API Framework Version Support .The following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 following samples are based on different versions of the REST API framework, which reflect the response payload structure change supported in REST API framework version 3 (and later).In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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. |
In both framework scenarios, the samples fetch the Employee resource as a child of 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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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: ? |
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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 . |
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 child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 attributes hasMore and count on the child resource indicate whether more items may be returned from the resource collection.For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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. |
For details aboutChapter 4 Retrieving Business Objects 4-3using 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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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. |
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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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). |
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 child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 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. |
A link is provided should it be necessary to query the child resource for additional resource items.In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 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. |
In this sample, the response payload shows the hasMore attribute is false , suggesting that no items remain unfetched on the Employee child resource for either department 10 or department 20.Request Made With Framework Version 3 URL <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 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. |
Request Made With Framework Version 3 URL <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 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. |
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 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 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 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. |
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 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 . |
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 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. |
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 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. |
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 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. |
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 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. |
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 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. |
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 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. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.