Jump to

• Request
• Response
• Examples

Upload a data file

post

/fscmRestApi/resources/11.13.18.05/itemBatches/action/uploadFile

Uploads and processes the data from the specified data file by adding it to an item batch.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• batchId: number
  Value that uniquely identifies the item batch.
• batchNumber: string
  Number that identifies the item batch.
• dataFilePath: string
  Path of the data file to be uploaded.
• errorResponseType: string
  Type of error response to get on failure of data file upload. Valid values are file and text. The default value is file.
• importMapName: string
  Name of the import map used for uploading the data.

{
    "type":"object",
    "properties":{
        "errorResponseType":{
            "type":"string",
            "description":"Type of error response to get on failure of data file upload. Valid values are file and text. The default value is file.",
            "nullable":true
        },
        "dataFilePath":{
            "type":"string",
            "description":"Path of the data file to be uploaded.",
            "nullable":true
        },
        "batchId":{
            "type":"number",
            "description":"Value that uniquely identifies the item batch.",
            "nullable":true
        },
        "importMapName":{
            "type":"string",
            "description":"Name of the import map used for uploading the data.",
            "nullable":true
        },
        "batchNumber":{
            "type":"string",
            "description":"Number that identifies the item batch.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, then this action returns Success, else an error message is returned.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns Success, else an error message is returned."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to upload a data file.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/itemBatches"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"name":"uploadFile",
	"parameters":[
	{
		"batchNumber":325418
	},
	{
		"dataFilePath" : "/scm/item/import/Import.csv"
	},
	{
		"importMapName":"Import Map"
	}
	]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"result": "File upload complete. 2 rows were uploaded to batch 325418.Your process 200,046 was submitted."
}

Back to Top