This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
Allows to list jobs or schedules and to manipulate their state and process data.
/domains/{DomainResourceKey}/jobs
This operation returns links denoting job information for a particular domain
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | DomainResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | state | string | A job state | ||
in query | pageable | string | A pageable id | ||
in query | offset | integer int32 | A pageable offset | ||
in query | amount | integer int32 | A pageable amount |
default - Unknown default response
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {JobResourceKey}
in subsequent requests. Links to item of type ResourceObject./domains/{DomainResourceKey}/jobs/{JobResourceKey}
This operation returns information about a schedule or job
public com.intershop.component.rest.capi.resourceobject.ResourceObject com.intershop.application.smc.rest.job.internal.restresource.JobResource.getJob()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | DomainResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | JobResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
default - Unknown default response
This operation updates a job or schedule using the transmitted fields. If the state is set to 'RUNNING', the job will be started.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | DomainResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | JobResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Job started
403 - Forbidden
500 - Internal Server Error The job could not be started.
/jobs
This operation returns links denoting job information
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | A job state | ||
in query | pageable | string | A pageable id | ||
in query | offset | integer int32 | A pageable offset | ||
in query | amount | integer int32 | A pageable amount |
default - Unknown default response
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
int32
int32
date-time
ProcessRO
object. Describes a processResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
int32
int32
date-time
date-time
int64
ResourceAttribute
object. An attributeResourceAttribute
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
LinkRO
objects. the list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
ResourceCollection
string
literals. the keys to sort forobject
literals.int32
object
literals.object
literals.int32
object
literals.int32
INFORMATIONAL
SUCCESSFUL
REDIRECTION
CLIENT_ERROR
SERVER_ERROR
OTHER
int32
object
literals.uri
string
literals.string
literals.date-time
date-time
int32
int32
string
literals.string
literals.string
literals.uri
int32
object
literals.object
literals.int32