REST API Batch Processes - Return parameter descriptions for import processes

URI

<server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses/<subresource>

Http Method

OPTIONS

Short Description

Returns the allowed HTTP methods and their acceptable input parameters

Query Parameters

 

Example Requests

<server>/PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports

HTTP Status Codes

401 - if the user isn't authenticated
200

Description

Returns the HTTP-standard header Allow as well as a response body detailing the acceptable input.

The ParameterRO for any HTTP method can then be compacted and used as input for that method on this resource (see call REST API Batch Processes - Create a new import process).

Cartridge

app_bo_rest_job

Application 

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

 

Request Example

 

Response Data Format

application/json

Response related java object

OptionsRO
ParameterRO

Response Example

{
    "methods":
    {
        "POST":
        {
            "attributes":
            [
                {
                    "name": "loglevel",
                    "type": "String",
                    "value": "["DEBUG", "ERROR", "WARN", "INFO"]"
                },
                {
                    "name": "unitname",
                    "type": "String",
                    "value": "The name of the unit where the import should be done"
                },
                {
                    "name": "description",
                    "value": "Create and start a new batch process of type import"
                },
                {
                    "name": "locale",
                    "type": "String",
                    "value": "The ISO locale code that should be used for the import"
                },
                {
                    "name": "filename",
                    "type": "String",
                    "value": "The name of the file to import"
                },
                {
                    "name": "mode",
                    "type": "String",
                    "value": "["INITIAL", "UPDATE", "DELETE", "IGNORE", "REPLACE"]"
                },
                {
                    "name": "skipValidation",
                    "type": "Boolean",
                    "value": "Set to true to try a direct import without validating the file first"
                }
            ],
            "type": "Parameters"
        }
    },
    "type": "Options"
}

XML

XML Request Data Format

XML Request Java Objects

 

XML Request Example

 

XML Response Data Format

XML Response Java Objects

 

XML Response Example

 

Reference - Job Handling REST API

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets