1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. ERP Data Integrations

Get a file status and metric details

get

/api/erp/integrations/resources/v1/{locale}/files/{id}

Returns the processing status and current stage for a specific file.

Request

Path Parameters
Query Parameters
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Simple JSON containing progress status and transaction count by file
Body ()
Root Schema : InboundFile
Type: object
Show Source
Nested Schema : StageChild
Type: object
Show Source
Nested Schema : FileStage
Type: object
Show Source
Nested Schema : InboundDataStage
Type: object
Show Source
Nested Schema : PostProcessStage
Type: object
Show Source
Nested Schema : ImportTransactionStage
Type: object
Show Source
Nested Schema : ValidationException
Type: object
Show Source
Nested Schema : recommendedActions
Type: array
Show Source
Back to Top

Examples

To retrieve the processing status and monitor the progress of an Accounting Hub Transaction file which was uploaded., use this GET REST operation. The response includes details such as transaction data file name, uploaded by and upload time, number of transaction header and line records in each file.

The feedback includes detailed information of the file followed by a summary for each processing stage. The main section contains information about the transaction data file including file name, when it was uploaded, by whom, date format used, as well as transaction headers and lines count.

If some of the transactions have not been processed yet, the transaction counts are subject to change as it indicates only what have been processed so far. Below the main section are information for each of the stages. The Data Validation Stage verifies the data integrity of the file. For example, whether the data file contains at least a metadata file and a header file.

The Transaction Stage verifies the transaction data complies with the business rules for Accounting Hub flow. For example, it ensures the ledger name is valid and transaction date has been provided. The last stage is the Post Processing Stage which includes generating accounting and posting into General Ledger. For each stage, the Response Output includes Start and End Time, Elapsed Time which indicates the time taken for the different stages, error messages if any, and suggested actions to resolve them. Processed and Invalid record counts are also returned for the Transaction Stage along with a hyperlink to review additional details. If the Post Processing stage was initiated but didn’t complete successfully, it also includes a hyperlink to retrieve additional details.

Example URL

Here's an example of the resource URL:

GET

/api/erp/integrations/resources/v1/{locale}/files/{id}

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/api/erp/integrations/resources/v1/en-us/files/481756702644670464?flowName=fah-import' \
--header 'Authorization: Bearer <Bearer Token>

Example Response

Here's an example of the response body in JSON format:


{   
    "fileId":"98715717449060352",
    "flowName":"fah-import",
    "status":"Accounted",
    "dateFormat":"YYYY-MM-DD",
    "uploadedTime": "2021-12-02T07:53:21.499111Z",
    "uploadedBy": "Finuser1",
    "lastStatusTime": "2022-02-02T01:07:37.604529Z",
    "elapsedTime": 687,
    "currentStage*": "Post Process",
      "totalHeaderCount": 2,
    "successHeaderCount": 2,
    "errorHeaderCount": 0,
    "totalLineCount": 2,
    "successLineCount": 2,
    "errorLineCount": 0,
    "inProcessingCount":0,
    "stages":{
        "inboundData":{
            "name": "Inbound Data",
            "startTime": "2022-02-02T00:56:09.984994Z",
            "endTime": "2022-02-02T00:59:35.681360Z",
            "elapsedTime": "3min 25sec",
            "status": "SUCCEEDED",
            "errors": <REFERENCE TO Inbound Data Errors API> - 3a
            "exceptions":<REFERENCE TO Inbound Data Exceptions API> - 4
        },
        "transaction":{
            "name": "Transaction",
            "startTime": "2022-02-02T00:59:58.949058Z",
            "endTime": "2022-02-02 01:06:58.401",
            "elapsedTime": "6min 59sec",
            "status": "SUCCEEDED",
            "totalHeaderCount": 2,
            "successHeaderCount": 2,
            "errorHeaderCount": 0,
            "totalLineCount": 2,
            "successLineCount": 2,
            "errorLineCount": 0,
            "errors": <REFERENCE TO Inbound Data Errors API> - 3a           
            "exceptions": <REFERENCE TO Inbound Transaction Exceptions API> - 4
        },
        "postProcess": {
            "name": "Post Process",
            "startTime": "2022-02-02T00:56:09.984994Z",
            "endTime": "2022-02-02T00:59:35.681360Z",
            "elapsedTime": "3min 25sec",
            "status": "SUCCEEDED "
            "subStages": <REFERENCE TO Post Process API> -3c
            "errors": <REFERENCE TO Inbound Post Process Exceptions API>
            "exceptions": <REFERENCE TO Inbound Post Process Exceptions API> - 4  
        }
    }
 }
Back to Top