Operation

get /data/common/acd/{nmsInstance}
getACDForUser (getACDForUser : /data/common/acd/{nmsInstance})
getACDForUser

Path parameters

Name

IsRequired

Description

Enum

nmsInstance required nmsInstance ---

Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/common/acd
    getACDForUserOTNE (getACDForUserOTNE : /data/common/acd)
    getACDForUserOTNE


    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /getAllActiveWebSessions
    getAllActiveWebSessions (getAllActiveWebSessions : /getAllActiveWebSessions)
    getAllActiveWebSessions

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional zicWebsessions List[Entry«string,Map«string,string»»] ---

    Return type
  • List[Entry«string,Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,Map«string,string»»]
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/common/userchannel/
    Get userChannel for user (getChannelForUser : /data/common/userchannel/)
    getChannelForUser


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{{serverIp}}:8443/oms1350/data/common/userchannel/

    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.
    • application/text
    Example Response Data
    Response: L29tc2V2ZW50cy91c2Vzc2lvbi9hMmZkMWQ1YzE0ZTQ0OTM2YWQ2ZWY5NmMxMGMzNjk5OQ==

    External Docs
    See Also :

    Operation

    get /data/common/server/timezone
    Get server timezone for requested user (forceClientTZ property should be set in the System) (getServerTimeZone : /data/common/server/timezone)
    getServerTimeZone


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{{serverIp}}:8443/oms1350/data/common/server/timezone

    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.
    • application/text
    Example Response Data
    Response: Asia/Kolkata

    External Docs
    See Also :

    Operation

    get /data/common/server/timezoneoffset
    getServerTimeZoneOffset (getServerTimeZoneOffset : /data/common/server/timezoneoffset)
    getServerTimeZoneOffset


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • application/text

    External Docs
    See Also :

    Operation

    get /data/common/sessionInfo
    getUserSession (getUserSession : /data/common/sessionInfo)
    getUserSession

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional session HttpSession ---

    Return type
  • UserSession
  • Responses

    Response Messages

    Schema

    200success UserSession
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /getValidZicWebSessions
    getValidZicWebSessions (getValidZicWebSessions : /getValidZicWebSessions)
    getValidZicWebSessions

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional zicWebsessions List[Entry«string,Map«string,string»»] ---

    Return type
  • List[Entry«string,Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,Map«string,string»»]
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /common/navtarget
    getZicTarget (getZicTarget : /common/navtarget)
    getZicTarget

    Query parameters

    Name

    IsRequired

    Description

    service required navMsg

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/x-www-form-urlencoded
    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/plain

    External Docs
    See Also :

    Operation

    post /validateWebSessionToken
    isaValidZicRequest (isaValidZicRequest : /validateWebSessionToken)
    isaValidZicRequest

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional sessionToken String ---

    Return type
  • HashMap«string,string»
  • Responses

    Response Messages

    Schema

    200success HashMap«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • text/plain
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /mainOtn/nspNav
    NSPnavigate (nSPnavigate : /mainOtn/nspNav)
    NSPnavigate


    Return type
  • DeferredResult«string»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«string»
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /navigate
    navigate (navigate : /navigate)
    navigate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional navMsg NavMessage ---

    Return type
  • DeferredResult«NavResult»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«NavResult»
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /neWebUINavigate
    neWebUINavigate (neWebUINavigate : /neWebUINavigate)
    neWebUINavigate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional navMsg NavMessage ---

    Return type
  • NavResult
  • Responses

    Response Messages

    Schema

    200success NavResult
    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.
    • application/json

    External Docs
    See Also :

    Operation

    post /reverseNavFromZic
    reverseNavFromZic (reverseNavFromZic : /reverseNavFromZic)
    reverseNavFromZic

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional postattributes String ---

    Return type
  • HashMap«string,string»
  • Responses

    Response Messages

    Schema

    200success HashMap«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • text/plain
    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.
    • application/json

    External Docs
    See Also :

    Operation

    get /mainOtn/extNavTest
    SAMnavTest (sAMnavTest : /mainOtn/extNavTest)
    SAMnavTest


    Responses

    Response Messages

    Schema

    200OK ---
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /mainOtn/extNav
    SAMnavigate (sAMnavigate : /mainOtn/extNav)
    SAMnavigate


    Return type
  • DeferredResult«string»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«string»
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /isawebnav
    webnavigate (webnavigate : /isawebnav)
    webnavigate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional navMsg NavMessage ---

    Return type
  • NavResult
  • Responses

    Response Messages

    Schema

    200success NavResult
    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.
    • application/json

    External Docs
    See Also :

    DeferredResult«NavResult»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    DeferredResult«string»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    Entry«string,Map«string,string»»

    Name

    Type

    Description

    Enum

    key Object object --- ---

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    NavMessage

    Name

    Type

    Description

    Enum

    target String string --- ---
    service String string --- ---
    parameters Object object --- ---

    NavResult

    Name

    Type

    Description

    Enum

    result String string --- ---

    UserSession

    Name

    Type

    Description

    Enum

    userId String string --- ---
    sessionId String string --- ---
    channelName String string --- ---
    fadList array[String] string --- ---
    nadString String string --- ---
    userNadRole String string --- ---

    Void

    Name

    Type

    Description

    Enum