Document Tree
Document Properties
Kbid
310C17
Last Modified
22-Sep-2023
Added to KB
22-Sep-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 11
Home ⋮ Knowledge Base
Reference - Batch Processes REST API 2.0.0
Share this document
ReDoc View
Document View


This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Processes Version: 2.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Batch Processes (Imports) API
/batchprocesses/catalogimports
GET: Returns catalog import process information

Description

This operation returns catalog import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a catalog import process

Description

This operation creates a new catalog import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/customerimports
GET: Returns customer import process information

Description

This operation returns customer import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a customer import process

Description

This operation creates a new customer import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/orderimports
GET: Returns order import process information

Description

This operation returns order import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates an order import process

Description

This operation creates a new order import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/pricelistimports
GET: Returns price list import process information

Description

This operation returns price list import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a price list import process

Description

This operation creates a new price list import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/productimports
GET: Returns product import process information

Description

This operation returns product import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a product import process

Description

This operation creates a new product import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/scaledpriceimports
GET: Returns scaled price import process information

Description

This operation returns scaled price import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a scaled price import process

Description

This operation creates a new price import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/userimports
GET: Returns user import process information

Description

This operation returns user import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a user import process

Description

This operation creates a new user import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
/batchprocesses/variationtypeimports
GET: Returns variation type import process information

Description

This operation returns variation type import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querystatestringOnly return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.
POST: Creates a variation type import process

Description

This operation creates a new variation type import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

--

Response

201 - Created

LinkRO application/json
BatchProcesses API
/batchprocesses
GET: Returns links denoting batch process and import types

Description

