REST API Batch Processes - Display info about import process

URI

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

Http Method

GET

Short Description

Returns information about an existing import process

Query Parameters

 

Example Requests

PrimeTech-Site/PrimeTechSpecials/batchprocesses/productimports/tpcKDgAY.7AAAAFA3hAnVAqa

HTTP Status Codes

200 - OK
401 - if the user is not authenticated
404 - if the process does not exist

Description

Returns information about a batch process and its state

The "attributes" property contains a list of process-specific attributes, most notably:

Attribute - Description

FinishedWithError - If true, the process didn't finish successfully

LogCount_Warn - The number of logged warnings

LogCount_Error - The number of logged errors

LogEntries - The relevant excerpt from the server's impex error log

See the example output for a full listing.

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

JobRO

Response Example

{
  "name": "ProcessProductImport",
  "description": "Import job started via REST API",
  "status": "READY",
  "type": "Job",
  "hostName": "",
  "login": "",
  "process": {
    "name": "ProcessProductImport",
    "description": "Import job started via REST API",
    "status": "finished",
    "id": "Ui8KDgAY.NYAAAFARxEnVAqa",
    "type": "Process",
    "hostName": "ildevvm",
    "server": "edit",
    "domain": "PrimeTech-PrimeTechSpecials",
    "duration": 45,
    "user": "admin",
    "endDate": 1374567403960,
    "startDate": 1374567403915,
    "progressSize": 0,
    "progressValue": 0,
    "processType": "Job",
    "attributes": {}
  },
  "serverName": "",
  "serverGroup": "",
  "extendedStatus": 3,
  "pipelineName": "ProcessImpexJob",
  "startNodeName": "Start",
  "lastExecutionTime": 1374567403915,
  "lastExecutionDuration": 0,
  "installationID": "",
  "attributes": {
    "LogCount_Warn": {
      "value": 4,
      "type": "Integer"
    },
    "CurrentProgressPercent": {
      "value": 90,
      "type": "Integer"
    },
    "CurrentActivity": {
      "value": "SQLLDRImport",
      "type": "String"
    },
    "LogEntries": {
      "value": "[2013-07-23 10:16:45.663 MESZ] [ValidatorThread-0] WARN  c.i.b.core.internal.impex.FileLogger - Impex Warning message: Product: 11089966b@PrimeTech-PrimeTechSpecials; Illegal offered product specified: id = null sku = 11089966b domain = PrimeTech-MasterRepository.\r\n[2013-07-23 10:16:45.671 MESZ] [ValidatorThread-0] WARN  c.i.b.core.internal.impex.FileLogger - Impex Warning message: Product: 11089966b@PrimeTech-PrimeTechSpecials; Illegal offered product specified: id = null sku = 11089966b domain = PrimeTech-MasterRepository.\r\n[2013-07-23 10:16:45.696 MESZ] [ValidatorThread-0] WARN  c.i.b.core.internal.impex.FileLogger - Impex Warning message: Product: 6830681b@PrimeTech-PrimeTechSpecials; Illegal offered product specified: id = null sku = 6830681b domain = PrimeTech-MasterRepository.\r\n[2013-07-23 10:16:45.701 MESZ] [ValidatorThread-0] WARN  c.i.b.core.internal.impex.FileLogger - Impex Warning message: Product: 6830681b@PrimeTech-PrimeTechSpecials; Illegal offered product specified: id = null sku = 6830681b domain = PrimeTech-MasterRepository.\r\n[2013-07-23 10:16:49.079 MESZ] [ValidatorThread-1] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Illegal product relation source: product id: null ref sku: 11089966b sku: 11089966b.\r\n[2013-07-23 10:16:49.088 MESZ] [ValidatorThread-1] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Illegal product relation source: product id: null ref sku: 6830681b sku: 6830681b.\r\n[2013-07-23 10:16:52.763 MESZ] [ValidatorThread-2] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Illegal product relation source: product id: null ref sku: 11089966b sku: 11089966b.\r\n[2013-07-23 10:16:52.764 MESZ] [ValidatorThread-4] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Illegal product relation source: product id: null ref sku: 6830681b sku: 6830681b.\r\n[2013-07-23 10:16:52.765 MESZ] [ValidatorThread-2] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Invalid product relation rejected.\r\n[2013-07-23 10:16:52.766 MESZ] [ValidatorThread-4] ERROR c.i.b.core.internal.impex.FileLogger - Impex Error message: Invalid product relation rejected.\r\n",
      "type": "String"
    },
    "FinishedWithError": {
      "value": "true",
      "type": "String"
    },
    "CurrentProgressCount": {
      "value": 20,
      "type": "Integer"
    },
    "LogCount_Verbose": {
      "value": 0,
      "type": "Integer"
    },
    "LogCount_Error": {
      "value": 6,
      "type": "Integer"
    },
    "LogCount_Info": {
      "value": 0,
      "type": "Integer"
    },
    "LogCount_Debug": {
      "value": 0,
      "type": "Integer"
    }
  }
}

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