- Menu
- Sitemap
Reference - Job Handling REST API
1 Introduction
This reference is intended for developers who want to make use of the REST API for Commerce Management application and/or System Management purposes.
2 Rest API
This section describes the Job Handling REST API.
| Title | Http Method | URI | Short Description | Product Version | Product To Version |
|---|---|---|---|---|---|
| REST API Batch Processes - Create a new import process | POST | <server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses/<subresource> | Creates and starts a new import process using the given parameters | 7.4 |
|
| REST API Batch Processes - Display info about import process | GET | <server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses/<subresource>/processID | Returns information about an existing import process | 7.4 |
|
| REST API Batch Processes - List all batch process types | GET | <server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses | Returns all registered types of batch process resources | 7.4 |
|
| REST API Batch Processes - List all batch processes of an import type | GET | <server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses/<subresource> | Returns a list of all batch processes of the given import type | 7.4 |
|
| REST API Batch Processes - Return parameter descriptions for import processes | OPTIONS | <server>/<Organization-Site>/<ChannelBackoffice-AppUrlID>/batchprocesses/<subresource> | Returns the allowed HTTP methods and their acceptable input parameters | 7.4 |
|
| REST API Jobs - Display domain info | GET | /SMC/-/domains/<domainName> | Returns information about a domain | 7.4 |
|
| REST API Jobs - Display information about a job | GET | /SMC/-/domains/<domainName>/jobs/<jobName> | Returns information about a job | 7.4 |
|
| REST API Jobs - List all jobs for a domain | GET | /SMC/-/domains/<domainName>/jobs | Returns a list of all jobs for a domain | 7.4 |
|
| REST API Jobs - List domains | GET | /SMC/-/domains | Returns a list of all domains that can have jobs assigned | 7.4 |
|
| REST API Jobs - List jobs | GET | /SMC/-/jobs | Returns a list of all jobs | 7.4 |
|
| REST API Jobs - Start a Job | PUT | /SMC/-/domains/<domainName>/jobs/<jobName> | Start a Job | 7.4 |
|
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.