This API specification is available for download as an Open API 3.0 YAML file:
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 | 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 |
default - Unknown
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 | 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 |
default - Unknown
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 | 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 |
200 - OK
403 - Forbidden
500 - Internal Server Error
/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 | 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 |
default - Unknown
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
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.