REST API Batch Processes - Create a new import process

URI

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

Http Method

POST

Short Description

Creates and starts a new import process using the given parameters

Query Parameters

-

Example Requests

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

HTTP Status Codes

401 - if the user is not authenticated
201 - if the process could be created.

Description

 Creates and starts a new import process using the given parameters

Cartridge

app_bo_rest_job

Application 

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

ParameterRO

Request Example

 {
      "type": "Parameters",
      "attributes": [
        { 
          "name": "loglevel",
          "value": "DEBUG",
          "type": "String"
        },
        {
          "name": "unitname",
          "value": "PrimeTech-PrimeTechSpecials",
          "type": "String"
        },
        {
          "name": "locale",
          "value": "en_EN",
          "type": "String"
        },
        {
          "name": "filename",
          "value": "TwoProducts-new.xml",
          "type": "String"
        },
        {
          "name": "mode",
          "value": "UPDATE",
          "type": "String"
        }
      ]
  }

Response Data Format

application/json

Response related java object

LinkRO

Response Example

    {
       "name": "ProcessProductImport",
       "type": "Link",
       "description": "Import job started via REST API",
       "uri": "PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports/vQgKDgAYKUMAAAFA3ZonVAqs"
    }

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