REST API Jobs - List all jobs for a domain

URI

/SMC/-/domains/<domainName>/jobs

Http Method

GET

Short Description

Returns a list of all jobs for a domain

Query Parameters

state = RUNNING | READY | DISABLED

Example Requests

https://<server>/INTERSHOP/rest/EDIT/SMC/-/domains/root/jobs?state=READY

HTTP Status Codes

200 - OK
401 - if the request has not authenticated a user

Description

Returns a list of all jobs for a domain

Cartridge

app_bo_rest_job

Application 

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

 

Request Example

 

Response Data Format

application/json

Response related java object

 

Response Example

{
   "elements":
   [
       {
           "name": "AnalyzeDatabaseSchema",
           "type": "Link",
           "description": "Analyzes the database schema to optimize performance. Disabling the Oracle GATHER_STATS_JOB entirely is not recommended because it also gathers dictionary stats (SYS/SYSTEM schemas). Therefore changing the value of AUTOSTATS_TARGET to ORACLE instead of AUTO using dbms_stats.set_param('AUTOSTATS_TARGET', 'ORACLE') is recommended.",
           "uri": "domains/root/jobs/AnalyzeDatabaseSchema"
       },
       ...
   ],
   "type": "ResourceCollection"
}

XML

XML Request Data Format

XML Request Java Objects

 

XML Request Example

 

XML Response Data Format

text/xml

XML Response Java Objects

 

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection>
<elements>
<Link name="AnalyzeDatabaseSchema">
<description>Analyzes the database schema to optimize performance. Disabling the Oracle GATHER_STATS_JOB entirely is not recommended because it also gathers dictionary stats (SYS/SYSTEM schemas). Therefore changing the value of AUTOSTATS_TARGET to ORACLE instead of AUTO using dbms_stats.set_param('AUTOSTATS_TARGET', 'ORACLE') is recommended.</description>
<uri>domains/root/jobs/AnalyzeDatabaseSchema</uri>
</Link>
...
</elements>
</ResourceCollection>

Reference - Job Handling REST API

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets