REST API Jobs - Start a Job

URI

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

Http Method

PUT

Short Description

Start a Job

Query Parameters

-

Example Requests

/SMC/-/domains/root/jobs/AnalyzeDatabaseSchema

HTTP Status Codes

200 - OK
401 - if the user is not authenticated
403 - if the job cannot be started because it already runs
404 - if the domain or job can't be found
500 - if the job could not be started due to internal errors

Description

Start a Job

Cartridge

app_bo_rest_job

Application 

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

JobRO

Request Example

{
   "status": "RUNNING",
   "type": "Job"
}

Response Data Format

application/json

Response related java object

JobRO

Response Example

    {
       "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.",
       "status": "RUNNING",
       "type": "Job",
       "hostName": "",
       "domain": "Root Site",
       "extendedStatus": 1,
       "pipelineName": "AnalyzeDBSchema",
       "startNodeName": "Start",
       "process":
       {
           "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.",
           "status": "running",
           "id": "rmgKDgAYFxEAAAFA.4EClAXm",
           "type": "Process",
           "hostName": "ildevvm",
           "server": "edit",
           "domain": "root",
           "duration": 16191,
           "processType": "Job",
           "user": "admin",
           "progressSize": 0,
           "progressValue": 0,
           "startDate": 1374488527419,
           "attributes":
           {
           }
       },
       "serverName": "",
       "serverGroup": "JOB",
       "login": "",
       "lastExecutionTime": 1374488527419,
       "lastExecutionDuration": 0,
       "installationID": "",
       "attributes":
       {
       }
    }

XML

XML Request Data Format

XML Request Java Objects

 

XML Request Example

 

XML Response Data Format

XML Response Java Objects

 

XML Response Example

 

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
Tickets