Operation
get /data/esmBrowser/jobList/AbortJob/{jobName}/{offset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobName | required | jobName Run GetJobListJ rest call to get jobName | --- |
offset | required | offset client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/DeleteAllInprogressJobs
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reqObjHolder | ReqObjHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/DeleteJobList/{jobId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobId | required | jobId . Run GetJobListJ rest call to get jobId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reqObjHolder | ReqObjHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/DeleteJobList/{jobId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobId | required | jobId . Run GetJobListJ rest call to get jobId | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reqObjHolder | ReqObjHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/jobList/DeleteJobList/334
Produces
application/json
Example Response Data
{ "req": null, "errorReason": null, "errorCode": null, "message": null, "cmdStatus": "Success", "opMsg": "", "msgCode": "JOB_DELETE_SUCCESS", "parameters": [], "paramCount": 0 }
External Docs
Operation
post /data/esmBrowser/jobList/FetchJobListForIds/{clientZoneOffset}/{type}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
type | required | type values are like esm or otn | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | jobIdList | array[String] |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetJobListByObjectTypeAndObjectHandle/{objectType}/{objectHandle}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectType | required | objectType | --- |
objectHandle | required | objectHandle | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetJobListByObjectTypeAndObjectIdJ/{objectType}/{objectHandle}/{clientZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectType | required | objectType | --- |
objectHandle | required | objectHandle | --- |
clientZoneOffset | required | client time Zone offset to be updated | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
type | required | type values are like esm or otn | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
type | required | type values are like esm or otn | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
esmBrowser/jobList/GetJobListJ/+5:30/esm
Produces
application/json
Example Response Data
{ "items": [ { "jobName": "NetworkDiscovery-Mon Feb 29 21:47:27 IST 2016", "jobId": 399, "description": null, "jobType": "Network - Discovery", "userName": "alcatel", "latestTaskStatus": "Complete - Success", "schedule": "2016-02-29 21:47:27", "nextTask": "--", "jobState": "Completed", "createTime": "2016-02-29 21:47:27", "lastModificationTime": "2016-03-01 00:05:01", "runsExecuted": 1, "className": "Job", "id": 399, "key": "Job/399" } ] }
External Docs
Operation
get /data/esmBrowser/jobList/GetJobListJson/{type}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
type | required | type | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
queryMap | optional | queryMap |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetJobRunTaskList/{clientZoneOffset}/{jobId}/{runId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobId | required | jobId Run GetJobListJ rest call to get jobId | --- |
runId | required | runId Run GetJobListJ rest call to get list of jobId and in list of jobId select required jobId. and run GetJobTaskListJ rest call to get list of RunId and in list of runId select required runId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/jobList/GetJobRunTaskList/{clientZoneOffset}/{jobId}/{runId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobId | required | jobId Run GetJobListJ rest call to get jobId | --- |
runId | required | runId Run GetJobListJ rest call to get list of jobId and in list of jobId select required jobId. and run GetJobTaskListJ rest call to get list of RunId and in list of runId select required runId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/jobList/GetJobRunTaskList/+5:30/111/1
Produces
application/xml
Example Response Data
<JobTaskListData> <jobTaskData> <duration>1861</duration> <endTime>2016-01-15 14:20:11</endTime> <jobId>885</jobId> <runId>1</runId> <startTime>2016-01-15 14:20:09</startTime> <status>Complete - Success</status> <taskId>885</taskId> <taskName>REST-N:11QPE24-1-10-LAG3</taskName> <taskType>LAG-Provisioning</taskType> </jobTaskData> </JobTaskListData>
External Docs
Operation
get /data/esmBrowser/jobList/GetJobTaskListJ/{clientZoneOffset}/{jobId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobId | required | jobId Run GetJobListJ rest call to get jobId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/GetJobTaskListJ/{clientZoneOffset}/{jobId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobId | required | jobId Run GetJobListJ rest call to get jobId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/jobList/GetJobTaskListJ/+5:30/111
Produces
application/json
Example Response Data
{ "jobTaskData": [ { "taskId": 885, "jobId": 885, "taskName": "REST-N:11QPE24-1-10-LAG3", "taskDetails": null, "status": "Complete - Success", "startTime": "2016-01-15 14:20:09", "endTime": "2016-01-15 14:20:11", "duration": 1861, "runId": 1, "taskType": "LAG-Provisioning" } ] }
External Docs
Operation
get /data/esmBrowser/jobList/GetLatestJobRunHistory/{objectType}/{objectHandle}/{clientZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectType | required | objectType | --- |
objectHandle | required | objectHandle | --- |
clientZoneOffset | required | client time Zone offset to be updated | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/GetLatestJobRunHistory/{objectType}/{objectHandle}/{clientZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectType | required | objectType | --- |
objectHandle | required | objectHandle | --- |
clientZoneOffset | required | client time Zone offset to be updated | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetRunHistoryForMultipleJobs/{objectHandle}/{clientZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectHandle | required | objectHandle | --- |
clientZoneOffset | required | client timeZone offset to be updated | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/GetRunHistoryForMultipleJobs/{objectHandle}/{clientZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
objectHandle | required | objectHandle | --- |
clientZoneOffset | required | client timeZone offset to be updated | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/GetTaskSummaryList/{clientZoneOffset}/{jobTaskId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobTaskId | required | jobTaskId Run GetJobTaskListJ rest call to get jobTaskId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/GetTaskSummaryList/{clientZoneOffset}/{jobTaskId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobTaskId | required | jobTaskId Run GetJobTaskListJ rest call to get jobTaskId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/jobList/GetTaskSummaryList/+5:30/111
Produces
application/json
Example Response Data
{ "items": [ { "label": "Disable PM", "taskDetail": "Disable PM", "startTime": "2016-01-15 14:20:09", "endTime": "2016-01-15 14:20:10", "duration": "422", "status": "Success", "errorReason": "", "id": "91863", "parent": null, "subTask": null, "hasChildren": true } ] }
External Docs
Operation
get /data/esmBrowser/jobList/GetTaskSummaryListWithRecentFirst/{clientZoneOffset}/{jobTaskId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
jobTaskId | required | jobTaskId Run GetJobTaskListJ rest call to get jobTaskId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobTaskSummaryListData
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/JobUserValidation/{jobId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobId | required | jobId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/esmBrowser/jobList/RescheduleJob/{jobName}/{taskName}/{triggerExpression}/{offset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobName | required | jobName Run GetJobListJ rest call to get jobName | --- |
taskName | required | taskName Use taskName as Reschedule or Run GetJobTaskListJ rest call to get jobTaskName | --- |
triggerExpression | required | triggerExpression value is next RescheduledTime. Time format should be YYYY-MM-DD_HH:MM:SS | --- |
offset | required | offset client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/jobList/RescheduleJob/{jobName}/{taskName}/{triggerExpression}/{offset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobName | required | jobName Run GetJobListJ rest call to get jobName | --- |
taskName | required | taskName Use taskName as Reschedule or Run GetJobTaskListJ rest call to get jobTaskName | --- |
triggerExpression | required | triggerExpression value is next RescheduledTime. Time format should be YYYY-MM-DD_HH:MM:SS | --- |
offset | required | offset client time Zone offset to be updated,the value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response Header Model
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/jobList/RescheduleJob/EPL_Reschedule_Thu%20Jul%2021%202016%2013:02:12%20UTC+5:30/Reschedule/2016-07-21_15:40:00/+5:30
Produces
application/json
Example Response Data
{ "req": null, "errorReason": null, "errorCode": null, "message": "EVPL_test_Thu Mar 03 2016 14:12:02 UTC+5:30", "cmdStatus": "Success", "opMsg": "", "msgCode": "JOB_RESCHEDULE_SUCCESS", "parameters": [], "paramCount": 0 }
External Docs
JobListData
Name |
Type |
Description |
Enum |
---|---|---|---|
items | array[JobUIData] JobUIData |
JobUIData | --- |
JobRunListData
Name |
Type |
Description |
Enum |
---|---|---|---|
jobRunData | array[JobRunUIData] JobRunUIData |
JobRunUIData | --- |
JobRunUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
runId | Long long |
runId | --- |
jobId | Long long |
jobId | --- |
jobName | String string |
JobName | --- |
jobDescription | String string |
Description | --- |
status | String string |
status | [Complete - Success, Complete - Partial, Complete - Failure, In-Progress, Scheduled, Aborted, Expired] |
startTime | String string |
StartTime | --- |
endTime | String string |
EndTime | --- |
duration | Long long |
duration | --- |
JobTaskListData
Name |
Type |
Description |
Enum |
---|---|---|---|
jobTaskData | array[JobTaskUIData] JobTaskUIData |
JobTaskUIData | --- |
items | array[JobTaskUIData] JobTaskUIData |
--- | --- |
JobTaskSummaryListData
Name |
Type |
Description |
Enum |
---|---|---|---|
items | array[JobTaskSummaryUIData] JobTaskSummaryUIData |
JobTaskSummaryUIData | --- |
identifier | String string |
Identifier | --- |
label | String string |
Label | --- |
JobTaskSummaryUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
label | String string |
Label | --- |
taskDetail | String string |
TaskDetails | --- |
startTime | String string |
StartTime | --- |
endTime | String string |
EndTime | --- |
duration | String string |
duration | --- |
status | String string |
status | [Complete - Success, Complete - Partial, Complete - Failure, In-Progress, Scheduled, Aborted, Expired] |
errorReason | String string |
ErrorReason | [created, success, failure, time-out, aborted, In-progress] |
id | String string |
Id | --- |
parent | String string |
Parent | --- |
subTask | String string |
subTask | --- |
esmVneLog | String string |
--- | --- |
hasChildren | Boolean boolean |
isHasChildren | --- |
className | String string |
--- | --- |
JobTaskUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
taskId | Long long |
TaskId | --- |
jobId | Long long |
jobId | --- |
taskName | String string |
TaskName | --- |
taskDetails | String string |
TaskDetails | --- |
status | String string |
status | [Complete - Success, Complete - Partial, Complete - Failure, In-Progress, Scheduled, Aborted, Expired] |
startTime | String string |
StartTime | --- |
endTime | String string |
EndTime | --- |
duration | Long long |
duration | --- |
runId | Long long |
runId | --- |
taskType | String string |
Task Type | [Combination of 'ObjectType-JobType', ex: Ring-Provisiong, Service-Provisiong, Lag-Back to allocate, etc.] |
id | String string |
--- | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
JobUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
jobName | String string |
JobName | --- |
jobId | Long long |
Job Id | --- |
description | String string |
Description | --- |
jobType | String string |
JobType | --- |
jobTypeStr | String string |
--- | --- |
userName | String string |
UserName | --- |
latestTaskStatus | String string |
LatestTaskStatus | --- |
schedule | String string |
schedule | --- |
nextTask | String string |
NextTask | --- |
jobState | String string |
JobState | [Scheduled, In-Progress, Aborted, Expired, Completed, Deleted] |
createTime | String string |
Create time | --- |
lastModificationTime | String string |
Modification time | --- |
runsExecuted | Long long |
RunsExecuted | --- |
objType | Long long |
--- | --- |
appType | String string |
--- | --- |
id | String string |
Id | --- |
key | String string |
key | --- |
className | String string |
ClassName | [Job] |
Response Header Model
Name |
Type |
Description |
Enum |
---|---|---|---|
req | Request Header Request Header |
req | --- |
errorReason | String string |
errorReason | [Error reason] |
errorCode | String string |
--- | --- |
message | String string |
--- | --- |
cmdStatus | String string |
cmdStatus | [Success, Failure, Timed-Out, Unknown] |
opMsg | String string |
Operation message | --- |
msgCode | String string |
msgCode | [Message code] |
parameters | array[String] string |
--- | --- |
paramCount | Integer integer |
parameter count returned in the response | --- |
objectId | Integer integer |
Object Id | --- |
jobName | String string |
Job Name | --- |
objectType | Integer integer |
Job Object TYpe | --- |