Jump to

• Request
• Response
• Examples

Get all file metrics by time frame

get

/api/erp/integrations/resources/v1/{locale}/stats/fileCountSummary

Returns the count of files processed within a given time frame.

Request

Path Parameters

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

  Example:

  en-us

Query Parameters

• 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 aggregated file count for a particular timeframe

Body ()

Root Schema : TotalFileCount

Type: object

Show Source

• errorFileCount: integer (int64)
  The count of files in error within the specfied upload time frame.
• flowName: string
  The name of the flow for which the service is being invoked.
• inProgressFileCount: integer (int64)
  The count of files being processed currently within the specfied upload time frame.
• invalidFileCount: integer (int64)
  The count of files that are invalid within the specfied upload time frame.
• processedFileCount: integer (int64)
  The count of files that are successfully processed within the specfied upload time frame.
• totalReceivedFileCount: integer (int64)
  The count of files that were uploaded within the specified time frame.
• 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":{
            "description":"The count of files that were uploaded within the specified time frame.",
            "format":"int64",
            "type":"integer"
        },
        "processedFileCount":{
            "description":"The count of files that are successfully processed within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "invalidFileCount":{
            "description":"The count of files that are invalid within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "inProgressFileCount":{
            "description":"The count of files being processed currently within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "errorFileCount":{
            "description":"The count of files in error within the specfied upload time frame.",
            "format":"int64",
            "type":"integer"
        },
        "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"
}

Back to Top

Examples

You can use this GET REST operation to get the number of files uploaded to Accounting Hub within a specific timeframe.

Example URL

Here's an example of the resource URL:

GET

/api/erp/integrations/resources/v1/{locale}/stats/fileCountSummary

cURL Command

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

Example Response

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

{   
    "flowName":"fah-import",
    "totalReceivedFileCount":1,
    "processedFileCount":1,
    "invalidFileCount":0,
    "inProgressFileCount":0,
    "errorFileCount":0, 
    "uploadedFrom": "2021-12-03T07:53:21.499111Z"
    "uploadedTo": "2021-12-04T07:53:21.499111Z"
}

Back to Top