Operation

post /data/npr/sharedRiskGroups
createSRG (createSRG : /data/npr/sharedRiskGroups)
createSRG

Request body

Name

IsRequired

Description

Data Type

Enum

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

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
    Example Request Data

    Rest call: /data/npr/sharedRiskGroups Request Payload: Example of SRG creation Request { "Tag": "createSrg", "userLabel": "SRG_1", "type": "SrgType_cable", "prob": "SrgProb_veryHigh", "comment": "Shared Risk Group 1", "aSite": "BA", "zSite": "MH" } Response { "ok": true, "id": "12", "responseMessage": null, "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
    Example Response Data
    Response: { "ok": true, "id": "37950051147750", "responseMessage": null, "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }

    External Docs
    See Also :

    Operation

    delete /data/npr/sharedRiskGroups/{srgId}
    deleteSRG (deleteSRG : /data/npr/sharedRiskGroups/{srgId})
    deleteSRG

    Path parameters

    Name

    IsRequired

    Description

    Enum

    srgId required srgId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • AsonResponseAwareNprResponse
  • Responses

    Response Messages

    Schema

    200success AsonResponseAwareNprResponse
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    Rest call: /data/npr/sharedRiskGroups/12 Request Payload: {"userLabel":"SRGCR"} The SRG id can be obtained from Request --> /data/npr/sharedRiskGroups?guiLabel=SRG_1 Response --> [ { "IdClass": 125, "aSite": "BA", "srgComment": "Shared Risk Group 1", "id": 12, "key": "SharedRiskGroup/12", "className": "SharedRiskGroup", "srgProbability": "SrgProb_veryHigh", "srgType": "SrgType_cable", "guiLabel": "SRG_1", "zSite": "MH" } ]

    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
    Response: { "ok": true, "id": null, "responseMessage": null, "responseList": [ { "requestType": "Info", "messagetag": "TDMmsg_95_73", "errorMsgData": [ null ], "requestStatus": "Success" } ], "HTTPResponse": 0, "asonResponseList": [ { "requestType": "Info", "messagetag": "TDMmsg_95_73", "errorMsgData": [ null ], "requestStatus": "Success" } ], "requestStatus": "Success", "eventableObjects": {}, "httpresponse": 0 }

    External Docs
    See Also :

    Operation

    put /data/npr/sharedRiskGroups/{srgId}
    modifySRG (modifySRG : /data/npr/sharedRiskGroups/{srgId})
    modifySRG

    Path parameters

    Name

    IsRequired

    Description

    Enum

    srgId required srgId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

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

    Return type
  • AsonResponseAwareNprResponse
  • Responses

    Response Messages

    Schema

    200success AsonResponseAwareNprResponse
    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 :

    AsonResponse

    Name

    Type

    Description

    Enum

    requestType String string --- [Info, Warning, Error]
    messagetag String string --- ---
    errorMsgData array[String] string --- ---
    requestStatus String string --- [Executing, Success, Failed, SuccessWithWarnings, PartiallyFailed, Removed, FailedForTimeout]

    AsonResponseAwareNprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---
    asonResponseList array[AsonResponse] AsonResponse --- ---
    requestStatus String string --- [Executing, Success, Failed, SuccessWithWarnings, PartiallyFailed, Removed, FailedForTimeout]
    eventableObjects array[Entry«string,List«Map«string,object»»»] Entry«string,List«Map«string,object»»» --- ---

    Entry«string,List«Map«string,object»»»

    Name

    Type

    Description

    Enum

    key array[Map«string,object»] Map«string,object» --- ---

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---