Operation

post /ason/schedule/reversionGroups/create
description: Create Reversion Control Group (createReversionGroup : /ason/schedule/reversionGroups/create)
createReversionGroup

Request body

Name

IsRequired

Description

Data Type

Enum

body optional form String ---
body2 optional session HttpSession ---
body3 optional request ServletWebRequest ---

Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    post /data/npr/reversionGroups/create
    description: Create Reversion Control Group (createReversionGroup : /data/npr/reversionGroups/create)
    createReversionGroup

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional form String ---
    body2 optional session HttpSession ---
    body3 optional request ServletWebRequest ---

    Return type
  • NprResponse
  • 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
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Response Data
    { "ok":"true", "id":3703771959946341, "responseMessage":"Successfully created group Group-T1", "responseList":"null", "HTTPResponse":"200", "httpresponse":"200" }
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    delete /ason/schedule/reversionGroups/delete/{groupId}
    Delete Reversion Group (deleteReversionGroup : /ason/schedule/reversionGroups/delete/{groupId})
    deleteReversionGroup

    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
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    delete /data/npr/reversionGroups/delete/{groupId}
    Delete Reversion Group (deleteReversionGroup : /data/npr/reversionGroups/delete/{groupId})
    deleteReversionGroup

    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
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    DELETE :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/delete/{groupId}

    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Response Data
    { "ok":"true", "id":3703771959946341, "responseMessage":"Reversion Group - RCG_AUTO_3 deleted successfully", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /ason/schedule/reversionGroups/detail/{groupId}
    Get Reversion Group Details (getGroupDetails : /ason/schedule/reversionGroups/detail/{groupId})
    getGroupDetails

    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
  • Reversion Group Detail
  • Responses

    Response Messages

    Schema

    200success Reversion Group Detail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /data/npr/reversionGroups/detail/{groupId}
    Get Reversion Group Details (getGroupDetails : /data/npr/reversionGroups/detail/{groupId})
    getGroupDetails

    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
  • Reversion Group Detail
  • Responses

    Response Messages

    Schema

    200success Reversion Group Detail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET :https://{{serverIp}}:8443/oms1350/data/npr/reversionGroups/detail/{groupId}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • 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
    See Also :

    Operation

    put /ason/schedule/reversionGroups/pause/{jobDetailsId}/{jobName}
    Pause Reversion Group Job (pauseJob : /ason/schedule/reversionGroups/pause/{jobDetailsId}/{jobName})
    pauseJob

    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
  • NprResponse
  • 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
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Response Data
    { "ok":"true", "id":3703771959946341, "responseMessage":"Successfully paused Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /data/npr/reversionGroups/pause/{jobDetailsId}/{jobName}
    Pause Reversion Group Job (pauseJob : /data/npr/reversionGroups/pause/{jobDetailsId}/{jobName})
    pauseJob

    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
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /ason/schedule/reversionGroups/{jobDetailsId}/{jobName}
    Reshedule Reversion Group Job (rescheduleJob : /ason/schedule/reversionGroups/{jobDetailsId}/{jobName})
    rescheduleJob

    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
  • NprResponse
  • 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
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Response Data
    { "ok":"true", "id":null, "responseMessage":"Successfully re-scheduled Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /data/npr/reversionGroups/{jobDetailsId}/{jobName}
    Reshedule Reversion Group Job (rescheduleJob : /data/npr/reversionGroups/{jobDetailsId}/{jobName})
    rescheduleJob

    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
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /ason/schedule/reversionGroups/resume/{jobDetailsId}/{jobName}
    Resume Reversion Group Job (resumeJob : /ason/schedule/reversionGroups/resume/{jobDetailsId}/{jobName})
    resumeJob

    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
  • NprResponse
  • 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
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Response Data
    { "ok":"true", "id":null, "responseMessage":"Successfully resumed Reversion Control Job", "responseList":"null", "HTTPResponse":"0", "httpresponse":"0" }
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    put /data/npr/reversionGroups/resume/{jobDetailsId}/{jobName}
    Resume Reversion Group Job (resumeJob : /data/npr/reversionGroups/resume/{jobDetailsId}/{jobName})
    resumeJob

    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
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /ason/schedule/reversionGroups/triggerScan
    Trigger Scan (triggerScan : /ason/schedule/reversionGroups/triggerScan)
    triggerScan

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional session HttpSession ---
    body2 optional request ServletWebRequest ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    Operation

    get /data/npr/reversionGroups/triggerScan
    Trigger Scan (triggerScan : /data/npr/reversionGroups/triggerScan)
    triggerScan

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional session HttpSession ---
    body2 optional request ServletWebRequest ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    inline_response_200

    Name

    Type

    Description

    Enum

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean The Npr response is created successfully ---
    id String string The Response id ---
    responseMessage String string Response message for the request ---
    responseList array[Object] object The List of response ---

    Reversion Group Detail

    Name

    Type

    Description

    Enum

    id Long long Id (Identifier of the reversion group) ---
    guiLabel String string Group Name ---
    groupState String string Group State [ReversionGroupState_AVAILABLE, ReversionGroupState_INPROGRESS]
    groupCreationTime Date DateTime Group Creation Time ---
    lastScanTime Date DateTime Last Scan Time ---
    lastConditionMet String string Last Operation (recent operation performed on any of the SNC of the reversio group) [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE]
    aSncUserLabel String string SNC Name (name of the first SNC, which is part of the reversion group) ---
    bSncUserLabel String string SNC Name (name of the second SNC, which is part of the reversion group) ---
    lastOpOnSncA String string Last Operation performed on the first SNC of the reversion group [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE]
    lastOpOnSncB String string Last Operation performed on the second SNC of the reversion group [ReversionGroupOperation_S2N, ReversionGroupOperation_CC2N, ReversionGroupOperation_MODIFY_REROUTE]
    aSncOpState String string Last Reversion Operation State on first SNC [ReversionOpState_FAILED, ReversionOpState_SUCCESS, ReversionOpState_INPROGRESS]
    bSncOpState String string Last Reversion Operation State on second SNC [ReversionOpState_FAILED, ReversionOpState_SUCCESS, ReversionOpState_INPROGRESS]
    aSnclastReversionTime Date DateTime Last Reversion Operation performed time on first SNC ---
    bSnclastReversionTime Date DateTime Last Reversion Operation performed time on second SNC ---