Operation

get /eqm/Tp/All/{neGroupId}/{neId}
Retrieves all the TP Data for clicked Equipment (getAllTp : /eqm/Tp/All/{neGroupId}/{neId})
Each element in the list is a TP data.
tpAid:Port name.
tpRate:Port signal rate.
tpId:Id of the port in SNA DB.
primaryState:State of the Port.
ifType:Signal type.
displayNameWithBay:Full name of the port with shelf,slot,port.
loopback: feeding received signal back to the sender(communication between only one end point).
actualSignalType:Actual port signal type.
tpList:List of Termination point.
attributeNameValue:Attribute list with name and value

Path parameters

Name

IsRequired

Description

Enum

neGroupId required neGroupId ---
neId required neId ---

Return type
  • TpElement
  • Responses

    Response Messages

    Schema

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

    eqm/Tp/All/101/142

    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
    Example Response Data
    [ { tpAid: "EC-1-1-AUX" tpRate: "NA" tpId: "3334" primaryState: "OOS-MA" ifType: "DCN" displayNameWithBay: "EC-1-1-AUX" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "EC-1-1-CIT" tpRate: "NA" tpId: "3327" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-CIT" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "EC-1-1-ES1" tpRate: "NA" tpId: "3322" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-ES1" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, ( tpAid: "EC-1-1-ES2" tpRate: "NA" tpId: "3323" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-ES2" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-DCM" tpRate: "OTS" tpId: "3438" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-DCM" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-LINE" tpRate: "OTS" tpId: "3451" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-LINE" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-OSC" tpRate: "OTS" tpId: "3445" primaryState: "OOS-AUMA" ifType: "-" displayNameWithBay: "AHPHG-1-2-OSC" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-SIG" tpRate: "OTS" tpId: "3437" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-SIG" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null } ]

    External Docs
    See Also :

    Operation

    get /eqm/Tp/All/{neGroupId}/{neId}/{shelf}
    Retrieves all the TP Data for clicked Equipment (getAllTp : /eqm/Tp/All/{neGroupId}/{neId}/{shelf})
    Each element in the list is a TP data.
    tpAid:Port name.
    tpRate:Port signal rate.
    tpId:Id of the port in SNA DB.
    primaryState:State of the Port.
    ifType:Signal type.
    displayNameWithBay:Full name of the port with shelf,slot,port.
    loopback: feeding received signal back to the sender(communication between only one end point).
    actualSignalType:Actual port signal type.
    tpList:List of Termination point.
    attributeNameValue:Attribute list with name and value

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    shelf required shelf ---

    Return type
  • TpElement
  • Responses

    Response Messages

    Schema

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

    /eqm/Tp/All/101/142/SHELF-1

    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
    Example Response Data
    [ { tpAid: "EC-1-1-AUX" tpRate: "NA" tpId: "3334" primaryState: "OOS-MA" ifType: "DCN" displayNameWithBay: "EC-1-1-AUX" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "EC-1-1-CIT" tpRate: "NA" tpId: "3327" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-CIT" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "EC-1-1-ES1" tpRate: "NA" tpId: "3322" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-ES1" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "EC-1-1-ES2" tpRate: "NA" tpId: "3323" primaryState: "IS-NR" ifType: "DCN" displayNameWithBay: "EC-1-1-ES2" loopback: "-" actualSignalType: "-" tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-DCM" tpRate: "OTS" tpId: "3438" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-DCM" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-LINE" tpRate: "OTS" tpId: "3451" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-LINE" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-OSC" tpRate: "OTS" tpId: "3445" primaryState: "OOS-AUMA" ifType: "-" displayNameWithBay: "AHPHG-1-2-OSC" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-SIG" tpRate: "OTS" tpId: "3437" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-SIG" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null } ]

    External Docs
    See Also :

    Operation

    get /eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}
    Retrieves all the TP Data for clicked Equipment (getAllTp : /eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot})
    Each element in the list is a TP data.
    tpAid:Port name.
    tpRate:Port signal rate.
    tpId:Id of the port in SNA DB.
    primaryState:State of the Port.
    ifType:Signal type.
    displayNameWithBay:Full name of the port with shelf,slot,port.
    loopback: feeding received signal back to the sender(communication between only one end point).
    actualSignalType:Actual port signal type.
    tpList:List of Termination point.
    attributeNameValue:Attribute list with name and value

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    shelf required shelf ---
    slot required slot ---

    Return type
  • TpElement
  • Responses

    Response Messages

    Schema

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

    /eqm/Tp/All/101/142/SHELF-1/AHPHG-1-2

    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
    Example Response Data
    [ { tpAid: "AHPHG-1-2-DCM" tpRate: "OTS" tpId: "3438" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-DCM" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-LINE" tpRate: "OTS" tpId: "3451" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-LINE" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-OSC" tpRate: "OTS" tpId: "3445" primaryState: "OOS-AUMA" ifType: "-" displayNameWithBay: "AHPHG-1-2-OSC" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null }, { tpAid: "AHPHG-1-2-SIG" tpRate: "OTS" tpId: "3437" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-SIG" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null } ]

    External Docs
    See Also :

    Operation

    get /eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}/{subSlot}
    Retrieves all the TP Data for clicked Equipment (getAllTp : /eqm/Tp/All/{neGroupId}/{neId}/{shelf}/{slot}/{subSlot})
    Each element in the list is a TP data.
    tpAid:Port name.
    tpRate:Port signal rate.
    tpId:Id of the port in SNA D.
    primaryState:State of the Port.
    ifType:Signal type.
    displayNameWithBay:Full name of the port with shelf,slot,port.
    loopback: feeding received signal back to the sender(communication between only one end point).
    actualSignalType:Actual port signal type.
    tpList:List of Termination point.
    attributeNameValue:Attribute list with name and value

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    shelf required shelf ---
    slot required slot ---
    subSlot required subSlot ---

    Return type
  • TpElement
  • Responses

    Response Messages

    Schema

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

    /eqm/Tp/All/101/142/SHELF-1/AHPHG-1-2/AHPHG-1-2-LINE

    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
    Example Response Data
    [ { tpAid: "AHPHG-1-2-LINE" tpRate: "OTS" tpId: "3451" primaryState: "OOS-AU" ifType: "OTS" displayNameWithBay: "AHPHG-1-2-LINE" loopback: "-" actualSignalType: null tpList: null attributeNameValue: null } ]

    External Docs
    See Also :

    Operation

    get /eqm/Tp/ProvisioningInfo/{neGroupId}/{neId}/{ehName}/{sysDescr}/{sysMode}
    getAllTpProvisioningInfo (getAllTpProvisioningInfo : /eqm/Tp/ProvisioningInfo/{neGroupId}/{neId}/{ehName}/{sysDescr}/{sysMode})
    getAllTpProvisioningInfo

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    ehName required ehName ---
    sysDescr required sysDescr ---
    sysMode required sysMode ---

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

    External Docs
    See Also :

    Operation

    get /eqm/Tp/waveliteGridInfoUplink/{neGroupId}/{neId}/{ehName}/{sysDescr}/{sysMode}
    getAllUplinkData (getAllUplinkData : /eqm/Tp/waveliteGridInfoUplink/{neGroupId}/{neId}/{ehName}/{sysDescr}/{sysMode})
    getAllUplinkData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    ehName required ehName ---
    sysDescr required sysDescr ---
    sysMode required sysMode ---

    Return type
  • array[tempUplink]
  • Responses

    Response Messages

    Schema

    200success array[tempUplink]
    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 /eqm/Tp/waveliteGridInfoMux/{neGroupId}/{neId}/{ehName}
    getAllkMuxData (getAllkMuxData : /eqm/Tp/waveliteGridInfoMux/{neGroupId}/{neId}/{ehName})
    getAllkMuxData

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required neGroupId ---
    neId required neId ---
    ehName required ehName ---

    Return type
  • array[tempMux]
  • Responses

    Response Messages

    Schema

    200success array[tempMux]
    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 /eqm/Tp/getDDMAttr/{neId}/{neGrpId}/{portAid}/{paramName}
    getDDMEquipAttributeforEquipment (getDDMEquipAttributeforEquipment : /eqm/Tp/getDDMAttr/{neId}/{neGrpId}/{portAid}/{paramName})
    getDDMEquipAttributeforEquipment

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---
    neGrpId required neGrpId ---
    portAid required portAid ---
    paramName required paramName ---

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

    External Docs
    See Also :

    DsCommon_FTPname_T

    Name

    Type

    Description

    Enum

    neName String string --- ---
    ncName String string --- ---
    ftpName String string --- ---
    valid Boolean boolean --- ---

    DsCommon_TPname_T

    Name

    Type

    Description

    Enum

    neName String string --- ---
    ptpName String string --- ---
    ncName String string --- ---
    ctpName String string --- ---
    ftpName String string --- ---
    tcmName String string --- ---
    valid Boolean boolean --- ---

    DsCommon_TPPoolName_T

    Name

    Type

    Description

    Enum

    tpPoolName String string --- ---
    ncName String string --- ---
    subnetworkName String string --- ---
    valid Boolean boolean --- ---

    DsTPdata_Directionality_T

    Name

    Type

    Description

    Enum

    type Integer integer --- ---

    DsTPdata_LayeredParameterList_T

    Name

    Type

    Description

    Enum

    dsTPdata_LayeredParameterList_Telem array[DsTPdata_LayeredParameters_T] DsTPdata_LayeredParameters_T --- ---
    dsTPdata_LayeredParameterList_TelemCount Integer integer --- ---
    valid Boolean boolean --- ---

    DsTPdata_LayeredParameters_T

    Name

    Type

    Description

    Enum

    transmissionParams GlobalDefs_NVSList_T GlobalDefs_NVSList_T --- ---
    layer Integer integer --- ---
    valid Boolean boolean --- ---

    DsTPdata_TerminationMode_T

    Name

    Type

    Description

    Enum

    type Integer integer --- ---

    DsTPdata_TerminationPoint_T

    Name

    Type

    Description

    Enum

    tpplName DsCommon_TPPoolName_T DsCommon_TPPoolName_T --- ---
    additionalInfo GlobalDefs_NVSList_T GlobalDefs_NVSList_T --- ---
    frequency String string --- ---
    connectionState DsTPdata_TPConnectionState_T DsTPdata_TPConnectionState_T --- ---
    userLabel String string --- ---
    tpName DsCommon_TPname_T DsCommon_TPname_T --- ---
    direction DsTPdata_Directionality_T DsTPdata_Directionality_T --- ---
    nativeName String string --- ---
    cardName String string --- ---
    transmissionParams DsTPdata_LayeredParameterList_T DsTPdata_LayeredParameterList_T --- ---
    ftpName DsCommon_FTPname_T DsCommon_FTPname_T --- ---
    tpMappingMode DsTPdata_TerminationMode_T DsTPdata_TerminationMode_T --- ---
    tpProtectionAssociation DsTPdata_TPProtectionAssociation_T DsTPdata_TPProtectionAssociation_T --- ---
    edgePoint Boolean boolean --- ---
    slotId String string --- ---
    owner String string --- ---
    type DsTPdata_TPType_T DsTPdata_TPType_T --- ---
    valid Boolean boolean --- ---

    DsTPdata_TPConnectionState_T

    Name

    Type

    Description

    Enum

    type Integer integer --- ---

    DsTPdata_TPProtectionAssociation_T

    Name

    Type

    Description

    Enum

    type Integer integer --- ---

    DsTPdata_TPType_T

    Name

    Type

    Description

    Enum

    type Integer integer --- ---

    GlobalDefs_NameAndValueString_T

    Name

    Type

    Description

    Enum

    valid Boolean boolean --- ---
    name String string --- ---
    value String string --- ---

    GlobalDefs_NVSList_T

    Name

    Type

    Description

    Enum

    globalDefs_NVSList_Telem array[GlobalDefs_NameAndValueString_T] GlobalDefs_NameAndValueString_T --- ---
    globalDefs_NVSList_TelemCount Integer integer --- ---
    valid Boolean boolean --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    NVSList_Telem

    Name

    Type

    Description

    Enum

    valid Boolean boolean --- ---
    name String string --- ---
    value String string --- ---

    Status

    Name

    Type

    Description

    Enum

    opStatus String string Operation Status ---
    msg String string Operation Message ---

    tempMux

    Name

    Type

    Description

    Enum

    channel String string --- ---
    wavelength String string --- ---

    tempUplink

    Name

    Type

    Description

    Enum

    port String string --- ---
    service String string --- ---
    value String string --- ---

    TpElement

    Name

    Type

    Description

    Enum

    tpAid String string --- ---
    tpRate String string --- ---
    tpId String string --- ---
    primaryState String string --- ---
    ifType String string --- ---
    displayNameWithBay String string --- ---
    loopback String string --- ---
    actualSignalType String string --- ---
    tpList array[TpElement] TpElement --- ---
    attributeNameValue array[NVSList_Telem] NVSList_Telem --- ---