Personal Library

Kbid	297N38
Last Modified	06-Jan-2021
Added to KB	18-Dec-2020
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.10

Reference - Jobs API 1.0.0

https://support.intershop.com/kb/297N38

Share this document

Product Version	7.10
Product To Version
Status	final

Download Specification

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

icm-jobs-1x0x0.yaml

API Specification

Introduction

OpenAPI Version: 3.0.1

Jobs Version: 1.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.

Schedules and Jobs API

Allows to list jobs or schedules and to manipulate their state and process data.

/domains/{DomainResourceKey}/jobs

GET: Returns links denoting job information

Description

This operation returns links denoting job information for a particular domain

Java 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)

Request Body

Request Parameters

Location	Name	Format	Description
in path	DomainResourceKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	state	string	A job state
in query	pageable	string	A pageable id
in query	offset	integer	A pageable offset \| Format: `int32`
in query	amount	integer	A pageable amount \| Format: `int32`

Response

default - Unknown

default response

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {JobResourceKey} in subsequent requests. Links to item of type ResourceObject.

/domains/{DomainResourceKey}/jobs/{JobResourceKey}

GET: Returns the job by name.

Description

This operation returns information about a schedule or job

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceObject com.intershop.application.smc.rest.job.internal.restresource.JobResource.getJob()

Request Body

Request Parameters

Location	Name	Format	Description
in path	DomainResourceKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	JobResourceKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`

Response

default - Unknown

default response

ResourceObject application/json

PUT: 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.

Java 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)

Request Body

JobRO application/json

Request Parameters

Location	Name	Format	Description
in path	DomainResourceKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	JobResourceKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`

Response

200 - OK

Job started

JobRO application/json

403 - Forbidden

RestException application/json

500 - Internal Server Error

The job could not be started.

RestException application/json

/jobs

GET: Returns links denoting job information

Description

This operation returns links denoting job information

Java 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)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	A job state
in query	pageable	string	A pageable id
in query	offset	integer	A pageable offset \| Format: `int32`
in query	amount	integer	A pageable amount \| Format: `int32`

Response

default - Unknown

default response

ResourceCollectionROLinkRO application/json

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.
}

}

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

}

ResourceObject application/json

{

"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"name":
string
The name of an element.

}

RestException application/json

{

"cause":
object
{
- "stackTrace":
  array
  An array of object literals.
  [
  {
  "methodName":
  string
  "fileName":
  string
  "lineNumber":
  integer
  Format: int32
  "className":
  string
  "nativeMethod":
  boolean
  }
  ]
- "message":
  string
- "localizedMessage":
  string
- "suppressed":
  array
  An array of object literals.
  [
  {
  "stackTrace":
  array
  An array of object literals.
  [
  {
  "methodName":
  string
  "fileName":
  string
  "lineNumber":
  integer
  Format: int32
  "className":
  string
  "nativeMethod":
  boolean
  }
  ]
  "message":
  string
  "localizedMessage":
  string
  }
  ]
}
"stackTrace":
array
An array of object literals.
[
{
- "methodName":
  string
- "fileName":
  string
- "lineNumber":
  integer
  Format: int32
- "className":
  string
- "nativeMethod":
  boolean
}
]
"response":
object
{
- "entityTag":
  object
  {
  - "value":
    string
  - "weak":
    boolean
  }
- "metadata":
  object
  {
  - "empty":
    boolean
  }
- "statusInfo":
  object
  {
  - "reasonPhrase":
    string
  - "family":
    string
    Possible Values: INFORMATIONALSUCCESSFULREDIRECTIONCLIENT_ERRORSERVER_ERROROTHER
  - "statusCode":
    integer
    Format: int32
  }
- "links":
  array
  An array of object literals.
  [
  {
  "uri":
  string
  Format: uri
  "title":
  string
  "uriBuilder":
  object
  "rel":
  string
  "rels":
  array
  An array of string literals.
  "params":
  object
  "type":
  string
  }
  ]
- "allowedMethods":
  array
  An array of string literals.
- "stringHeaders":
  object
  {
  - "empty":
    boolean
  }
- "mediaType":
  object
  {
  - "type":
    string
    The type
  - "subtype":
    string
  - "parameters":
    object
  - "wildcardType":
    boolean
  - "wildcardSubtype":
    boolean
  }
- "entity":
  object
- "lastModified":
  string
  Format: date-time
- "date":
  string
  Format: date-time
- "headers":
  object
  {
  - "empty":
    boolean
  }
- "cookies":
  object
- "status":
  integer
  Format: int32
- "length":
  integer
  Format: int32
- "language":
  object
  {
  - "language":
    string
  - "script":
    string
  - "country":
    string
  - "variant":
    string
  - "extensionKeys":
    array
    An array of string literals.
  - "unicodeLocaleAttributes":
    array
    An array of string literals.
  - "unicodeLocaleKeys":
    array
    An array of string literals.
  - "iso3Language":
    string
  - "iso3Country":
    string
  - "displayLanguage":
    string
  - "displayScript":
    string
  - "displayCountry":
    string
  - "displayVariant":
    string
  - "displayName":
    string
  }
- "location":
  string
  Format: uri
}
"statusCode":
integer
Format: int32
"message":
string
"localizedMessage":
string
"suppressed":
array
An array of object literals.
[
{
- "stackTrace":
  array
  An array of object literals.
  [
  {
  "methodName":
  string
  "fileName":
  string
  "lineNumber":
  integer
  Format: int32
  "className":
  string
  "nativeMethod":
  boolean
  }
  ]
- "message":
  string
- "localizedMessage":
  string
}
]

}

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.