Jump to

• Request
• Response
• Examples

Process a product upload

post

/fscmRestApi/resources/11.13.18.05/productUploads/action/process

Processes the specified product upload by uploading the product data from the data file to the staging interface and adding it to an item batch.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• attachmentsFilePath: string
  Path of the .zip file containing attachment files to be processed.
• batchId: number
  Value that uniquely identifies the item batch to which the product data is to be added.
• dataFilePath: string
  Path of the data file to be processed.
• productUploadName: string
  Name of the product upload through which products are uploaded.
• spokeSystemCode: string
  Abbreviation that identifies the spoke system whose product data is to be uploaded. This attribute is mandatory for processing product data from data pool and internal category spoke systems. For processing product data from supplier category spoke systems, either spokeSystemCode or supplierId should be specified. If neither are specified, then supplierId associated with the user invoking the process action will be used.
• supplierId: number
  Value that uniquely identifies a supplier whose product data is to be uploaded. This attribute is mandatory for processing product data from data pool category spoke systems. For processing product data from supplier category spoke systems, either spokeSystemCode or supplierId should be specified. If neither are specified, then supplierId associated with the user invoking the process action will be used.
• supplierName: string
  Name of the supplier whose product data is to be uploaded. If supplierId isn't specified, then it will be derived using the value specified for this attribute. If both, supplierId and supplierName are specified, then the supplierId derived from supplierName will be matched against the specified supplierId. In case of a mismatch between the two supplierIds, an error will be displayed.
• template: string
  Name of the import map used for uploading the products.

{
    "type":"object",
    "properties":{
        "template":{
            "type":"string",
            "description":"Name of the import map used for uploading the products.",
            "nullable":true
        },
        "supplierName":{
            "type":"string",
            "description":"Name of the supplier whose product data is to be uploaded. If supplierId isn't specified, then it will be derived using the value specified for this attribute. If both, supplierId and supplierName are specified, then the supplierId derived from supplierName will be matched against the specified supplierId. In case of a mismatch between the two supplierIds, an error will be displayed.",
            "nullable":true
        },
        "supplierId":{
            "type":"number",
            "description":"Value that uniquely identifies a supplier whose product data is to be uploaded. This attribute is mandatory for processing product data from data pool category spoke systems. For processing product data from supplier category spoke systems, either spokeSystemCode or supplierId should be specified. If neither are specified, then supplierId associated with the user invoking the process action will be used.",
            "nullable":true
        },
        "spokeSystemCode":{
            "type":"string",
            "description":"Abbreviation that identifies the spoke system whose product data is to be uploaded. This attribute is mandatory for processing product data from data pool and internal category spoke systems. For processing product data from supplier category spoke systems, either spokeSystemCode or supplierId should be specified. If neither are specified, then supplierId associated with the user invoking the process action will be used.",
            "nullable":true
        },
        "attachmentsFilePath":{
            "type":"string",
            "description":"Path of the .zip file containing attachment files to be processed.",
            "nullable":true
        },
        "productUploadName":{
            "type":"string",
            "description":"Name of the product upload through which products are uploaded.",
            "nullable":true
        },
        "dataFilePath":{
            "type":"string",
            "description":"Path of the data file to be processed.",
            "nullable":true
        },
        "batchId":{
            "type":"number",
            "description":"Value that uniquely identifies the item batch to which the product data is to be added.",
            "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
  Success or failure message of the process action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Success or failure message of the process action."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to process a product upload.

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/productUploads"

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": "process",
	"parameters": [
	{
		"productUploadName": "Product Upload-2018-06-29 04:02:41.076"
	},
	{ "dataFilePath" :"/import_map_name.csv" },
	{"template":"import_map_name"},
	{"supplierId":1234}
	]
}

Example Response Body

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

{
	"result": "The file upload is complete."
}

Back to Top