Jump to

• Request
• Response
• Examples

Get all files uploaded in a specified time frame

get

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

Returns details of all the uploaded zips in a particular time frame

Request

Path Parameters

• locale(required): string
  The locale to which the file is being uploaded.

  Example:

  en-us

Query Parameters

• fileName: string
  The name of the file that was uploaded.
• flowName: string
  The name of the flow for which the service is being invoked.
• time: string
  The time frame for which the transaction metrics are fetched. Valid values are 1, 2, 3, and so on. The number indicates the number of days. For example, 1 indicates one day and 2 indicates two days.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Simple JSON containing details of all the uploaded zips in a particular timeframe

Body ()

Root Schema : FileSummary

Type: object

Show Source

• fileDetails: array fileDetails
  The details of the uploaded files for the specified time frame.
• flowName: string
  The name of the flow for which the service is being invoked.
• totalReceivedFileCount: integer (int32)
  The count of files that are uploaded.
• uploadedFrom: string
  Indicates the start date and time of the time range within which the files are uploaded.
• uploadedTo: string
  Indicates the end date and time of the time range within which the files are uploaded.

{
    "properties":{
        "flowName":{
            "description":"The name of the flow for which the service is being invoked.",
            "type":"string"
        },
        "totalReceivedFileCount":{
            "format":"int32",
            "description":"The count of files that are uploaded.",
            "type":"integer"
        },
        "fileDetails":{
            "items":{
                "$ref":"#/components/schemas/BaseFileDetails"
            },
            "description":"The details of the uploaded files for the specified time frame.",
            "type":"array"
        },
        "uploadedFrom":{
            "description":"Indicates the start date and time of the time range within which the files are uploaded.",
            "type":"string"
        },
        "uploadedTo":{
            "description":"Indicates the end date and time of the time range within which the files are uploaded.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : fileDetails

Type: array

The details of the uploaded files for the specified time frame.

Show Source

• Array of: object BaseFileDetails

{
    "items":{
        "$ref":"#/components/schemas/BaseFileDetails"
    },
    "description":"The details of the uploaded files for the specified time frame.",
    "type":"array"
}

Nested Schema : BaseFileDetails

Type: object

Show Source

• fileId: string
• fileName: string
• status: string
• uploadedBy: string
• uploadedTime: string

{
    "properties":{
        "fileName":{
            "type":"string"
        },
        "fileId":{
            "type":"string"
        },
        "uploadedBy":{
            "type":"string"
        },
        "uploadedTime":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Examples

You can get a summary of data files processed by the Accounting Hub flow within a particular timeframe, 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.

Example URL

Here's an example of the resource URL:

GET

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

cURL Command

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

Example Response

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

{   
    "flowName":"fah-import",
    "totalReceivedFileCount":1,
    "fileDetails":[
        {
            "fileName": "XlaTrx10.zip",
            "fileId": "98715717449060352",
            "SubLedgerName":"LOAN",
            "uploadedBy": "Finuser1",
            "uploadedTime:"2021-12-04T07:53:21.499111Z",   
            "totalHeaderCount":100,
            "errorHeaderCount":40,
            "totalLineCount":100,
            "errorLineCount":40,
            "status": "In Progress/Accounted/Exceptions/Failed"
        }
    ] 
    "uploadedFrom": "2021-12-03T07:53:21.499111Z"
    "uploadedTo": "2021-12-04T07:53:21.499111Z" 

}
 

Back to Top