Jump to

• Request
• Response
• Examples

Upload a file

post

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

Uploads files to the specified locale on the server.

Request

Path Parameters

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

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• dateformat(required): string
  The date format used in the file.
• file: string (binary)
  The file to be uploaded. Required if `forceTrigger` and `fileId` are not provided.
• fileId: string
  ID of the existing file. Optional. Required if `file` is not provided.
• flowName(required): string
  The name of the flow associated with the upload.
• forceTrigger: boolean
  Flag to force the trigger. Optional.

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "format":"binary",
            "description":"The file to be uploaded. Required if `forceTrigger` and `fileId` are not provided."
        },
        "flowName":{
            "type":"string",
            "description":"The name of the flow associated with the upload."
        },
        "dateformat":{
            "type":"string",
            "description":"The date format used in the file."
        },
        "forceTrigger":{
            "type":"boolean",
            "description":"Flag to force the trigger. Optional."
        },
        "fileId":{
            "type":"string",
            "description":"ID of the existing file. Optional. Required if `file` is not provided."
        }
    },
    "required":[
        "flowName",
        "dateformat"
    ],
    "oneOf":[
        {
            "required":[
                "file"
            ]
        },
        {
            "required":[
                "forceTrigger",
                "fileId"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "format":"binary",
            "description":"The file to be uploaded. Required if `forceTrigger` and `fileId` are not provided."
        },
        "flowName":{
            "type":"string",
            "description":"The name of the flow associated with the upload."
        },
        "dateformat":{
            "type":"string",
            "description":"The date format used in the file."
        },
        "forceTrigger":{
            "type":"boolean",
            "description":"Flag to force the trigger. Optional."
        },
        "fileId":{
            "type":"string",
            "description":"ID of the existing file. Optional. Required if `file` is not provided."
        }
    },
    "required":[
        "flowName",
        "dateformat"
    ],
    "oneOf":[
        {
            "required":[
                "file"
            ]
        },
        {
            "required":[
                "forceTrigger",
                "fileId"
            ]
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

File uploaded and processed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• dateFormat: string
  The date format to be used for the file being uploaded.

  Example: YYYY-MM-DD
• fileID: string
  The unique identifier of the file.

  Example: 501984260292120576
• flowName: string
  The name of the flow for which the service is being invoked.

  Example: fah-import
• uploadedTime: string (date-time)
  The date and time when the file was uploaded.

  Example: 2024-12-19T05:51:04.615257040Z
• zipFileName: string
  The name of the zip file that was uploaded.

  Example: ORACPTASSWQY.ORCLFSN.JPM_VC_STATEMENT.12152024111212.csv.zip

{
    "type":"object",
    "properties":{
        "fileID":{
            "type":"string",
            "description":"The unique identifier of the file.",
            "example":"501984260292120576"
        },
        "zipFileName":{
            "type":"string",
            "description":"The name of the zip file that was uploaded.",
            "example":"ORACPTASSWQY.ORCLFSN.JPM_VC_STATEMENT.12152024111212.csv.zip"
        },
        "flowName":{
            "type":"string",
            "description":"The name of the flow for which the service is being invoked.",
            "example":"fah-import"
        },
        "dateFormat":{
            "type":"string",
            "description":"The date format to be used for the file being uploaded.",
            "example":"YYYY-MM-DD"
        },
        "uploadedTime":{
            "type":"string",
            "description":"The date and time when the file was uploaded.",
            "format":"date-time",
            "example":"2024-12-19T05:51:04.615257040Z"
        }
    }
}

400 Response

Bad Request. Invalid parameters or file.

401 Response

Unauthorized. Bearer token is missing or invalid.

500 Response

Internal Server Error. Something went wrong on the server.

Body ()

Root Schema : schema

Type: object

Show Source

• errorCode: integer
  The error code used to identify the type of error.

  Example: 5110
• errorDescription: string
  A brief description of an error.

  Example: The ERP_AP_VCC_CARD_STATEME process can't be completed. Please contact your help desk.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"integer",
            "description":"The error code used to identify the type of error.",
            "example":5110
        },
        "errorDescription":{
            "type":"string",
            "description":"A brief description of an error.",
            "example":"The ERP_AP_VCC_CARD_STATEME process can't be completed. Please contact your help desk."
        }
    }
}

Back to Top

Examples

let's say you have an Accounting Hub Transaction File for import and downstream processing. You can use this POST REST operation to upload a file.

Example URL

Here's an example of the resource URL to upload a file:

POST

api/erp/integrations/resources/v1/en-us/files/upload

Example Request

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

curl --location --request POST 'https://ewpb.apps.us.ocs.oraclecloud.com/api/erp/integrations/resources/v1/en-us/files/upload' \
--header 'Authorization: Bearer <Bearer Token> \
--form 'flowName=<FLOWNAME>' \
--form 'dateFormat=<DATEFORMAT>' \
--form 'file=@<FILEPATH>'

Example Response

The Response output provides the file identifier and timestamp to confirm the file has been received and the Accounting Hub flow has been initiated. You can ignore the Date Format field if the default date format YYYY-MM-DD is used in the file.

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

{
  {
    "fileID": "130560872745308160",
    "zipFileName": "XlaTrxHSparkRejections.zip",
    "flowName": "fah-import",
    "dateFormat": "YYYY-MM-DD",
    "uploadedTime": "2022-02-28T07:27:09.417446Z"
} 

Back to Top