1. REST APIs for Accounting Foundation Cloud Service
  2. Searching a File
  3. End Point Details
  4. Request JSON Parameters

11.1.1 Request JSON Parameters

The following table lists the Request Body.

Table 11-2 Request JSON Parameters - Searching a File

Name Type Required Description
OrdeByCode INTEGER No

The files are sorted based on the inputs provided:

  • 1 - Sorts the file name from A to Z
  • 2 - Sorts the file name from Z to A
  • 3 - Displays the Recent First files
  • 4 - Displays the Recent Last files

For Example: 3
offset INTEGER No

Specify a value that will skip the N first rows in a result set before starting to return any rows

For Example: 1
fetchSize INTEGER No

Specify the number of files to be fetched in the result set.

For Example: 100
nameStr STRING No

Specify the name of the file

For Example: CASA Statement
executionId STRING No Specify the execution ID of the file
processId STRING No Specify the process ID or Process Instance ID of the file
startDate STRING No

Specify the start date of the file in the yyyy-MM-dd HH:mm:ss format

For Example: 2022-01-01 11:20:50
endDate STRING No

Specify the end date of the file in the yyyy-MM-dd HH:mm:ss format

For Example: 2022-09-13 06:39:42
minFileSize INTEGER No

Specify the minimum size of the file in bytes

For Example:200
maxFileSize INTEGER No

Specify the maximum size of the file in bytes

For Example: 8053063680
Request JSON Sample
{"orderByCode": 3,"offset": 0,"fetchSize": 100,"nameStr": "test","executionId": "141","processId": "1661867637887","startDate": "2022-01-01 00:00:00","endDate": "2022-09-13 06:39:42","minFileSize": 0,"maxFileSize": 8053063680}