Jump to

• Request
• Response

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