text
stringlengths 65
20k
|
|---|
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used). |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between . |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with. |
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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the 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.When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax. |
When you decide to opt into framework version 2 (or later), REST APIs calls will process fetch requests for the q query parameter using the expanded expression syntax, whereas requests using the version 1 query-by-example syntax will become invalid and will return an error.If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action. |
If you do not opt into framework version 2 or later, the default for your release version will be framework version 1.Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object. |
Alternatively, you may preserve the base functionality by creating a new release version identifier that you associate with framework version 2, while leaving the existing release identifier defined in the web application as framework version 1.In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint. |
In version 1, filtering business object collections using query parameters is limited to a query-by-example syntax, which separates expressions using a semi-colon, as follows: GET <base_url>/Department?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, a new advanced query syntax supports filtering business object collections using rowmatch expressions, as follows: GET <base_url>/Department?q=Dname like 'SA*' or Loc = 'BOSTON' Such expressions include the case-insensitive name of a resource item, followed by an operator and one or more operand values (depending on the operator used).The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources. |
The filter can be as simple as a single expression, or it can combine expressions using the and and or conjunctions with matching sets of parentheses for grouping.Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded. |
Benefits of the Advanced Query Syntax Offered in Framework Version 2 and Later The advantages of rowmatch expression include the following.They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations. |
They may use supported operators: DepartmentNumber = 20 DepartmentNumber <> 20 DepartmentNumber <= 20 DepartmentNumber < 20 DepartmentNumber >= 20 DepartmentNumber >20 DepartmentNumber between 20 and 40 DepartmentNumber not between 20 and 40 DepartmentNumber in (20, 30, 40)Chapter 1 Understanding Framework Support for Query Syntax 1-4DepartmentName like '%S%' DepartmentName like 'RE%' DepartmentName not like 'RE%' Location is null Location is not null They may involve multiple attributes: DepartmentNumber = 10 or DepartmentName like 'RESEARCH' DepartmentNumber > 10 and DepartmentNumber < 40 DepartmentNumber < 20 or DepartmentNumber > 30 (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName like 'SALES') DepartmentNumber BETWEEN 20 and 40) and (Location like 'DAL%') (DepartmentNumber > 0 and DepartmentNumber < 100) and (DepartmentName <> 'SALES') and (Location not like 'NEW%') (DepartmentNumber = 10 or DepartmentNumber = 30) and (DepartmentName = 'ACCOUNTING' or DepartmentName = 'SALES') (DepartmentNumber = 10 and DepartmentName like 'ACC%') or (DepartmentNumber = 20 and DepartmentName like 'RES%') DepartmentName='ACCOUNTING' or (DepartmentName like 'R%' and Location like '%ALLA%') (DepartmentName like 'R%' and Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentName like 'R%' or Loc like '%ALLA%') or DepartmentName='ACCOUNTING' (DepartmentNumber between 20 and 40) and DepartmentNumber is not null They may involve attributes of nested child resources: Deptno > 5 and Emps.Job = 'MANAGER' Emps.Job = 'MANAGER' and Deptno > 5 Deptno > 5 and (Emps.Job = 'MANAGER') (Emps.Job = 'MANAGER') and Deptno > 5 (Deptno > 5) and (Emps.Job = 'MANAGER') (Deptno = 10 and Emps.Job = 'PRESIDENT') or (Deptno = 20 and Emps.Job = 'MANAGER') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.Sal >= 2500 Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Sal >= 4000) (Deptno > 5 and Emps.Job = 'ANALYST') or Emps.Sal >= 4000 Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN' Deptno > 5 and (Emps.Job = 'ANALYST' or Emps.Job = 'SALESMAN') Deptno > 5 and Emps.Job = 'MANAGER' and Emps.DirectReports.Sal >= 2000 Deptno > 5 and (Emps.Job = 'MANAGER' or Emps.DirectReports.Sal >= 2000)Chapter 1 Understanding Framework Support for Query Syntax 1-5Deptno > 10 and (Emps.Job = 'MANAGER' and (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or Deptno = 40 Deptno > 10 and (Emps.Job = 'MANAGER' or (Loc = 'NEW YORK' or Emps.Mgr=7698)) or (Deptno = 40) Deptno > 10 and (Emps.Job = 'MANAGER' or (Emps.DirectReports.Sal > 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) Deptno > 10 and (Emps.Job = 'MANAGER' and (Emps.DirectReports.Sal >= 2000 and (Emps.DirectReports.Comm = 500 or Emps.DirectReports.Deptno > 10))) They may involve the UPPER function: UPPER(DepartmentName) = 'RESEARCH' UPPER(DepartmentName) = UPPER('research') UPPER(DepartmentName) like 'RES%' and UPPER(Location) like 'DAL%' UPPER(DepartmentName) like UPPER('research') Overview of the Advanced Query Syntax Offered in Framework Version 2 and Later The following are specific expression use case examples.To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe. |
To test whether a value is null you must use the is null or the is not null keywords: AssignedToId is null AssignedToId is not null For equality use the = sign, and for inequality use either the != or the <> operators.AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included. |
AssignedToId = 100000000089003 Priority != 1 Priority <> 1 ActivityType != 'RS' ActivityType <> 'RS' For relational comparisons, use the familiar <, <=, >, or <> operators, along with between or not between .Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request. |
Priority <= 2 Priority < 3 Priority <> 1 Priority > 1 Priority >= 1 TotalLoggedHours >= 12.75 Priority between 2 and 4Chapter 1 Understanding Framework Support for Query Syntax 1-6Priority not between 2 and 4 For string matching, you can use the like operator, employing the percent sign % as the wildcard character to obtain "starts with", "contains", or "ends with" style filtering, depending on where you place your wildcard(s): RecordName like 'TT-%' RecordName like '%-TT' RecordName like '%-TT-%' To test whether a field's value is in a list of possibilities, you can use the in operator: ActivityType in ('OC','IC','RS') You can combine expressions using the conjunctions and and or along with matching sets of parentheses for grouping to create more complex filters like: (AssignedToId is null) or ( (Priority <= 2) and (RecordName like 'TT-99%')) (AssignedToId is not null) and ( (Priority <= 2) or (RecordName like 'TT-99%')) When using the between or in clauses, you must surround them by parentheses when you join them with other clauses using and or or conjunctions.Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe. |
Testing the REST API You can test REST APIs to make requests and interact with the business objects outside of your web application development tool.You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe. |
You use the visual development tool to create the web application and the business objects that your application interacts with.You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request. |
You use the endpoints generated by the development tool to test the REST APIs to access the business objects.For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe . |
For example, you can use any of the following techniques to test the REST APIs: In a 3rd party tool that you display in a browser In the cURL command line tool from a command window In a web browser (typically limited to GET requests) Testing the REST APIs requires knowledge of the REST API URI syntax.For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request. |
For details about URI syntax, consult the Oracle documentation for your visual development tool.Chapter 1 Testing the REST API 1-72 Working with the Resource Catalog You can retrieve a description of resources, including the resource collection attributes and available actions, using by a specific media type and describe action.Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource. |
Topics About the REST API Catalog Describe Retrieving the Resource Catalog Describe Retrieving a Resource Describe About the REST API Catalog Describe REST APIs support retrieving a describe for all the available resources in the resource catalog, it returns JSON objects that contain the attributes, actions, and links defined in the REST resource definitions for the business object.The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method. |
The describe for the REST API resource catalog allows you to identify the shape and actions allowed on a REST API defined for the service endpoint.By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations. |
By default the catalog describe request returns a JSON object that contains the information needed to understand all available resources.REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe. |
REST APIs support the following catalog describe use cases: Retrieve a resource catalog describe , where the describe details will be limited to resource titles and links only and children, or nested resources, will be excluded.Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default. |
Retrieve a resource catalog describe but optionally exclude or include children resources nested within a parent resource and optionally exclude or include all resource annotations.To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links . |
To retrieve the catalog describe of all the available, parent resources in the application, you append /describe to the base URL with the query parameter metadataMode set to minimal : http://<base_url>/describe?metadataMode=minimal Additionally, you can append URL query parameters on the request for a minimal catalog describe to retrieve specific details in the describe.For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe. |
For example, the following URL with appended query parameters retrieves a minimal catalog describe with all available children resources nested within their parent resources included.http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources. |
http://<base_url>/describe?metadataMode=minimal&includeChildren=true The following table identifies the URL query parameters the may be used with the catalog describe request.These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource. |
These query parameters let you control the amount of detail retrieved in the describe.2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources. |
2-1Table 2-1 Optional URL Query Parameters for Catalog Describe Requests URL Query ParameterValues Description includeChildre ntrue, false (default)Use to include all available children resources nested within a parent resource describe.You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition. |
You can append &includeChildren=true on the describe request.For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object. |
For a resource catalog describe example, see Retrieving the Resource Catalog Describe .showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition. |
showAnnotation strue, false (default)To include resource annotations in the catalog describe, you can append &showAnnotations=true on the describe request.Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection. |
Note that annotations must be defined by the web developer and may not be present on the resource.Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship. |
Retrieving the Resource Catalog Describe REST APIs support describing all available resources while retrieving a reduced amount of information for the application end point using a GET method.The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections. |
The reduced or minimal catalog describe helps improve the readability of the describe by limiting the resource information to resource titles, links, and available annotations.To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog). |
To examine the minimal describe for all available resources in the resource catalog: 1.Execute the minimal resource catalog describe and locate the names of the resources in the describe.Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe . |
Note that nested resources or children resources are not shown by default.2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL. |
2.Examine these resource objects links .For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections. |
For example, the minimal describe for a service with a Department resource returns the following objects: { "Resources" : { "Department" : { Department, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } By default children resources are not included in the minimal describe.Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe. |
Use the includeChildren query parameter to retrieve the minimal catalog describe with all available children resources nested within the parent resources.For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes. |
For example, to view children resources in the minimal describe, you can use a request like the following: <base_url>/describe?metadataMode=minimal&includeChildren=trueChapter 2 Retrieving the Resource Catalog Describe 2-2The minimal describe with the includeChildren query parameter set to true for a Department resource that includes a child resource Employee returns the following objects: { "Resources" : { "Department" : { Department, "children" : { "Employee" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }, ... } } The following sample retrieves a minimal resource catalog describe, including children resources, where the Employee resource is nested within the Department resource.Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types). |
Request URL <base_url>/describe?metadataMode=minimal&includeChildren=true HTTP Method GET Content-Type none Payload none Response HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "children" : { "Employee" : {Chapter 2 Retrieving the Resource Catalog Describe 2-3 "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] } } } Retrieving a Resource Describe REST APIs support retrieving a describe for a single resource, all the available resources, or only the nested resources.The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions . |
The describe returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects). |
The describe for the resource allows you to identify the shape and actions allowed on the business object.It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource. |
It returns a JSON object that contains the attributes, actions, and links defined in the REST resource definition.The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects. |
The Oracle Business Object REST API framework supports the following describe use cases for the service end point: Describe a single resource collection.Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe. |
Describe a nested resource in a parent-child relationship.Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources. |
Describe two or more named resource collections.Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes. |
Describe all available resources (resource catalog).For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types). |
For details, see About the REST API Catalog Describe .To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions . |
To retrieve the describe, invoke an HTTP GET with /describe appended to the resource URL.For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects). |
For example, the following URL returns the describe for the Department resource: <base_url>/Department/describe Describing a Resource Collection REST APIs support describing resource collections.To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item. |
To examine a resource collection: 1.Execute the resource collection describe and locate the names of the resources in the describe.2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL. |
2.Examine these resource objects to understand the shape of each resource:Chapter 2 Retrieving a Resource Describe 2-4attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines. |
collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool. |
item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use. |
children specifies any nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary. |
For example, the describe for the Department resource returns the following objects: { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Employee" ... } ], ... "links" : [ { } ] } } The following sample describes the Department resource.Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement. |
Request URL <base_url>/Department/describe HTTP Method GET Content-Type none Payload none ResponseChapter 2 Retrieving a Resource Describe 2-5HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload { "Resources" : { "Department" : { "discrColumnType" : false, "attributes" : [ { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 4 }, { "name" : "DepartmentName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30 }, { "name" : "RelState", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true } ], "collection" : { "rangeSize" : 25, } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "testImpl", "parameters" : [ { "name" : "testid", "type" : "string", "mandatory" : false } ], "resultType" : "string",Chapter 2 Retrieving a Resource Describe 2-6 "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "item" : { "links" : [ { "rel" : "child", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "Employee", "kind" : "collection", "cardinality" : { "value" : "1 to *", "sourceAttributes" : "DepartmentId", "destinationAttributes" : "DepartmentId" } }, { "rel" : "self", "href" : "<base_url>/Department/{id}", "name" : "self", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" } ] }, "children" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-7 "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 0, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST",Chapter 2 Retrieving a Resource Describe 2-8 "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/{id}", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/{id}/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/describe", "name" : "self", "kind" : "describe" } ] }Chapter 2 Retrieving a Resource Describe 2-9 } } Describing a Nested Resource REST APIs support describing a nested resource that results from related business objects.To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready. |
To examine nested resources in the resource catalog: 1.Execute the nested resource describe and locate the names of the resources in the describe.The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used. |
The children attribute identifies nested resources.2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call. |
2.Examine these resource objects to understand the shape of each resource: attributes specifies the list of available resource collection attributes.collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request. |
collection specifies the shape of the collection and specifies links and available actions (including media types).item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer. |
item specifies the shape of the items of the collection and itself specifies links and available actions .children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application. |
children specifies the nested resources (and itself contains attributes , collection , and item objects).For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling. |
For example, the describe for the nested resources Department and Employee returns the following objects: { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { ... } ], "collection" : { ... } ], "links" : [ { } ] "actions" : [ { } ] }, "item" : { "links" : [ { } ] "actions" : [ { } ] }, "children" : { "Department" ... } ], ... "links" : [ { } ] } }Chapter 2 Retrieving a Resource Describe 2-10The following sample (URL1) describes the Employee resource which can be found in the context of a Department resource item.Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used. |
Note : To recursively include all children of the resource item on the requested describe, provide the query parameter ?includeChildren=true on the describe URL.Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release. |
Requests URL 1 <base_url>/Department/10/child/Employee/describe HTTP Method GET Content-Type none Payload none Responses HTTP Code 200 Content-Type application/vnd.oracle.adf.description+json Payload 1 { "Resources" : { "Employee" : { "discrColumnType" : false, "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 }, { "name" : "FirstName", "type" : "string", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 20 }, { "name" : "LastName", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 25 }, { "name" : "Email", "type" : "string", "updatable" : true, "mandatory" : true,Chapter 2 Retrieving a Resource Describe 2-11 "queryable" : true, "precision" : 25 }, { "name" : "JobId", "type" : "string", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 10, "controlType" : "choice", "maxLength" : "10" }, { "name" : "DepartmentId", "type" : "integer", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 4 }, { "name" : "Salary", "type" : "number", "updatable" : true, "mandatory" : false, "queryable" : true, "precision" : 8, "scale" : 2 } ], "collection" : { "rangeSize" : 25, }, { "name" : "PrimaryKey", "attributes" : [ { "name" : "EmployeeId", "type" : "integer", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 6 } ] } ], "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee", "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] } ] }, "item" : { "links" : [ {Chapter 2 Retrieving a Resource Describe 2-12 "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/{id}", "name" : "self", "kind" : "item" }, { "rel" : "parent", "href" : "<base_url>/Department/10", "name" : "parent", "kind" : "item" } ], "actions" : [ { "name" : "get", "method" : "GET", "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "update", "method" : "PATCH", "requestType" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.resourceitem+json" ] }, { "name" : "delete", "method" : "DELETE" }, { "name" : "multiplySalary", "parameters" : [ { "name" : "multiplicand", "type" : "number", "mandatory" : false } ], "resultType" : "number", "method" : "POST", "requestType" : [ "application/vnd.oracle.adf.action+json" ], "responseType" : [ "application/json", "application/ vnd.oracle.adf.actionresult+json" ] } ] }, "links" : [ { "rel" : "self", "href" : "<base_url>/Department/10/child/Employee/describe", "name" : "self", "kind" : "describe" } ] } } }Chapter 2 Retrieving a Resource Describe 2-133 Working with REST API Framework Versions You can specify a Oracle Business Object REST API framework version to make REST API calls when you want to opt into the features that the framework version defines.Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows. |
Topics About REST API Framework Versions Understanding REST API Framework Version Support Using the Request Header to Specify the REST API Framework Version About REST API Framework Versions You may utilize a new feature or enhancement that is introduced in a version of the Oracle Business Object REST API framework if your application opts into the framework version within the visual development tool.A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header. |
A framework version refers to a specific version of the REST API framework that calls to REST APIs will use.Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions. |
Depending on the version, functionality for accessing business objects will vary.It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support . |
It is important that you know the framework version enabled in your web application since you may need to pass a different payload format to utilize a new feature or enhancement.The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework. |
The framework version used to make calls is under your control so that you may opt into the functionality when you are ready.These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions. |
These are the way the tooling allows you to specify the framework version to make calls: Specify the default framework version to be used.Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support. |
Specify the framework version using a custom request header when making the call.You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API. |
You may pass the custom header REST-Framework-Version on the REST API request to specify the framework version to use to execute the request.The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version. |
The REST API framework version passed in the version header overrides the default framework declaration defined by the web application developer.When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework. |
When your REST API call passes no version header, the calls use the default that you defined in the application.When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead. |
When you did not define the default framework version and do not pass a version header, then the version of the REST API framework is determined by the default setting enabled by the tooling.For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls. |
For the root resource /context , the default REST API framework version for the latest release will be used.You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1. |
You may want to find out the default framework version for a particular release.To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request. |
To support this use case, REST APIs will return the default framework version in the resource version describe, as the following sample shows.Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows. |
Note that you may override the default framework version with another framework version identifier by specifying the value in the REST- Framework-Version header.The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows. |
The allowedFrameworkVersions property lists the values of the available framework versions.3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax . |
3-1{ "items" : [ { "version" : "18.2", "isLatest" : true, "adf:extension" : { "defaultFrameworkVersion" : "2", "allowedFrameworkVersions" : [ "1","2","3","4","5","6","7" ] }, "links" : [ ... For details about the REST API framework functionality supported in each framework version, see Understanding REST API Framework Version Support .Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request. |
Understanding REST API Framework Version Support You can specify a Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2. |
Currently, Oracle offers the following framework versions.Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2. |
Note: Each REST API framework version after version 1 introduces functionality that the previous framework versions does not support.Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute. |
Thus, when you choose to opt into a later framework version, the REST API may introduce backward incompatible changes on the web application consuming the REST API.This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch. |
This topic explains the changes for each framework version.Framework Version 1 Note that the query-by-example resource query syntax supported in the base framework version (version 1) is not compatible with later versions of the REST API framework.Beginning with version 2 of the REST API framework, a more advanced query syntax is offered instead.Framework Version 2 The purpose of this new version is to introduce an expanded query expression syntax for making REST API calls.Version 2 of the REST API framework will interpret the q query parameter value differently than the way framework version 1 does, and therefore introduces a backward incompatible change to web applications that rely on framework version 1.Only when framework version 2 (or later) is specified for the request will the REST API support the use of the expanded expression syntax to process the request.In version 1, filtering resource collections using the q query parameter is limited to a query-by-example syntax, as follows.GET /rest/19.0/Departments?q=Dname SA*;Loc BOSTON Whereas, starting in version 2, the new advanced query syntax supports filtering resource collections using rowmatch query expressions, as follows.GET /rest/19.1/Departments?q=Dname like 'SA*' or Loc = 'BOSTON'Chapter 3 Understanding REST API Framework Version Support 3-2For an explanation of the enhanced query syntax offered by rowmatch expressions, see Understanding Framework Support for Query Syntax .Framework Version 3 The purpose of this version is to add support for retrieving nested child resources with payload attributes that may be used by the web application to determine whether more resource items would be returned in a subsequent REST API request.To support this functionality, the payload structure in framework version 3 now represents nested child resource as a resource collection, instead of an array of items, as was true in version 1 and 2.Therefore, version 3 introduces a backward incompatible change to web applications that rely on framework version 1 or version 2.If you decide to opt into version 3, you will expose functionality that allows GET operations to use the ?expand and ?fields query parameter to return a nested child resource as a resource collection with the hasMore attribute.In affect, this change supports pagination of nested child resource that would otherwise require more than one request to fetch.When you want to add support for framework version 3 to your application, the same guidelines described for framework version 2 (see above section) apply for preserving the existing level of functionality in the web application. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.