Operation
delete /data/otn/delete/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
clean | optional | clean |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /data/otn/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /otn/schedule/delete/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
clean | optional | clean |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /otn/schedule/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /data/otn/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
delete /otn/schedule/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
get /data/otn/job/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/job/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/job/name
Query parameters
Name |
IsRequired |
Description |
---|---|---|
name | required | 'jobname' is the name of the job for which the details shall be retrieved. |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /otn/schedule/job/name
Query parameters
Name |
IsRequired |
Description |
---|---|---|
name | required | 'jobname' is the name of the job for which the details shall be retrieved. |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
GET: https://{{serverIp}}:8443/oms1350/otn/schedule/job/name?name=Baseline_Job_11_28_47
Produces
*/*
Example Response Data
{ "id":848, "jobName":"Baseline_Job_11_28_47", "qrtzJobName":"OTDR-SCAN-JOB", "qrtzJobGroup":"OTDR-SCAN-JOB-ALU-OMS-QRTZ-JOB-GROUP", "qrtzTriggerName":"Baseline_Job_11_28_47", "qrtzTriggerGroup":"Baseline_Job_11_28_47-ALU-OMS-QRTZ-TRIGGER-GROUP", "nextFireTime":1591251600000, "repeatCountMax":0, "executions":0, "jobDetailState":"SCHEDULED", "endsOn":null, "scheduledDetails":"{\"startDate\":\"2020-06-04\",\"startTime\":\"06:20:00\",\"frequency\":{\"weekdays\":null,\"type\":\"ONCE\",\"frequency\":0,\"frequency2\":0},\"ends\":{\"type\":\"NEVER\",\"repeat\":0,\"endDate\":null,\"endTime\":null},\"jobDetails\":{\"schedulerData\":{\"entityType\":null,\"groupId\":null,\"neId\":null,\"entityName\":null,\"paramList\":[{\"name\":\"otdrScanProfileId\",\"value\":\"PROFILE1\",\"isModified\":true},{\"name\":\"otdrScanZEndProfileId\",\"value\":\"PROFILE1\",\"isModified\":true}],\"paramListAsMap\":{\"otdrScanZEndProfileId\":{\"name\":\"otdrScanZEndProfileId\",\"value\":\"PROFILE1\",\"isModified\":true},\"otdrScanProfileId\":{\"name\":\"otdrScanProfileId\",\"value\":\"PROFILE1\",\"isModified\":true}}},\"jobData\":{\"OTDR_SCAN_TRIGGERED_USER\":\"alcatel\",\"scheduleMode\":\"schedule\",\"baselineScan\":\"true\"},\"jobDetailsMap\":[{\"key\":\"baselineScan\",\"value\":\"true\",\"state\":null},{\"key\":\"jobType\",\"value\":\"Scheduled Baseline\",\"state\":null},{\"key\":\"OTDR-PHYSICAL-CONNECTION\",\"value\":\"41\",\"state\":null},{\"key\":\"OTDR-PHYSICAL-CONNECTION-NAME\",\"value\":\"Otdr_OTS1:Shelf18:4Ended:213:18/7--213:18/5\",\"state\":null},{\"key\":\"OTDR_PORT_NAME-ZARX\",\"value\":\"IROADM-18-7-OTDRRX\",\"state\":null},{\"key\":\"SCAN_PORT-ZARX\",\"value\":\"IROADM-18-7-OTDRRX\",\"state\":null},{\"key\":\"OTDR_PORT_NAME_DEST-ZARX\",\"value\":\"IROADM-18-5-OTDRTX\",\"state\":null},{\"key\":\"OTDR_PORT_GRP_NAME_SRC-ZARX\",\"value\":\"101\",\"state\":null},{\"key\":\"OTDR_PORT_NE_ID_SRC-ZARX\",\"value\":\"1\",\"state\":null},{\"key\":\"OTDR_PORT_OTNNE_ID_SRC-ZARX\",\"value\":\"23\",\"state\":null},{\"key\":\"OTDR_PORT_NE_NAME_SRC-ZARX\",\"value\":\"PHN_56_212\",\"state\":null},{\"key\":\"OTDR_PORT_NE_ID_DEST-ZARX\",\"value\":\"2\",\"state\":null},{\"key\":\"OTDR_PORT_OTNNE_ID_DEST-ZARX\",\"value\":\"25\",\"state\":null},{\"key\":\"OTDR_PORT_NE_NAME_DEST-ZARX\",\"value\":\"PHN_56_213\",\"state\":null},{\"key\":\"OTDR_PORT_DIRECTION-ZARX\",\"value\":\"ZARX\",\"state\":null},{\"key\":\"OTDR_PORT_CONNECTED_OTDR_PORT_NAME-ZARX\",\"value\":\"OTDR-2-18-6-P5\",\"state\":null},{\"key\":\"OTDR_JOBCONFIG_SUFFIX_CSV\",\"value\":\"ZARX,\",\"state\":null},{\"key\":\"OTDR_PORT_OTNNE_ID_SRC\",\"value\":\"23\",\"state\":null},{\"key\":\"OTDR_PORT_NE_NAME_SRC\",\"value\":\"PHN_56_212\",\"state\":null},{\"key\":\"OTDR_PORT_OTNNE_ID_DEST\",\"value\":\"25\",\"state\":null},{\"key\":\"OTDR_PORT_NE_NAME_DEST\",\"value\":\"PHN_56_213\",\"state\":null}],\"jobName\":\"Baseline_Job_11_28_47\"},\"persist\":true,\"jobCode\":1,\"objectHandleId\":null,\"rescheduledCompleted\":false}", "createdAt":1591250162127, "version":1, "jobCode":1, "jobListHandle":1548, "objectHandleId":41 }
External Docs
Operation
get /data/otn/job/{jobDetailsId}/config
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/job/{jobDetailsId}/config
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/history/{jobHistoryId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistory
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/history/{jobHistoryId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistory
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/history/{jobHistoryId}/config
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistoryConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/history/{jobHistoryId}/config
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistoryConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
Operation
head /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
patch /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
options /data/otn/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
get /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
Operation
head /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
delete /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
patch /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
options /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neID | required | 'neID' is the id of the network element on which OTDR port rests.'neID' can be retrieved as the value, of the key 'OTDR_PORT#_NE_ID (#=1,2,3,4)' in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
grpID | required | 'grpID' is the id of the group of OTDR port.'grpID' can be retrieved as the value, of the key OTDR_PORT#_GRP_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST /job/{jobDetailsId} | --- |
ptpName | required | 'ptpName' is the name of the OTDR port used.This can be retrieved as the value of the key OTDR_PORT#_NAME (#=1,2,3,4) in the scheduledDetails.jobDetailsMap part of the response of REST '/job/{jobDetailsId}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
get /data/otn/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
Operation
get /otn/schedule/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
Operation
get /data/otn/otdr/file/{fileName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
fileName | required | fileName | --- |
Responses
Response Messages |
Schema |
---|---|
200OK | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /otn/schedule/otdr/file/{fileName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
fileName | required | fileName | --- |
Responses
Response Messages |
Schema |
---|---|
200OK | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/otn/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
External Docs
Operation
get /otn/schedule/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
application/xml
External Docs
Operation
get /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Operation
head /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
put /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
post /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
delete /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
patch /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
options /data/otn/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
get /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Operation
head /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
put /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
post /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
delete /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
patch /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
options /otn/schedule/otdrscaninfo/darkfiber/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a darkfiber connection which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
get /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
oms1350/data/otn/otdrscaninfo/physicalconn/26
Produces
application/json
Example Response Data
{ "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461130800399 "className": "OTDRScan" "id": 50 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461130800580 "key": "OTDRScan/50" }- 1: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461130800342 "className": "OTDRScan" "id": 52 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461130800536 "key": "OTDRScan/52" }- 2: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461130800159 "className": "OTDRScan" "id": 49 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461130800399 "key": "OTDRScan/49" }- 3: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461130800159 "className": "OTDRScan" "id": 51 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461130800342 "key": "OTDRScan/51" }- 4: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460619601106 "className": "OTDRScan" "id": 22 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460619601358 "key": "OTDRScan/22" }- 5: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460619601058 "className": "OTDRScan" "id": 24 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460619601280 "key": "OTDRScan/24" }- 6: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460619600512 "className": "OTDRScan" "id": 21 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460619601106 "key": "OTDRScan/21" }- 7: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460619600512 "className": "OTDRScan" "id": 23 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460619601056 "key": "OTDRScan/23" }- 8: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461163200510 "className": "OTDRScan" "id": 56 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461163200828 "key": "OTDRScan/56" }- 9: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461163200490 "className": "OTDRScan" "id": 54 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461163200811 "key": "OTDRScan/54" }- 10: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461163200200 "className": "OTDRScan" "id": 53 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461163200490 "key": "OTDRScan/53" }- 11: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461163200200 "className": "OTDRScan" "id": 55 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461163200510 "key": "OTDRScan/55" }- 12: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461076800414 "className": "OTDRScan" "id": 48 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461076800612 "key": "OTDRScan/48" }- 13: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461076800358 "className": "OTDRScan" "id": 46 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461076800560 "key": "OTDRScan/46" }- 14: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461076800168 "className": "OTDRScan" "id": 47 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461076800414 "key": "OTDRScan/47" }- 15: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461076800166 "className": "OTDRScan" "id": 45 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461076800358 "key": "OTDRScan/45" }- 16: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461057000617 "className": "OTDRScan" "id": 42 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461057000850 "key": "OTDRScan/42" }- 17: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461057000576 "className": "OTDRScan" "id": 44 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1461057000800 "key": "OTDRScan/44" }- 18: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461057000219 "className": "OTDRScan" "id": 43 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461057000574 "key": "OTDRScan/43" }- 19: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1461057000219 "className": "OTDRScan" "id": 41 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1461057000616 "key": "OTDRScan/41" }- 20: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460965800486 "className": "OTDRScan" "id": 38 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460965800786 "key": "OTDRScan/38" }- 21: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460965800449 "className": "OTDRScan" "id": 40 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460965800662 "key": "OTDRScan/40" }- 22: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460965800198 "className": "OTDRScan" "id": 37 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460965800486 "key": "OTDRScan/37" }- 23: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460965800198 "className": "OTDRScan" "id": 39 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460965800449 "key": "OTDRScan/39" }- 24: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460879400439 "className": "OTDRScan" "id": 34 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460879400656 "key": "OTDRScan/34" }- 25: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460879400430 "className": "OTDRScan" "id": 36 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460879400681 "key": "OTDRScan/36" }- 26: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460879400165 "className": "OTDRScan" "id": 35 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460879400430 "key": "OTDRScan/35" }- 27: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460879400165 "className": "OTDRScan" "id": 33 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460879400439 "key": "OTDRScan/33" }- 28: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460793001416 "className": "OTDRScan" "id": 32 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460793001631 "key": "OTDRScan/32" }- 29: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460793001390 "className": "OTDRScan" "id": 30 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460793001584 "key": "OTDRScan/30" }- 30: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460793000508 "className": "OTDRScan" "id": 29 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460793001388 "key": "OTDRScan/29" }- 31: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460793000508 "className": "OTDRScan" "id": 31 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460793001405 "key": "OTDRScan/31" }- 32: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460706600377 "className": "OTDRScan" "id": 26 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460706600594 "key": "OTDRScan/26" }- 33: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460706600348 "className": "OTDRScan" "id": 28 "portLabel": "ASWG-1-3-OTDRRX" "endTime": 1460706600541 "key": "OTDRScan/28" }- 34: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460706600148 "className": "OTDRScan" "id": 25 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460706600377 "key": "OTDRScan/25" }- 35: { "fileName": null "comments": "MODIFY Scan cannot be started" "notes": null "failureReason": null "startTime": 1460706600148 "className": "OTDRScan" "id": 27 "portLabel": "ASWG-1-3-OTDRTX" "endTime": 1460706600348 "key": "OTDRScan/27" }
Operation
head /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
put /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
post /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
delete /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
patch /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
options /data/otn/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
get /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Operation
head /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
put /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
post /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Operation
delete /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
patch /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
options /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
physConnId | required | 'physConnID' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetailConfiguration
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
Operation
get /data/otn/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
page | required | 'page' is the page number specified by user. | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /otn/schedule/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
page | required | 'page' is the page number specified by user. | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/otn/otdr/scanjob/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' for the required job name from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrJobListBean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /otn/schedule/otdr/scanjob/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' for the required job name from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrJobListBean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
post /data/otn/otdr/file
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
operation | required | Operation to be performed (download/delete) |
filename | optional | 'filename' can be retrieved from REST '/otdrscaninfo/physicalconn/{physConnId}' |
runId | optional | runId can be retrieved as 'id' from REST /otdrscaninfo/physicalconn/{physConnId}' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /otn/schedule/otdr/file
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | httpSession | HttpSession |
--- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
operation | required | Operation to be performed (download/delete) |
filename | optional | 'filename' can be retrieved from REST '/otdrscaninfo/physicalconn/{physConnId}' |
runId | optional | runId can be retrieved as 'id' from REST /otdrscaninfo/physicalconn/{physConnId}' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
get /data/otn/{jobDetailsId}/history/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' from the REST '/otn/schedule/job/name' | --- |
page | required | 'page' is the page number specified by user. | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistory
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/{jobDetailsId}/history/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' from the REST '/otn/schedule/job/name' | --- |
page | required | 'page' is the page number specified by user. | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistory
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/history/{jobHistoryId}/runs/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize} | --- |
page | required | 'page' is the page number specified by the user | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistoryRunDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/history/{jobHistoryId}/runs/{page}/{pageSize}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHistoryId | required | 'jobHistoryId' can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize} | --- |
page | required | 'page' is the page number specified by the user | --- |
pageSize | required | 'pageSize' is the size of the page to be displayed | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JobHistoryRunDetails
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/job/{jobDetailsId}/schedules/{numOfSchedules}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
numOfSchedules | required | The 'numOfSchedules' is the number of next fire times user needs.It can take values of 1,2,3...etc. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /otn/schedule/job/{jobDetailsId}/schedules/{numOfSchedules}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
numOfSchedules | required | The 'numOfSchedules' is the number of next fire times user needs.It can take values of 1,2,3...etc. | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
Operation
get /data/otn/otdr/physconn/job/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' for the required job name from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrJobListBean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /otn/schedule/otdr/physconn/job/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' for the required job name from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrJobListBean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
put /data/otn/pause/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /otn/schedule/pause/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /data/otn/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | jobScheduleWrapperConfig | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /otn/schedule/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | jobScheduleWrapperConfig | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /data/otn/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
put /otn/schedule/otdr/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
put /data/otn/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /otn/schedule/otdr/joblist/{jobHandleId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobHandleId | required | 'jobHandleId' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /data/otn/otdr/darkfiber/joblist/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
put /otn/schedule/otdr/darkfiber/joblist/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
put /data/otn/resume/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
put /otn/schedule/resume/{jobDetailsId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
jobDetailsId | required | 'jobDetailsId' can be retrieved as 'id' retrieved from the REST call '/otn/schedule/job/name' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /data/otn/{quartzJobName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
quartzJobName | required | quartzJobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | jobScheduleWrapperConfig | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
post /otn/schedule/{quartzJobName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
quartzJobName | required | quartzJobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | jobScheduleWrapperConfig | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
External Docs
Operation
post /data/otn/otdr
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /otn/schedule/otdr
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /data/otn/otdr/darkfiber
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
Operation
post /otn/schedule/otdr/darkfiber
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | otdrScanInfo | String |
--- |
body2 | optional | httpSession | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
application/xml
JobDetails
Name |
Type |
Description |
Enum |
---|---|---|---|
id | Long long |
id can be retrieved from the REST call '/otn/schedule/job/name?name={jobname}' | --- |
jobName | String string |
User specified name of the job | --- |
qrtzJobName | String string |
Specifies type of job as in quartz framework like 'OTDR-SCAN-JOB' for OTDR | --- |
qrtzJobGroup | String string |
Specifies the Quartz Group of the job, default group name would be qrtzJobName + -ALU-OMS-QRTZ-JOB-GROUP | --- |
qrtzTriggerName | String string |
Specifies the Quartz Trigger name defaulted to jobName | --- |
qrtzTriggerGroup | String string |
Specifies the Quartz Trigger Group,default group name would be qrtzTriggerName + -ALU-OMS-QRTZ-JOB-GROUP | --- |
nextFireTime | Date DateTime |
Specifies the next job runtime | --- |
repeatCountMax | Long long |
Specifies the number of repititions of the job which depends on frequency:'type' and ends:'type' of the job | --- |
executions | Long long |
Specifies the number of executions completed | --- |
jobDetailState | String string |
Specifies the current state of the job | [SCHEDULED, COMPLETE, PAUSED, DELETED, INPROGRESS, FAILED] |
endsOn | Date DateTime |
Specifies the end date based on ends 'type' of the job (null if ends type is No of Events,Never or user specified end date if otherwise | --- |
scheduledDetails | String string |
Specifies various details of the scheduled job | --- |
createdAt | Date DateTime |
Specifies the creation date of the job | --- |
version | Integer integer |
Version | --- |
jobCode | Long long |
Specifies the quartz job code for the job like '1' for 'OTDR-SCAN-JOB' | --- |
jobListHandle | Long long |
'jobListHandle' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobList/{clientZoneOffset}' | --- |
objectHandleId | Long long |
'objectHandleId' can be retrieved as 'id' from the REST call 'data/npr/physicalConns' | --- |
JobHistory
Name |
Type |
Description |
Enum |
---|---|---|---|
id | Long long |
Specifies the historyId retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
jobDetails | JobDetails JobDetails |
Specifies the details of the job | --- |
startTime | Date DateTime |
Specifies the start time of the job in the format HH:MM:SS | --- |
endTime | Date DateTime |
Specifies the end time of the job in the format HH:MM:SS | --- |
previousFireTime | Date DateTime |
Specifies the start time of the previous run of the job | --- |
scheduledStartTime | Date DateTime |
Specifies the start time of the very first schedule of the job | --- |
jobHistoryStatus | String string |
Specifies the status of the latest run of the job | [IN_PROGRESS, SUCCESS, FAILURE, PARTIALLY_FAILED, MISFIRED, STOPPED, OTHER] |
failureReason | String string |
Specifies the failure reason if any,for the latest run of the job (will be null otherwise) | --- |
notes | String string |
Specifies the notes if any, for the latest run of the job (will be null otherwise) | --- |
poll | Boolean boolean |
Indicates if the job is polled or not | --- |
jobPollHistory | JobPollHistory JobPollHistory |
Indicates the poll history of the job | --- |
statusDesc | String string |
Status Description | --- |
version | Integer integer |
Version | --- |
JobHistoryRunDetails
Name |
Type |
Description |
Enum |
---|---|---|---|
id | Long long |
Specifies the jobHistoryId which can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' | --- |
jobHistory | JobHistory JobHistory |
Specifies the History of the job | --- |
name | String string |
Name | --- |
input | String string |
Input | --- |
ouput | String string |
Output | --- |
inputClass | String string |
InputClass | --- |
outputClass | String string |
OutputClass | --- |
createdAt | Date DateTime |
CreatedAt | --- |
version | Integer integer |
Version | --- |
endTime | Date DateTime |
EndTime | --- |
OtdrResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
statusCode | Integer integer |
Specifies the status of the request---Example:200 for success | --- |
message | String string |
Specifies the response message if any, for the request---Example:Scan scheduled successfully. | --- |
responseObject | Object object |
Specifies the response object for the request | --- |
Void
Name |
Type |
Description |
Enum |
---|