Operation

post /data/otn/networkinventory/delete/networkdatafile/{ntwfilename}
deleteJob (deleteJob : /data/otn/networkinventory/delete/networkdatafile/{ntwfilename})
deleteJob

Path parameters

Name

IsRequired

Description

Enum

ntwfilename required ntwfilename ---

Return type
  • EptAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success EptAdapterConnectionsResponse
    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/otn/networkinventory/generatefile
    generateBITfile (generateBITfile : /data/otn/networkinventory/generatefile)
    generateBITfile


    Return type
  • EptAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success EptAdapterConnectionsResponse
    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 /data/otn/networkinventory/generate/networkdatafile
    generateNtwkDataFile (generateNtwkDataFile : /data/otn/networkinventory/generate/networkdatafile)
    generateNtwkDataFile

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req EPTAdapterInventoryReq ---
    body2 optional httpSession HttpSession ---
    body3 optional locale Locale ---

    Return type
  • EptAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

    200success EptAdapterConnectionsResponse
    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/otn/getHaStatus
    getHaStatus (getHaStatus : /data/otn/getHaStatus)
    getHaStatus


    Return type
  • HaStatus
  • Responses

    Response Messages

    Schema

    200success HaStatus
    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/otn/networkinventory/networkfilesandstatus
    getNetworkDataFiles (getNetworkDataFiles : /data/otn/networkinventory/networkfilesandstatus)
    getNetworkDataFiles


    Return type
  • EPTAdapterInventoryResponse
  • Responses

    Response Messages

    Schema

    200success EPTAdapterInventoryResponse
    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/otn/networkinventory/refresh
    refresh (refresh : /data/otn/networkinventory/refresh)
    refresh


    Return type
  • EptAdapterConnectionsResponse
  • Responses

    Response Messages

    Schema

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

    ConnectionsResponseHeader

    Name

    Type

    Description

    Enum

    originatorApp String string --- ---
    objectType String string --- ---
    objectScope String string --- ---
    responseStatus String string --- ---
    fileGenerationTime String string --- ---
    errorCode String string --- ---
    errorReason String string --- ---
    errorParams array[Map«string,string»] Map«string,string» --- ---

    EptAdapterConnectionsResponse

    Name

    Type

    Description

    Enum

    responseHeader ConnectionsResponseHeader ConnectionsResponseHeader --- ---
    responseFiles array[String] string --- ---

    EPTAdapterInventoryReq

    Name

    Type

    Description

    Enum

    ntwkDataFileName String string --- ---
    operationType String string --- ---
    constraintType String string --- ---
    constraintIdList array[Long] long --- ---

    EPTAdapterInventoryResponse

    Name

    Type

    Description

    Enum

    reqCompletionStatus Integer integer --- ---
    requestId Long long --- ---
    clientName String string --- ---
    clientLocation String string --- ---
    clientUser String string --- ---
    sessionId String string --- ---
    mdcId String string --- ---
    sequenceNum Integer integer --- ---
    moreToCome Boolean boolean --- ---
    messages array[OtnI18nMessage] OtnI18nMessage --- ---
    errcde String string --- ---
    errorParams array[Object] object --- ---
    nextTasks array[String] string --- ---
    items array[Object] object --- ---
    data array[Object] object --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    HaStatus

    Name

    Type

    Description

    Enum

    status String string --- ---

    OtnI18nMessage

    Name

    Type

    Description

    Enum

    messageType String string --- [Info, Warning, Error]
    messageUnformatted String string --- ---
    validPropertyResourceMessage Boolean boolean --- ---
    messageId String string --- ---
    messageParams array[String] string --- ---
    messageTime Long long --- ---
    message String string --- ---