Document Tree
Document Properties
Kbid
297N38
Last Modified
09-Nov-2022
Added to KB
18-Dec-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.10
  • ICM 11
  • ICM 12
Reference - Jobs REST API 1.0.0


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 7.10 and their version dependencies:

API Specification

openapi: 3.0.1 info: title: Jobs description: "This is Intershop ICM REST API documentation. \n\nThis 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.\ \ \nThis reference is intended for developers who want to make use of an easy-to-use\ \ API when developing frontend solutions.\nYou can find more information at [Intershop\ \ Communications](https://www.intershop.com). Contact our Intershop experts at\ \ [Support - Intershop Communications](https://www.intershop.com/en/support) \ \ \n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n" version: 1.0.0 servers: - url: /INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl} description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: SMC appUrl: description: The application URL identifier default: '-' tags: - name: Schedules and Jobs description: 'Allows to list jobs or schedules and to manipulate their state and process data. ' x-origin-class: com.intershop.application.smc.rest.job.internal.restresource.JobListResource paths: /domains/{DomainResourceKey}/jobs: get: tags: - Schedules and Jobs summary: 'Returns links denoting job information ' description: This operation returns links denoting job information for a particular domain operationId: getJobDefinitions parameters: - name: state in: query description: A job state schema: type: string description: A job state - name: pageable in: query description: A pageable id schema: type: string description: The pageable ID - name: offset in: query description: A pageable offset schema: type: integer description: The pageable offset format: int32 - name: amount in: query description: A pageable amount schema: type: integer description: The pageable amount format: int32 - name: DomainResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.smc.rest.domain.internal.restresource.DomainListResource responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJob parameters: JobResourceKey: $response.body#/elements/{$index}/itemId description: Links to item of type ResourceObject security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.smc.rest.job.internal.restresource.JobListResource.getJobDefinitions(java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer) x-origin-class: com.intershop.application.smc.rest.job.internal.restresource.JobListResource /domains/{DomainResourceKey}/jobs/{JobResourceKey}: get: tags: - Schedules and Jobs summary: Returns the job by name. description: This operation returns information about a schedule or job operationId: getJob parameters: - name: DomainResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.smc.rest.domain.internal.restresource.DomainListResource - name: JobResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.smc.rest.job.internal.restresource.JobListResource responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ResourceObject' text/xml: schema: $ref: '#/components/schemas/ResourceObject' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceObject com.intershop.application.smc.rest.job.internal.restresource.JobResource.getJob() x-origin-class: com.intershop.application.smc.rest.job.internal.restresource.JobResource put: tags: - Schedules and Jobs summary: Update a job using the transmitted fields. description: This operation updates a job or schedule using the transmitted fields. If the state is set to 'RUNNING', the job will be started. operationId: updateJob parameters: - name: DomainResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.smc.rest.domain.internal.restresource.DomainListResource - name: JobResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.smc.rest.job.internal.restresource.JobListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' responses: 200: description: Job started content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' 500: description: The job could not be started. content: application/json: schema: $ref: '#/components/schemas/RestException' text/xml: schema: $ref: '#/components/schemas/RestException' 403: description: FORBIDDEN content: application/json: schema: $ref: '#/components/schemas/RestException' text/xml: schema: $ref: '#/components/schemas/RestException' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.application.smc.rest.job.internal.restresource.JobResource.updateJob(com.intershop.application.smc.rest.job.capi.resourceobject.JobRO) x-origin-class: com.intershop.application.smc.rest.job.internal.restresource.JobResource /jobs: get: tags: - Schedules and Jobs summary: Returns links denoting job information description: This operation returns links denoting job information operationId: getJobDefinitions_1 parameters: - name: state in: query description: A job state schema: type: string description: A job state - name: pageable in: query description: A pageable id schema: type: string description: The pageable ID - name: offset in: query description: A pageable offset schema: type: integer description: The pageable offset format: int32 - name: amount in: query description: A pageable amount schema: type: integer description: The pageable amount format: int32 responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.smc.rest.job.internal.restresource.JobListResource.getJobDefinitions(java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer) x-origin-class: com.intershop.application.smc.rest.job.internal.restresource.JobListResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: the name of the returned element xml: attribute: true type: type: string description: 'This is a constant: **Link**' readOnly: true example: Link xml: attribute: true attributes: type: array description: the list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The uri relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: the Id of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: 'This is a constant: **ResourceAttribute**' example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: the pageable ID total: type: integer description: the pageable amount total format: int32 offset: type: integer description: the pageable offset format: int32 amount: type: integer description: the pageable amount format: int32 elements: type: array description: the list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: 'This is a constant: **ResourceCollection**' example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: the keys to sort for xml: wrapped: true items: type: string description: the keys to sort for xml: name: sortKey name: type: string description: the name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection ResourceObject: type: object properties: type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' name: type: string description: The name of an element. JobRO: title: Job type: object properties: name: type: string description: the name of the returned element xml: attribute: true description: type: string status: type: string type: type: string description: the type of the returned element readOnly: true xml: attribute: true attributes: type: array description: the list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' domain: type: string extendedStatus: type: integer format: int32 hostName: type: string installationID: type: string lastExecutionDuration: type: integer format: int32 lastExecutionTime: type: string format: date-time login: type: string pipelineName: type: string serverGroup: type: string serverName: type: string startNodeName: type: string process: $ref: '#/components/schemas/ProcessRO' attribute: $ref: '#/components/schemas/ResourceAttribute' description: Describes a job or schedule xml: name: Job ProcessRO: title: Process type: object properties: name: type: string description: the name of the returned element xml: attribute: true description: type: string status: type: string type: type: string description: the type of the returned element readOnly: true xml: attribute: true attributes: type: array description: the list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' domain: type: string hostName: type: string server: type: string processType: type: string progressSize: type: integer format: int32 progressValue: type: integer format: int32 startDate: type: string format: date-time endDate: type: string format: date-time user: type: string duration: type: integer format: int64 id: type: string attribute: $ref: '#/components/schemas/ResourceAttribute' description: Describes a process xml: name: Process RestException: type: object properties: cause: type: object properties: stackTrace: type: array items: type: object properties: methodName: type: string fileName: type: string lineNumber: type: integer format: int32 className: type: string nativeMethod: type: boolean message: type: string localizedMessage: type: string suppressed: type: array items: type: object properties: stackTrace: type: array items: type: object properties: methodName: type: string fileName: type: string lineNumber: type: integer format: int32 className: type: string nativeMethod: type: boolean message: type: string localizedMessage: type: string stackTrace: type: array items: type: object properties: methodName: type: string fileName: type: string lineNumber: type: integer format: int32 className: type: string nativeMethod: type: boolean response: type: object properties: entityTag: type: object properties: value: type: string weak: type: boolean metadata: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object statusInfo: type: object properties: reasonPhrase: type: string family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 links: uniqueItems: true type: array items: type: object properties: uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string params: type: object additionalProperties: type: string type: type: string allowedMethods: uniqueItems: true type: array items: type: string stringHeaders: type: object properties: empty: type: boolean additionalProperties: type: array items: type: string mediaType: type: object properties: type: type: string description: The type subtype: type: string parameters: type: object additionalProperties: type: string wildcardType: type: boolean wildcardSubtype: type: boolean entity: type: object lastModified: type: string format: date-time date: type: string format: date-time headers: type: object properties: empty: type: boolean additionalProperties: type: array items: type: object cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean status: type: integer format: int32 length: type: integer format: int32 language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: uniqueItems: true type: array items: type: string unicodeLocaleAttributes: uniqueItems: true type: array items: type: string unicodeLocaleKeys: uniqueItems: true type: array items: type: string iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string location: type: string format: uri statusCode: type: integer format: int32 message: type: string localizedMessage: type: string suppressed: type: array items: type: object properties: stackTrace: type: array items: type: object properties: methodName: type: string fileName: type: string lineNumber: type: integer format: int32 className: type: string nativeMethod: type: boolean message: type: string localizedMessage: type: string AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element. xml: attribute: true type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' readOnly: true xml: attribute: true responses: 200: description: OK 201: description: Created 202: description: Accepted 204: description: No Content 205: description: Reset Content 206: description: Partial Content 301: description: Moved Permanently 302: description: Found 303: description: See Other 304: description: Not Modified 305: description: Use Proxy 307: description: Temporary Redirect 400: description: Bad Request 401: description: Unauthorized 402: description: Payment Required 403: description: Forbidden 404: description: Not Found 405: description: Method Not Allowed 406: description: Not Acceptable 407: description: Proxy Authentication Required 408: description: Request Timeout 409: description: Conflict 410: description: Gone 411: description: Length Required 412: description: Precondition Failed 413: description: Request Entity Too Large 414: description: Request-URI Too Long 415: description: Unsupported Media Type 416: description: Requested Range Not Satisfiable 417: description: Expectation Failed 500: description: Internal Server Error 501: description: Not Implemented 502: description: Bad Gateway 503: description: Service Unavailable 504: description: Gateway Timeout 505: description: HTTP Version Not Supported parameters: loc: name: loc in: path description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. required: false style: matrix schema: type: string description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: The currency code (submitted as optional matrix parameter ```;cur=```). If omitted, the site's or user's default currency is used. required: false style: matrix schema: type: string description: The currency code (submitted as optional matrix parameter ```;cur=```). If omitted, the site's or user's default currency is used. default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Zloty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: The personal group identifier (submitted as matrix parameter ```;pgid=```). required: false style: matrix schema: type: string description: The personal group identifier (submitted as matrix parameter ```;pgid=```). example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). required: false style: matrix schema: type: string description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: 'Basic access authentication. In basic authentication, a request contains a header field in the form of authorization: ```Basic ```, where credentials is the Base64 encoding of ID and password joined by a single colon :.' scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: 'Bearer token authentication. A request contains a header field in the form of authorization: ```Bearer ```, where is a string generated by an authentication service in response to a login request.' scheme: bearer bearerFormat: JWT x-apiID: job x-origin-class: com.intershop.component.rest.capi.resource.RootResource,com.intershop.application.smc.rest.job.internal.restresource.JobListResource,com.intershop.application.smc.rest.job.internal.restresource.JobListResource

Open ReDoc-rendered Open API documentation in separate window.

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.