Operation
post /ason/schedule/reversionGroups/create
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | form | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
POST :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/create Payload:
{"Tag":createReversionGroup,"groupName":Group-T1,"sncIds":"1012,1038"}
Consumes
application/json
Produces
text/xml
application/json
Example Response Data
{ "ok": "true", "id": 3703771959946341, "responseMessage": "Successfully created group Group-T1", "responseList": "null", "HTTPResponse": "200", "httpresponse": "200" }
External Docs
Operation
post /data/npr/reversionGroups/create
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | form | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
POST :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/create payload: { "Tag":"createReversionGroup", "groupName":"Group-T1", "sncIds":"1012,1038" }
Consumes
application/json
Example Response Data
{ "ok":"true", "id":3703771959946341, "responseMessage":"Successfully created group Group-T1", "responseList":"null", "HTTPResponse":"200", "httpresponse":"200" }
Produces
text/xml
application/json
External Docs
Operation
delete /ason/schedule/reversionGroups/delete/{groupId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | groupId can retrieved from data/npr/reversionGroups | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
DELETE :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/delete/{groupId}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":3703771959946341, "responseMessage":"Reversion Group - RCG_AUTO_3 deleted successfully", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
delete /data/npr/reversionGroups/delete/{groupId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | groupId can retrieved from data/npr/reversionGroups | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
DELETE :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/delete/{groupId}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":3703771959946341, "responseMessage":"Reversion Group - RCG_AUTO_3 deleted successfully", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
get /ason/schedule/reversionGroups/detail/{groupId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | 'groupId' can be retrieved as 'id' retrieved from the REST call '/data/npr/reversionGroups/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ReversionGroupDetail]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
text/xml
application/json
External Docs
Operation
get /data/npr/reversionGroups/detail/{groupId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | 'groupId' can be retrieved as 'id' retrieved from the REST call '/data/npr/reversionGroups/name?name={jobname}' | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ReversionGroupDetail]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
GET :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/detail/{groupId}
Produces
text/xml
application/json
Example Response Data
[{ "id":"0", "guiLabel":null, "groupState":"null", "groupCreationTime":"null", "lastScanTime":"null", "lastConditionMet":"null", "aSncUserLabel":"AMX-infra-5-05-Gollum_AMX-06-Isildur_AMXMain", "bSncUserLabel":"AMX-infra-6-05-Gollum_AMX-06-Isildur_AMXMain", "lastOpOnSncA":"ReversionGroupOperation_S2N", "lastOpOnSncB":"ReversionGroupOperation_S2N", "aSncOpState":"ReversionOpState_SUCCESS", "bSncOpState":"ReversionOpState_SUCCESS", "aSnclastReversionTime":"1605847321000", "bSnclastReversionTime":"1605847681000", }]
External Docs
Operation
put /ason/schedule/reversionGroups/pause/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
POST :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/create
Consumes
application/json
Example Response Data
{ "ok":"true", "id":3703771959946341, "responseMessage":"Successfully paused Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
put /data/npr/reversionGroups/pause/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
PUT :https://{{serverIp}}:8443/oms1350/ason/schedule/reversionGroups/pause/{jobDetailsId}/{jobName}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":3703771959946341, "responseMessage":"Successfully paused Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
put /ason/schedule/reversionGroups/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
PUT :https://{{serverIp}}:8443/oms1350/ason/schedule/reversionGroups/{jobDetailsId}/{jobName}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":null, "responseMessage":"Successfully re-scheduled Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
put /data/npr/reversionGroups/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
text/xml
application/json
External Docs
Operation
put /ason/schedule/reversionGroups/resume/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
PUT :https://{{serverIp}}:8443/oms1350/ason/schedule/reversionGroups/resume/{jobDetailsId}/{jobName}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":null, "responseMessage":"Successfully resumed Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
put /data/npr/reversionGroups/resume/{jobDetailsId}/{jobName}
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}' | --- |
jobName | required | jobName | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | reversionScheduleInfo | String |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
PUT :https://{{serverIp}}:8443/oms1350/ason/schedule/reversionGroups/resume/{jobDetailsId}/{jobName}
Consumes
application/json
Example Response Data
{ "ok":"true", "id":null, "responseMessage":"Successfully resumed Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
Produces
text/xml
application/json
External Docs
Operation
get /ason/schedule/reversionGroups/triggerScan
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
inline_response_200
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
text/xml
application/json
External Docs
Operation
get /data/npr/reversionGroups/triggerScan
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | session | HttpSession |
--- |
body2 | optional | request | ServletWebRequest |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
inline_response_200
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
text/xml
application/json
External Docs
inline_response_200
Name |
Type |
Description |
Enum |
---|
ReversionGroupDetail
Name |
Type |
Description |
Enum |
---|---|---|---|
id | Long long |
--- | --- |
guiLabel | String string |
--- | --- |
groupState | String string |
--- | [ReversionGroupState_AVAILABLE, ReversionGroupState_INPROGRESS] |
groupCreationTime | Date DateTime |
--- | --- |
lastScanTime | Date DateTime |
--- | --- |
lastConditionMet | String string |
--- | [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE] |
aSncUserLabel | String string |
--- | --- |
bSncUserLabel | String string |
--- | --- |
lastOpOnSncA | String string |
--- | [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE] |
lastOpOnSncB | String string |
--- | [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE] |
aSncOpState | String string |
--- | [ReversionOpState_FAILED, ReversionOpState_SUCCESS, ReversionOpState_INPROGRESS] |
bSncOpState | String string |
--- | [ReversionOpState_FAILED, ReversionOpState_SUCCESS, ReversionOpState_INPROGRESS] |
aSnclastReversionTime | Date DateTime |
--- | --- |
bSnclastReversionTime | Date DateTime |
--- | --- |