text
stringlengths 65
20k
|
|---|
Handling the cross-combination connection catalog error: If you create an integration using a SOAP-based connection, changing the connection to use a REST-based catalog has the following impact on that integration: If the integration was already activated, there is no impact on the integration.If the integration was not activated and you now attempt to activate the integration, it fails with the following error message: Activation Error:- This Integration was created using SOAP based connection but now connection changed to REST.Configure your connection to SOAP again or edit the integration for REST.5-1If you create an integration using a REST-based connection, changing the connection to use a SOAP-based catalog has the same impact on that integration.The following error message is displayed: Activation Error:- This Integration was created using REST based connection but now connection changed to SOAP.Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting. |
If the integration was not activated and you now attempt to activate the integration, it fails with the following error message: Activation Error:- This Integration was created using SOAP based connection but now connection changed to REST.Configure your connection to SOAP again or edit the integration for REST.5-1If you create an integration using a REST-based connection, changing the connection to use a SOAP-based catalog has the same impact on that integration.The following error message is displayed: Activation Error:- This Integration was created using REST based connection but now connection changed to SOAP.Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type. |
Configure your connection to SOAP again or edit the integration for REST.5-1If you create an integration using a REST-based connection, changing the connection to use a SOAP-based catalog has the same impact on that integration.The following error message is displayed: Activation Error:- This Integration was created using REST based connection but now connection changed to SOAP.Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request. |
5-1If you create an integration using a REST-based connection, changing the connection to use a SOAP-based catalog has the same impact on that integration.The following error message is displayed: Activation Error:- This Integration was created using REST based connection but now connection changed to SOAP.Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details. |
The following error message is displayed: Activation Error:- This Integration was created using REST based connection but now connection changed to SOAP.Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request. |
Configure your connection to REST again or edit the integration for SOAP.The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause. |
The Oracle Utilities Adapter uses the following strategy to handle errors in the invoke (outbound) and trigger (inbound) directions for REST endpoints.Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards. |
Error Handling in the Invoke (Outbound) Direction : The Oracle Utilities Adapter in the invoke (outbound) direction returns a standard APIInvocationError for any HTTP response that it receives with an error code.In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter. |
In addition, it also produces an APIInvocationError if a processing error occurs within the Oracle Utilities Adapter while preparing the request, calling the endpoint, or handling the response.The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details. |
The format of the APIInvocationError in the mapper is as follows.The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines. |
The errorDetails section contains the actual cause.You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination. |
You can handle the APIInvocationError with a fault handler in the orchestrated integration.Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible. |
Error Handling in the Trigger (Inbound) Direction : The Oracle Utilities Adapter in the trigger (inbound) direction exposes an HTTP endpoint that HTTP clients can request for using an HTTP request, and returns an HTTP response.If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct. |
If successful, the Oracle Utilities Adapter returns a success response.The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection . |
The Oracle Utilities Adapter returns an error response with an HTTP status belonging to the error family of codes depending on the situation.Chapter 5 Error Handling and Validations 5-2The Oracle Utilities Adapter also returns an error response with additional details about the error and possible steps for troubleshooting.The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds. |
The standard error response format is returned according to the configured response media type.The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service. |
The following is a sample JSON response structure: { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.5.1", "title" : "Internal Server Error", "detail" : "An internal error occurred while processing the request.Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates. |
Please see the fault details for the nested error details.", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. |
", "o:errorCode" : "500", "o:errorDetails" : [ { "type" : "http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html#sec10.4.1", "instance" : "{\n \"error_message\" : \"Invalid request.Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. |
Missing the 'origin' parameter.\",\n \"routes\" : [],\n \"status\" : \"INVALID_REQUEST\"\n}\n", "title" : "Bad Request", "o:errorPath" : "GET http://maps.googleapis.com/maps/api/directions/ json?destination=Montreal returned a response status of 400 Bad Request", "o:errorCode" : "APIInvocationError" } ] } The o:errorDetails section is reserved for the actual cause.The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. |
The included prefix o: is based on Oracle standards.Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free. |
Unmapped faults are propagated as system faults by Oracle Integration to the inbound Oracle Utilities Adapter.They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing. |
They may not communicate the appropriate details.Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. |
Therefore, it is recommended that you define the fault pipelines.java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. |
java.net.ConnectException Error Message If the error message java.net.ConnectException: Connection refused: connect; No available router to destination.appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S. |
appears, make sure the Oracle SOA server hosting the catalog is operating and accessible.Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services. |
Unable to Connect to OUAF Application at Run Time Error Message If the error message Unable to connect to OUAF Application at run time appears, make sure the connectivity and security credentials for the connection are correct.See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government. |
See Create a Connection .Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications. |
Unresponsive Agent Error Message If the error message No response received within response time out window of 120 seconds.Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. |
Agent may not be running, or temporarily facing connectivity issues to Oracle Messaging Cloud Service.Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. |
Please check the health of the Agent in Agent.Chapter 5 java.net.ConnectException Error Message 5-3appears and you are using the on premises agent, make sure the agent is operational and accessible.Chapter 5 Unresponsive Agent Error Message 5-4Oracle Cloud Accessing Business Objects Using REST APIs E92922-04 August 2022 Oracle Cloud Accessing Business Objects Using REST APIs, E92922-04 Copyright 2018, 2022, Oracle and/or its affiliates.Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. |
Primary Author: Oracle Corporation This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. |
Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners. |
Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. |
The information contained herein is subject to change without notice and is not warranted to be error-free.If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. |
If you find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group. |
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties. |
As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract.The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. |
The terms governing the U.S.Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle. |
Governments use of Oracle cloud services are defined by the applicable contract for such services.No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application. |
No other rights are granted to the U.S. Government.This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup? |
This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc . |
It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury.If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support. |
If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use.Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup? |
Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired. |
Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates.Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion. |
Other names may be trademarks of their respective owners.Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation. |
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation. |
All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices.UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve. |
UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation. |
This software or hardware and documentation may provide access to or information about content, products, and services from third parties.Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select. |
Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle.Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. |
Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.Contents Preface Audience vi Documentation Accessibility vi Diversity and Inclusion vi Related Resources vi Conventions vii Part I Getting Started 1 Introduction to Accessing Business Objects About Accessing Business Objects 1-1 Use Cases and Examples 1-1 About the Resource Samples in This Guide 1-2 Understanding the REST API Framework 1-2 Understanding Business Objects as REST API JSON Objects 1-3 Understanding Framework Support for Query Syntax 1-4 Testing the REST API 1-7 2 Working with the Resource Catalog About the REST API Catalog Describe 2-1 Retrieving the Resource Catalog Describe 2-2 Retrieving a Resource Describe 2-4 Describing a Resource Collection 2-4 Describing a Nested Resource 2-10 3 Working with REST API Framework Versions About REST API Framework Versions 3-1 Understanding REST API Framework Version Support 3-2 iiiUsing the Request Header to Specify the REST API Framework Version 3-6 Part II Tasks 4 CRUD Tasks Retrieving Business Objects 4-1 Fetching a Business Object 4-1 Fetching a Business Object with a Subset of Items 4-3 Fetching a Business Object Item 4-11 Paging a Business Object 4-12 Sorting a Business Object 4-15 Fetching a Child Business Object 4-18 Fetching Data Only for a Business Object 4-23 Filtering a Business Object with a Query Parameter 4-25 Creating Business Object Items 4-30 Creating a Business Object Item 4-30 Creating an Item of a Child Business Object 4-31 Updating a Business Object Item 4-33 Deleting a Business Object Item 4-34 5 Data Consistency Tasks About Data Consistency 5-1 Checking for Data Consistency When Updating Business Object Items 5-3 Checking for Data Consistency When Retrieving Business Object Items 5-6 6 Advanced Tasks Returning the Estimated Count of Business Object Items 6-1 Making Batch Requests 6-2 Working with Error Responses 6-5 Understanding the Exception Payload Error Response 6-6 Obtaining an Exception Payload Error Response 6-7 Obtaining the Standard Error Message Response 6-11 Enable Polling for Endpoint Requests 6-12 Part III Reference ivA Links and Relations Describe links Object Structure A-1 rel Attribute Values A-1 href Attribute Value A-2 cardinality Attribute Values A-2 B Framework Versions C Media Types D Data Types E Status Codes F Response Headers G Endpoints GET Method Endpoints G-1 POST Method Endpoints G-12 PATCH Method Endpoints G-13 DELETE Method Endpoints G-13 vPreface Accessing Business Objects Using REST APIs describes the supported HTTP methods, HTTP headers, request URL parameters, media types, and other concepts of the REST APIs and the use cases that they support for making REST API calls in web applications created using visual development tools offered by Oracle.Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects. |
Audience This document is intended for developers who want to create and publish modern enterprise web applications using visual development tools, including using REST APIs generated by Oracle tooling to access the data of business objects exposed in the web application.Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain. |
Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework. |
ctx=acc&id=docacc .Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool. |
Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods). |
For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs. |
ctx=acc&id=trs if you are hearing impaired.Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact. |
Diversity and Inclusion Oracle is fully committed to diversity and inclusion.Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data. |
Oracle respects and values having a diverse workforce that increases thought leadership and innovation.As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects. |
As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation.We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application. |
We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve.Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions. |
Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE. |
Related Resources For more information, see these Oracle resources: Oracle Public CloudPreface vihttp://cloud.oracle.com About Oracle Cloud in Getting Started with Oracle Cloud Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements (for example, menus and menu items, buttons, tabs, dialog controls), including options that you select.italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not. |
italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes. |
monospace Monospace type indicates language and syntax elements, directory and file names, URLs, text that appears on the screen, or text that you enter.Preface viiPart I Getting Started To interact with business objects using REST APIs you should be familiar with how to access the resources backing the business objects.Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters. |
Topics Introduction to Accessing Business Objects Working with the Resource Catalog Working with REST API Framework Versions 1 Introduction to Accessing Business Objects You can use REST APIs that rely on HTTP requests and responses as the interface to access the business objects of your domain.Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control. |
Topics About Accessing Business Objects Understanding the REST API Framework Understanding Business Objects as REST API JSON Objects Understanding Framework Support for Query Syntax Testing the REST API About Accessing Business Objects You can access business objects by making REST API calls enabled by the Oracle Business Object REST API framework.In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool. |
In web applications, REST resources acted on by REST APIs are backed by business objects exposed in the visual development tool.For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects. |
For example, web application developers working with Oracle Visual Builder can decide on the set of attributes to expose on the business objects and the actions to make available (both standard CRUD operations and custom methods).The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema. |
The design-time choices that you make when creating business objects allow the tooling to generate metadata that it uses to define REST resources and REST APIs.The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application. |
The data used by the web application is shaped by the resource's backing business object, with the parent-child relationships intact.Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects. |
Using these REST APIs exposed by the tooling, you may interact with business objects to access its data.As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime. |
As a result, your application may invoke CRUD operations to interact with the REST resources and business objects.Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style. |
Use Cases and Examples As a web application developer, working in an Oracle visual development tool like Oracle Visual Builder, you can generate REST API endpoints to manage and interact with the business objects of the application.Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects. |
Here are the types of things that you can do using REST APIs to access the data of business objects: Get a description of the REST resource, including the resource collection attributes and available actions.Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers. |
Interact with the REST resource using standard HTTP request methods, including GET, POST, PATCH, and DELETE.Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application. |
Allow the server to decide whether to create or update depending on whether the record exists or not.1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions. |
1-1Specify a framework version in a request to interact with the old format when the REST API Framework has made backward incompatible changes.Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework. |
Perform advanced queries and sorting on a resource collection and shape the returned payload using URL parameters.Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact. |
Use ETag for change detection and optimistic concurrency control.To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases. |
To understand how certain design time features used to create web applications support the availability of these REST API capabilities, consult the Oracle documentation for your visual development tool.About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality. |
About the Resource Samples in This Guide This guide describes typical use cases for interacting with and manipulating business objects.All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version. |
All samples are based on DEPARTMENTS, EMPLOYEES, JOBHISTORY, and JOBS tables in the Oracle HR schema.This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection. |
This figure depicts the business objects generated from these tables in the web application.Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers. |
Figure 1-1 Business Objects Used with REST APIs in this Guide Understanding the REST API Framework The Oracle Business Object REST API supports access to business objects.The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object. |
The Oracle Business Object REST API supports the exchange of information between the web application and server at runtime.The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object. |
The Oracle Business Object REST API is an Oracle framework that allows web application developers to expose a REST API based on the REST architectural style.The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object. |
The framework itself does not constitute a Web API, but supports creating and interacting with the business objects.The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects. |
The REST API framework determines the functionality to interact with business objects created by web application developers.In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object. |
In the web application, REST resources acted on by REST APIs are backed by business objects exposed in the web application.When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object. |
When you work in an Oracle visual development tool, like Oracle Visual Builder, you can decide on the set of attributes to expose from business objects and the actions to make available (both standard CRUD operations and custom object functions defined by the web application).Chapter 1 Understanding the REST API Framework 1-2The design-time choices that you make are captured as metadata by the tooling, which the tooling uses to generate REST resource definitions.You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities. |
You may interact with these resource definitions through the REST API, supported by the REST API framework.For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types . |
For example, you may invoke CRUD operations to interact with the REST resources and business objects, where the data is shaped by the resource's backing business object, with the parent-child relationships intact.Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items. |
Oracle releases may introduce new REST API framework functionality to support additional business object interaction use cases.To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items.Department , Employee are examples of resource collections that represent Department and Employee business objects. |
To allow you to manage the level of functionality exposed to customers in your production applications, Oracle defines numeric versions of the framework that refer to a specific level of the REST API framework functionality.As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items.Department , Employee are examples of resource collections that represent Department and Employee business objects.resource item An item of a business object. |
As Oracle introduces new Oracle Business Object REST API framework versions, you may opt into the new version to gain the new functionality, or you may decide not to opt in and instead preserve the level of functionality supported by the current REST API framework version.Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items.Department , Employee are examples of resource collections that represent Department and Employee business objects.resource item An item of a business object.The specific department 10 or employee 1012 are examples of resource items that represent items of the Department and Employee business object.Chapter 1 Understanding Business Objects as REST API JSON Objects 1-3Understanding Framework Support for Query Syntax REST API calls can make use of a query expression syntax to query business objects. |
Understanding Business Objects as REST API JSON Objects REST APIs represent the business object as a JSON-encoded resource collection.REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items.Department , Employee are examples of resource collections that represent Department and Employee business objects.resource item An item of a business object.The specific department 10 or employee 1012 are examples of resource items that represent items of the Department and Employee business object.Chapter 1 Understanding Business Objects as REST API JSON Objects 1-3Understanding Framework Support for Query Syntax REST API calls can make use of a query expression syntax to query business objects.Beginning with Oracle Business Object REST API framework version 2, REST API calls can make use of an expanded query expression syntax to query business objects. |
REST resource collections are synonymous with business objects created by web application developers.For example: A Department resource collection is based on a Department business object.An Employee resource collection is based on an Employee business object.The payload returned by REST APIs contains one or more resource collections, comprised of the resource items queried by the REST API and the individual items of the business object.The resource collections preserve the relationship of master-detail coordinating business objects.As the table below shows, the resource collection is the REST API payload representation of all items of a particular business object.The resource items are the rows and attributes of the payload item object, which represent the items of the business object.Note: The format of resource collections and contained items are defined by specific REST API media types as JSON-encoded entities.For more details, see Media Types .Table 1-1 JSON Objects and Business Object Representation JSON Object Business Object resource collection A business object comprised of one or more items.Department , Employee are examples of resource collections that represent Department and Employee business objects.resource item An item of a business object.The specific department 10 or employee 1012 are examples of resource items that represent items of the Department and Employee business object.Chapter 1 Understanding Business Objects as REST API JSON Objects 1-3Understanding Framework Support for Query Syntax REST API calls can make use of a query expression syntax to query business objects.Beginning with Oracle Business Object REST API framework version 2, REST API calls can make use of an expanded query expression syntax to query business objects.Note that version 2 and later will interpret the q query parameter value differently than framework version 1, and therefore opting into framework version 2 or later introduces a backward incompatible change to web applications that rely on framework version 1. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.