Operation

post /esmSync/GetSyncStatus
getSyncStatus (getSyncStatus : /esmSync/GetSyncStatus)
getSyncStatus

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData ESMSyncReqRespList ---

Return type
  • ESMSyncReqRespList
  • Responses

    Response Messages

    Schema

    200success ESMSyncReqRespList
    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 /esmSync/LAGSync/{neName}
    LAGSyncNeName (lAGSyncNeName : /esmSync/LAGSync/{neName})
    LAGSyncNeName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---

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

    External Docs
    See Also :

    Operation

    get /esmSync/OAMSync
    OAMSync (oAMSync : /esmSync/OAMSync)
    OAMSync


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

    External Docs
    See Also :

    Operation

    get /esmSync/performPerNeSync/{neName}
    performPerNeSync (performPerNeSync : /esmSync/performPerNeSync/{neName})
    performPerNeSync

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---

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

    External Docs
    See Also :

    Operation

    post /esmSync/PerformSync
    performSync (performSync : /esmSync/PerformSync)
    performSync

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData ESMSyncReqRespList ---

    Return type
  • ESMSyncReqRespList
  • Responses

    Response Messages

    Schema

    200success ESMSyncReqRespList
    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 /esmSync/resetSyncCache
    resetSyncCache (resetSyncCache : /esmSync/resetSyncCache)
    resetSyncCache


    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/json

    External Docs
    See Also :

    Operation

    get /esmSync/retrieveERPPathStateDetails/{entityName}
    retrieveERPPathStateDetails (retrieveERPPathStateDetails : /esmSync/retrieveERPPathStateDetails/{entityName})
    retrieveERPPathStateDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---

    Return type
  • Nml_Entity_Details
  • Responses

    Response Messages

    Schema

    200success Nml_Entity_Details
    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/xml

    External Docs
    See Also :

    Operation

    get /esmSync/RetrieveMEPDetails/{entityName}/{entityType}
    retrieveMEPDetails (retrieveMEPDetails : /esmSync/RetrieveMEPDetails/{entityName}/{entityType})
    retrieveMEPDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---
    entityType required entityType ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsFromEntityId/{entityId}/{entityType}
    retrieveMEPDetails (retrieveMEPDetails : /esmSync/RetrieveMEPDetailsFromEntityId/{entityId}/{entityType})
    retrieveMEPDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityId required entityId ---
    entityType required entityType ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsForE2EOam/{entityName}
    RetrieveMEPDetailsForE2EOam (retrieveMEPDetailsForE2EOam : /esmSync/RetrieveMEPDetailsForE2EOam/{entityName})
    RetrieveMEPDetailsForE2EOam

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsForLinkOam/{entityName}/{endptTpId}
    retrieveMEPDetailsForLinkOam (retrieveMEPDetailsForLinkOam : /esmSync/RetrieveMEPDetailsForLinkOam/{entityName}/{endptTpId})
    retrieveMEPDetailsForLinkOam

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---
    endptTpId required endptTpId ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsToModify/{entityName}/{entityType}
    retrieveMEPDetailsToModify (retrieveMEPDetailsToModify : /esmSync/RetrieveMEPDetailsToModify/{entityName}/{entityType})
    retrieveMEPDetailsToModify

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---
    entityType required entityType ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsToModifyDemarcation/{entityName}/{entityType}
    RetrieveMEPDetailsToModifyDemarcation (retrieveMEPDetailsToModifyDemarcation : /esmSync/RetrieveMEPDetailsToModifyDemarcation/{entityName}/{entityType})
    RetrieveMEPDetailsToModifyDemarcation

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityName required entityName ---
    entityType required entityType ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/RetrieveMEPDetailsToModifyFromEntityId/{entityId}/{entityType}
    retrieveMEPDetailsToModifyFromEntityId (retrieveMEPDetailsToModifyFromEntityId : /esmSync/RetrieveMEPDetailsToModifyFromEntityId/{entityId}/{entityType})
    retrieveMEPDetailsToModifyFromEntityId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    entityId required entityId ---
    entityType required entityType ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

    200success ResponseHeader
    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 /esmSync/SHGSync
    SHGSync (sHGSync : /esmSync/SHGSync)
    SHGSync


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

    External Docs
    See Also :

    Operation

    get /esmSync/SHGSync/{neName}
    SHGSyncNeName (sHGSyncNeName : /esmSync/SHGSync/{neName})
    SHGSyncNeName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---

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

    External Docs
    See Also :

    Operation

    get /esmSync/Sync
    Sync (sync : /esmSync/Sync)
    Sync


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

    External Docs
    See Also :

    Operation

    get /esmSync/NeSync/{neName}
    syncFromNeName (syncFromNeName : /esmSync/NeSync/{neName})
    syncFromNeName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---

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

    External Docs
    See Also :

    Operation

    get /esmSync/VPLSSync
    VPLSSync (vPLSSync : /esmSync/VPLSSync)
    VPLSSync


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

    External Docs
    See Also :

    Elementary_Details

    Name

    Type

    Description

    Enum

    neName String string --- ---
    packName String string --- ---
    vsId Integer integer --- ---
    elementaryId Long long --- ---
    interconnectedRingId String string --- ---
    subRingType String string --- ---
    propagateTopoChange String string --- ---
    vplsId Long long --- ---
    mdId Integer integer --- ---
    maId Integer integer --- ---
    bridgeId Long long --- ---
    vlanId String string --- ---
    epipeId Long long --- ---
    maName String string --- ---
    ccmInterval String string --- ---
    mdLevel Integer integer --- ---
    mdFormat String string --- ---
    elementaryName String string --- ---
    objectScope Integer integer --- ---
    adminState String string --- ---
    operationalState String string --- ---
    ringState String string --- ---
    mark Integer integer --- ---
    entityType String string --- ---
    cardName String string --- ---
    policyType String string --- ---
    editedSapName String string --- ---
    customerId Integer integer --- ---
    policyAssociation String string --- ---
    sapId Integer integer --- ---
    sapRingId Long long --- ---
    sapRingIdStr String string --- ---
    pathA String string --- ---
    pathB String string --- ---
    rplNode String string --- ---
    pathAFwdState String string --- ---
    pathBFwdState String string --- ---
    ringPortAState String string --- ---
    ringPortBState String string --- ---
    inConsistentFlag String string --- ---
    policyName String string --- ---
    entityName String string --- ---
    policyId Long long --- ---
    pathainConsistentFlag String string --- ---
    pathbinConsistentFlag String string --- ---
    pmonPolicyId Integer integer --- ---
    profName String string --- ---
    pathAAdminState String string --- ---
    pathBAdminState String string --- ---
    pathAOperState String string --- ---
    pathBOperState String string --- ---
    svcSapType String string --- ---
    sapEncapType String string --- ---
    cpId Integer integer --- ---
    cpRange String string --- ---
    cpDescription String string --- ---
    cpLastModifiedTime String string --- ---
    mhfCreation String string --- ---
    uniqueUIId String string --- ---
    vcSwitchingEnabled String string --- ---
    endPoint String string --- ---
    holdTimeType String string --- ---
    holdUpTime String string --- ---
    holdDownTime String string --- ---
    pathInterface String string --- ---
    pathType String string --- ---
    path String string --- ---
    pathFwdState String string --- ---
    ringPortState String string --- ---
    pathinConsistentFlag String string --- ---
    pathAdminState String string --- ---
    pathOperState String string --- ---
    pathSide String string --- ---
    vplsname String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    consistency String string --- ---
    sapAssn String string --- ---
    customerIdStr Integer integer --- ---
    mepId Integer integer --- ---
    transmittedCcms String string --- ---
    ccmSeqErrors String string --- ---
    lastErrorCcmFailureFrame String string --- ---
    lastXconCcmFailureFrame String string --- ---
    highestPriorityDefect String string --- ---
    highestPriorityDefectString String string --- ---
    nmlMacAddress String string --- ---
    macAddress String string --- ---
    direction String string --- ---
    interfaceType String string --- ---
    active String string --- ---
    lowestPriorityDefect String string --- ---
    controlMep String string --- ---
    ccmEnable String string --- ---
    ccmPriority Integer integer --- ---
    aisEnable String string --- ---
    aisPriority Integer integer --- ---
    aisInterval Integer integer --- ---
    aisLevel String string --- ---
    remoteMepId Integer integer --- ---
    remoteMepNeName String string --- ---
    remoteMepPackName String string --- ---
    psId String string --- ---
    sapSubType String string --- ---
    packetSwitchId String string --- ---
    ehName String string --- ---
    entityId Long long --- ---
    remoteMepSapSubType String string --- ---
    llfEnable String string --- ---
    ethIfId Integer integer --- ---
    ethIBMVlanId Integer integer --- ---
    ethIfDescription String string --- ---
    mdName String string --- ---
    format String string --- ---

    ESMSyncReqResp

    Name

    Type

    Description

    Enum

    timeStamp Date DateTime --- ---
    neId Integer integer --- ---
    errorReason String string --- ---
    neName String string --- ---
    syncType Integer integer --- ---
    reqId Integer integer --- ---
    status Integer integer --- ---

    ESMSyncReqRespList

    Name

    Type

    Description

    Enum

    syncList array[ESMSyncReqResp] ESMSyncReqResp --- ---

    Nml_Entity_Details

    Name

    Type

    Description

    Enum

    nmlEntityDetailsList array[Elementary_Details] Elementary_Details --- ---
    items array[Elementary_Details] Elementary_Details --- ---

    RequestHeader

    Name

    Type

    Description

    Enum

    reqId String string --- ---
    respBeanRef String string --- ---
    clientName String string --- ---
    selectiveSyncViaPolling Boolean boolean --- ---

    ResponseHeader

    Name

    Type

    Description

    Enum

    req RequestHeader RequestHeader --- ---
    errorReason String string --- ---
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string --- ---
    opMsg String string --- ---
    msgCode String string --- ---
    parameters array[String] string --- ---
    paramCount Integer integer --- ---
    objectId Integer integer --- ---
    jobName String string --- ---
    objectType Integer integer --- ---

    Void

    Name

    Type

    Description

    Enum