Query Parameters in REST API for Oracle Fusion

Let’s discuss some key parameters frequently used in fusion REST APIs.

 

Let's use the following API endpoint as our reference throughout -

 /fscmRestApi/resources/11.13.18.05/invoices

 

Query Parameters:

1)     Expand

Fields like invoiceDFF, invoiceLines are not fetched by default in this API. The Expand parameter allows fetching additional fields.

Fields that are usable in parameter –

invoiceLines

invoiceGdf

invoiceDff

invoiceInstallments

attachments

appliedPrepayments

availablePrepayments

 

Example –

Put this string in Bulk edit:

expand:appliedPrepayments,invoiceDff,attachments,availablePrepayments,invoiceGdf,invoiceInstallments,invoiceLines

 

 

2)     Fields

Fetch any Specific field that you want. Including Expand fields mentioned above.

 

Example –

Put this string in Bulk edit: - fields:InvoiceId,InvoiceNumber,invoiceDff

 

3)     Limit

Limit the number of records returned by the API. Default is 1000, with a range between 1 and 50000. 

Example –

Put this string in Bulk edit: - limit:100

 

 

4)     Offset

The default value of offset is 0, which means the listing begins with the first item. For instance, setting offset to 250 starts listing from the 251st item. 

Example –

Put this string in Bulk edit: - offset:5

 

 

 

5)     Links

Choose which links to include in the response payload. For example, fetching child links excluding self and canonical links.

Put this string in Bulk edit: - links:child

 

6)     onlyData

Retrieve only necessary data without additional links or fields. Accepts boolean values.

Put this string in Bulk edit: – onlyData:true 

 

 

7)     orderBy

As the name suggests, it allows us to put orderby filter to a field.

Put this string in Bulk edit: – orderBy:InvoiceId

 

 

 

8)     q

The ‘q’ parameter defines where clause. We can add multiple filters.

Put this string in Bulk edit: – orderBy:InvoiceId

 

 

9)     totalResults

This shows an estimated count of records.

Put this string in Bulk edit: – totalResults:true