This operation returns links denoting batch processes and imports that match the given type.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.TypedBatchProcessListResource.listTypes(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querytypestringimportAllows to filter for batch processes of the specified type. If no type is specified, all batch processes are displayed.
in querysubtypestringproductAllows to filter for batch processes of the specified subtype. If no subtype is specified, all batch processes are displayed.

Response

200 - OK

ResourceCollectionROLinkRO application/json
/batchprocesses/catalogimports/{GenericBatchProcessResourceKey}
GET: Returns information about a catalog import process

Description

This operation returns information about a catalog import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the catalog import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/customerimports/{GenericBatchProcessResourceKey}
GET: Returns information about a customer import process

Description

This operation returns information about a customer import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the customer import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/orderimports/{GenericBatchProcessResourceKey}
GET: Returns information about an order import process

Description

This operation returns information about an order import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the order import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/pricelistimports/{GenericBatchProcessResourceKey}
GET: Returns information about a price list import process

Description

This operation returns information about a price list import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the price list import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/productimports/{GenericBatchProcessResourceKey}
GET: Returns information about a product import process

Description

This operation returns information about a product import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the product import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/scaledpriceimports/{GenericBatchProcessResourceKey}
GET: Returns information about a scaled price import process

Description

This operation returns information about a scaled price import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the scaled price import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/userimports/{GenericBatchProcessResourceKey}
GET: Returns information about a user import process

Description

This operation returns information about a user import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the user import process

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/variationtypeimports/{GenericBatchProcessResourceKey}
GET: Returns information about a variation type import process

Description

This operation returns information about a variation type import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathGenericBatchProcessResourceKeystringExampleProcessIdRequired | The process id of the variation type import process

Response

200 - OK

JobRO application/json

404 - Not Found

File Uploads API

Import file upload

/batchprocesses/uploads
GET: Returns all uploaded import files.

Description

Returns all uploaded import files of the requested site

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource.getFiles()

Request Body

--

Request Parameters

--

Response

200 - OK

Array of UploadFileRO application/json

401 - Unauthorized

403 - Forbidden Requires authentication with user having assigned at least one of the following permissions:
- (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS)

404 - Not Found

POST: Uploads the content of an import file.

Description

Uploads the content of an import file via a HTTP multipart request. The uploaded content is stored in the import/export folder of the unit of the requested site.

Java Method

public com.intershop.application.backoffice.rest.batch.capi.resourceobject.UploadFileRO com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource.uploadFile(java.io.InputStream,java.lang.String,java.lang.String)

Request Body

MultipartRequest multipart/form-data

Request Parameters

--

Response

200 - OK File content upload was successful.

UploadFileRO application/json

401 - Unauthorized

403 - Forbidden Requires authentication with user having assigned at least one of the following permissions:
- (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS)

404 - Not Found

/batchprocesses/uploads/{UploadFileKey}
DELETE: Removes the uploaded file.

Description

Removes the uploaded file from the import/export directory of the requested site.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource.deleteUploadFile()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathUploadFileKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

204 - No Content File was successfully deleted.

401 - Unauthorized

403 - Forbidden Requires authentication with user having assigned at least one of the following permissions:
- (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS)

404 - Not Found

Request and Response Object Schemata
JobRO application/json{
  • "name":
    string
    The name of the returned element
  • "description":
    string
  • "status":
    string
  • "type":
    string
    Readonly | The type of the returned element
  • "attributes":
    array
    An array of ResourceAttribute objects. The list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "domain":
    string
  • "extendedStatus":
    integer
    Format: int32
  • "hostName":
    string
  • "installationID":
    string
  • "lastExecutionDuration":
    integer
    Format: int32
  • "lastExecutionTime":
    string
    Format: date-time
  • "login":
    string
  • "pipelineName":
    string
  • "serverGroup":
    string
  • "serverName":
    string
  • "startNodeName":
    string
  • "process":
    object
    A ProcessRO object. Describes a process
    {
    • "name":
      string
      The name of the returned element
    • "description":
      string
    • "status":
      string
    • "type":
      string
      Readonly | The type of the returned element
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "domain":
      string
    • "hostName":
      string
    • "server":
      string
    • "processType":
      string
    • "progressSize":
      integer
      Format: int32
    • "progressValue":
      integer
      Format: int32
    • "startDate":
      string
      Format: date-time
    • "endDate":
      string
      Format: date-time
    • "user":
      string
    • "duration":
      integer
      Format: int64
    • "id":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
LinkRO application/json{
  • "name":
    string
    The name of the returned element
  • "type":
    string
    Readonly | This is a constant: Link | Example: Link
  • "attributes":
    array
    An array of ResourceAttribute objects. The list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "uri":
    string
    The URI
  • "relation":
    string
    The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  • "title":
    string
    The title of the link
  • "description":
    string
    The description of the link
  • "itemId":
    string
    The ID of the linked item
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
MultipartRequest multipart/form-data{
  • "file":
    string
    Required | The content of the file to be uploaded. | Format: binary | Example: PRIVATE 2019-01-02T09:00:00+02:00 Heimroth alexandra@test.intershop.de 1930316f492bd468698e92c14ea5ee1a226270d8a711781f4e5396fb6eb98a63674a58174ae7da37 1 547596a12d5e6dd01f710edfff2b4fd13cc4d13c9d4680494e267c31e62405c04c594371d80185db alexandra@test.intershop.de Who was your first employer? 2019-01-18T17:06:48+02:00 2019-01-18T17:06:48+02:00 alexandra@test.intershop.de 1973-09-13 Heimroth en_US Alexandra Consumer Channel Consumer 1
    customeraddr-AKhpqjoiDGmmhnRIiqeCBunDLo Potsdam DE 14439 4936412587 Heimroth Alexandra Weiergasse 19 1
    customeraddr-AreETWxrLysniLekIEUhKLKJso Potsdam DE 14434 4936412587 Heimroth Alexandra Rentnerstieg 12 1
  • "type":
    string
    Required | The import type. | Example: Customer | Possible Values: CatalogProductPriceListScaledPriceVariationTypeUserCustomer
  • "fileType":
    string
    Required | The file type of the import file to be uploaded. | Example: XML | Possible Values: XMLCSV
}
ParameterRO application/json{
  • "name":
    string
    The name of the parameter.
  • "type":
    string
    Readonly | This is a constant: Parameters | Example: Parameters
  • "attributes":
    array
    An array of ResourceAttribute objects. The list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    The pageable ID.
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of the returned element
}
UploadFileRO application/json[
UploadFileRO: Represents the result of a successful file upload
{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "location":
    string
    Readonly | The path to the uploaded file at the server starting from the sites folder | Example: TestRestEnterprise-TestRestSalesChannel-Site/units/TestRestEnterprise-TestRestSalesChannel/impex/src/customer
  • "fileName":
    string
    Readonly | The name of the uploaded file at the server in the format: '{date}T{time}_{random_number}.{file_type_extension}' | Example: 20220915T234133318_35887120.xml
  • "fileCreationTime":
    string
    Readonly | The creation time of the uploaded file at the server | Format: date-time | Example: 2022-09-15T19:41:33.000Z
  • "uri":
    string
    Readonly | The URI uniquely identifying the uploaded file in REST. | Example: TestRestEnterprise-Site/TestRestSalesChannel/batchprocesses/uploads/20220915T234133318_35887120.xml
}
]
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.