REST API Batch Processes - List all batch processes of an import type

URI

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

Http Method

GET

Short Description

Returns a list of all batch processes of the given import type

Query Parameters

 

Example Requests

PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports

HTTP Status Codes

200 - OK
401 - if the user is not authenticated
404 - if the type cannot be found

Description

The returned list depends on the implementation of the subresource.

For the import resources using the PipelineBasedImportHandler, only the processes started via the REST API are returned.

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

LinkRO

Response Example

    {
       "elements":
       [
           {
               "name": "ProcessProductImport",
               "type": "Link",
               "description": "Import job started via REST API",
               "uri": "PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports/tpcKDgAY.7AAAAFA3hAnVAqa"
           }
       ],
       "type": "ResourceCollection"
    }

XML

XML Request Data Format

XML Request Java Objects

 

XML Request Example

 

XML Response Data Format

text/xml

XML Response Java Objects

LinkRO

XML Response Example

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResourceCollection>
    <elements>
    <Link name="ProcessProductImport">
    <description>Import job started via REST API</description>
    <uri>PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports/tpcKDgAY.7AAAAFA3hAnVAqa</uri>
    </Link>
    </elements>
    </ResourceCollection>

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