text
stringlengths 65
20k
|
|---|
The href points to the self link of the parent resource.In the links object, the link name is parent for this rel.child Generated when the resource has nested children.The href points to the nested collection.In the links object, the link name is the accessor name for this rel.current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource. |
In the links object, the link name is parent for this rel.child Generated when the resource has nested children.The href points to the nested collection.In the links object, the link name is the accessor name for this rel.current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json . |
child Generated when the resource has nested children.The href points to the nested collection.In the links object, the link name is the accessor name for this rel.current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes. |
The href points to the nested collection.In the links object, the link name is the accessor name for this rel.current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality. |
In the links object, the link name is the accessor name for this rel.current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource. |
current Generated in the resource version describe when multiple resource version identifiers exist.The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects. |
The href points to the most recent version identifier, as defined by the web application's version definition.predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime. |
predecessor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used. |
The href points to the previous version identifier, as defined by the web application's version definition.successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready. |
successor-version Generated in the resource version describe when multiple resource version identifiers exist.The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support. |
The href points to the next most recent version identifier, as defined by the web application's version definition.describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API. |
describe Generated in the resource version describe.The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues. |
The href points to the resource catalog describe for all resources of the same version.href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support . |
href Attribute Value The href attribute defines the URL to the linked resource or resource describe.cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version. |
cardinality Attribute Values The cardinality attribute is an optional attribute that defines the cardinality between the source resource and the destination resource.This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request. |
This attribute will be available only when the rel attribute value is child and the resource type is vnd.oracle.adf.description+json .This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls. |
This cardinality attribute has the following attributes.value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1. |
value : The value of the cardinality.Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible. |
Example: " 1 to * " sourceAttributes : The attribute in the source resource used to link to the destination resource.destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1. |
destinationAttributes : The attribute in the destination resource used to link to the source resource.Appendix A href Attribute Value A-2B Framework Versions The Oracle Business Object REST API is an Oracle framework that supports accessing business objects.The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.) |
The REST API framework supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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. |
The Oracle Business Object REST API runtime supports specifying a framework version that affects the processing of the payload or indicate the default framework version (as configured by the server) to be used.When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch. |
When you specify a framework version to process requests, it allows the API to opt into those features when they are ready.Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes functionality that allows GET operations to use the ?expand and ? |
Note: Each Oracle Business Object REST API framework version introduces functionality that the previous framework versions do not support.Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2. |
Thus, when you choose to opt into a later framework version, the REST API of your application may introduce backward incompatible changes on the service client consuming the REST API.In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version. |
In the table below, see the Does Not Support column for backward compatibility issues.See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request. |
See also Understanding REST API Framework Version Support .The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code. |
The following table explains the changes for each framework version.Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path. |
Table B-1 Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 1 - Use to process requests for web applications when no other version is specified.Supports query-by-example resource query syntax Filtering resource collections using the q query parameter is limited to a query- by-example.n/a 2 - You must specify the version for the request.Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object. |
Only then the REST API support the use of expanded expression syntax to process the request.Supports more advanced query syntax for making REST API calls.Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field. |
Interprets q query parameter value differently than Framework version 1.Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value. |
Supports filtering resource collections using rowmatch query expressions.Query-by-example resource query syntax is not compatible.Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.) |
Introduces a backward incompatible change to web application that rely on Framework version 1.B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters. |
B-1Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding. |
Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 3 - The payload structure represents nested child resource as a resource collection, instead of an array of items as in version 1 and 2.Supports 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.Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value. |
Supports pagination of nested child resource that would otherwise require more than one request to fetch.Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates. |
Exposes 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 attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character. |
fields query parameter to return a nested child resource as a resource collection with the hasMore attributeIntroduces a backward incompatible change to web application that rely on Framework version 1 or 2.4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource. |
4 Default Version.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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ? |
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.Supports the response in the form an exception detail payload that provides the following benefits to the web application: Presents the details of each error in a hierarchical structure if multiple errors occur in a single request.Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server. |
Identifies the exception corresponding to each error by including an application specific error code.Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON. |
Presents an error path that identifies the location of each error in the request payload structure.The exception detail may or may not present certain details, such as the application-specific error code and the request payload's error path.5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype. |
5 - Note: Framework version 5 is not supported for users of visual development tools provided by Oracle Cloud services.n/a n/a 6 - Supports differentiation between the resource fields and item information like links and headers.Non-attribute fields like links and headers appear within @context field in the resource item response object.links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below. |
links field in @context will no longer have the properties field.headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource. |
headers -> ETag has the changeIndicator value.New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation. |
New field key under @context contains the unique identifier of the specific resource item as a string.n/a 7 - Note: The enhancements provided by framework version 7 are not supported for users of visual development tools provided by Oracle Cloud services.n/a n/aAppendix B B-2Table B-1 (Cont.)Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table. |
Oracle Business Object REST API Framework Versions REST API Framework Version Supports Does Not Support 8 - Supports miscellaneous enhancements: URL paths composed of a primary key or composite primary key value may contain special characters.ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response. |
ClobDomain fields may use string values without base64 encoding/decoding.Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call. |
Multi-select LOVs use array values instead of comma- separated values.Use encoded values in the URL path to specify a key attribute that contains special characters or to specify a key attribute that is a composite value.ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework. |
ClobDomain fields may reference an enclosure URL (a string) for updates.The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition. |
The payload to update or create a multi- select LOV field expects an array of values.n/a 9 - Supports miscellaneous enhancements: Permits ?q queries involving the LIKE operator to contain special characters by treating \ (backslash) as an escape character.Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection . |
Returns 400 Bad Request when an accessor is referenced in the URL that has not been previously exposed on the REST resource.Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call. |
Permits the use of high- precision numeric types (integer values greater than 15 digits) without the loss of precision by converting such numeric values to string type in the describe and payload.May use a \ (backslash) character to escape wildcard characters % (percent), * (asterisk), _ (underscore), and ?(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload. |
(question mark) and also for the \ (backslash) character when the query contains one of these characters.n/aAppendix B B-3C Media Types Media types, also called MIME types or content types, define the allowed resource structure of the payload exchanged between the client and server.All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload. |
All REST API media types are based on JSON.Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework. |
Resources accessed in the web application fall under the application type and json subtype.REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition. |
REST APIs use one of the media types listed in the table below.The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements. |
The types are defined such that the media type does not vary with the business object backing the resource.Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request. |
Note that the value of the accept header depends on the context of the invocation.Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction. |
Links to the JSON token structure of the REST API media types are provided in the following table.Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests . |
Note: As an alternative to specifying the supported media types, request accept headers passed with the REST API call can specify application/json when a superset of all supported media types may be accepted in the response.Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.) |
Table C-1 Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.r esourcecollectio n+jsonGET method Represents the format for all resource collections returned by the REST API call.All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error. |
All attributes are automatically generated by the framework.Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled. |
Only the content of the items attribute is based on the resource definition.For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object. |
For an example, see Describing a Resource Collection .application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type. |
application/ vnd.oracle.adf.r esourceitem+jsonGET method POST method PATCH methodRepresents the format for all resource items returned by the REST API call.Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines. |
Also represents the format for a resource item in a POST or PATCH request payload.Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request. |
Also represents the format for a resource item in a POST or PATCH request payload.Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table. |
Only the attribute links is automatically generated by the framework.All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content. |
All the other attributes are based on the resource definition.application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created. |
application/ vnd.oracle.adf.d escription+jsonGET method Describes the resource and its elements.For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource. |
For an example, see Retrieving the Resource Catalog Describe application/ vnd.oracle.adf.b atch+jsonPOST method Describes a set of operations to be performed, where the operation consists of a set of parts and each part represents a request.The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content. |
The batch request is executed in one single transaction.For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified. |
For an example, see Making Batch Requests .C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax. |
C-1Table C-1 (Cont.)Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided. |
Media Types Supported by REST APIs Media Type Invocation Context Description application/ vnd.oracle.adf.e rror+jsonany Describes the exception payload error response for a request made with an error.To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found. |
To use this media type and obtain the exception details in an error response payload, the request must be made with REST API framework version 4 (or later) enabled.For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request. |
For an example, see Obtaining an Exception Payload Error Response .Appendix C C-2D Data Types REST APIs support data types that are specified by the web application developer when they create the business object.At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag. |
At runtime, the framework exposes the data type of fetched resources as the resource describe attribute type.The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method. |
The following table shows the relationship between the data types supported on business object fields and the corresponding REST data types that the Oracle Business Object REST API framework defines.Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request. |
Table D-1 Data Types Supported by REST APIs Business Object Field Data Type REST Data Type Boolean boolean String string Number number Datetime datetime Date date Time time Reference integer Email string Percentage string Phone string Uri string D-1E Status Codes REST APIs support HTTP response status codes, where the specific code that is returned depends on the HTTP method invoked on the request.REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers. |
REST APIs support the HTTP codes listed in the following table.Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table. |
Table E-1 HTTP Codes Supported by REST APIs HTTP Code Description 200 OK Request successfully executed and the response has content.201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload. |
201 Created Resource successfully created.The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types . |
The response contains the created resource.204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload. |
204 No Content Request successfully executed and the response doesnt have content.304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types . |
304 Not Modified According to the provided ETag, the resource was not modified.400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request. |
400 Bad Request The request could not be understood by the server due to malformed syntax.401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions . |
401 Unauthorized The server is refusing to service the request because the resource of the request is secured and authentication has not yet been provided.404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object. |
404 Not Found The requested resource was not found.406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object. |
406 Not Acceptable The business object identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item . |
412 Precondition failed The business object state in the server side doesnt match the provided ETag.415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server. |
415 Unsupported Media TypeThe server is refusing to service the request because the entity of the request is in a format not supported by the requested business object for the requested method.500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute. |
500 Internal Server ErrorThe server encountered an unexpected condition which prevented it from fulfilling the request.E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency . |
E-1F Response Headers REST APIs support a variety of HTTP headers.The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server. |
The REST API supports the HTTP response headers listed in the following table.Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server.This header is supported in order to execute conditional requests. |
Table F-1 HTTP Headers Supported by REST APIs HTTP Header Name Description Content-Type Use to specify the content-type of the request/response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server.This header is supported in order to execute conditional requests.See About Data Consistency . |
The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server.This header is supported in order to execute conditional requests.See About Data Consistency .If-None-Match Use to determine whether the state of the business object in a request does not match the current state on the server. |
Accept Use to specify the expected content-type of the response payload.The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server.This header is supported in order to execute conditional requests.See About Data Consistency .If-None-Match Use to determine whether the state of the business object in a request does not match the current state on the server.This header is supported in order to execute conditional requests. |
The REST API runtime is able to interpret (request/response) the media types, as described in Media Types .REST-Framework- VersionUse to specify the version of the REST API framework to use to process the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application, as described in About REST API Framework Versions .Location Use to identify the URI of a newly created business object.The REST API framework includes the Location header in the response of a POST to create a new business object.For an example, see Creating a Business Object Item .ETag Use to compare the state of the business object in a request with the state of business object on the server.The REST API framework supports the ETag generation for business objects that has been configured to use an change- indicator attribute.See About Data Consistency .If-Match Use to determine whether the state of the business object in a request is current with the business object on the server.This header is supported in order to execute conditional requests.See About Data Consistency .If-None-Match Use to determine whether the state of the business object in a request does not match the current state on the server.This header is supported in order to execute conditional requests.See About Data Consistency . |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.