Operation

post /data/otn/otdrscan/physicallink/association
Associate physical link to OTDR ports. (associatePhysicalLinkToOtdrPort : /data/otn/otdrscan/physicallink/association)
Associate physical link to OTDR ports.

Query parameters

Name

IsRequired

Description

phyLinkOtdrAssociationPayload required phyLinkOtdrAssociationPayload

Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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

    { "phyLinkId":2, "phyLinkLabel":"sahana", "srcNeName":"10.42.27.225", "destNeName":"10.42.27.226", "azTx":{ "phyLinkPort":"ASWG-1-15-LINEOUT", "otdrScanPort":"", "associationType":"External" }, "zaRx":{ "phyLinkPort":"ASWG-1-16-LINEIN", "otdrScanPort":"", "associationType":"External" } }

    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
    { "statusCode": 200, "message": "Successfully submitted request to externally disassociate OTDR port for Physical Connection Sdayasha-2-ended-bi-sfd44-Itlu-1", "responseObject": 0 }

    External Docs
    See Also :

    Operation

    post /data/otn/physicallink/association
    Associate physical link to OTDR ports. (associatePhysicalLinkToOtdrPort : /data/otn/physicallink/association)
    Associate physical link to OTDR ports.

    Query parameters

    Name

    IsRequired

    Description

    phyLinkOtdrAssociationPayload required phyLinkOtdrAssociationPayload

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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 /data/otn/otdrscan/rebaseline/physicalconn/{phyLinkId}
    Rebaseline Otdr Scan result based on last scan result for the physical connection. (baselineOtdrLastScan : /data/otn/otdrscan/rebaseline/physicalconn/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required 'sourcePortFdnList' is the list of physical connection endpoints on which rebaseline need to be done and is retrieved as '{sourceNE}/{sourcePort}' for given span as '{span}' from the REST call '/scanresult/physicalconn/{phyLinkId}' array[String] ---

    Return type
  • OtnOtdrScanReferenceEntity
  • Responses

    Response Messages

    Schema

    200success OtnOtdrScanReferenceEntity
    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

    /data/otn/otdrscan/rebaseline/physicalconn/91 Payload: ["25/ASWG-5-16-LINEIN"]

    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
    { "statusCode":200, "message":"Rebaseline successful ,[LinkID=91].", "responseObject":[ [ ], [ ] ] }

    External Docs
    See Also :

    Operation

    post /data/otn/otdrscan/physicallink/disassociation
    Associate physical link to OTDR ports. (disassociatePhysicalLinkToOtdrPort : /data/otn/otdrscan/physicallink/disassociation)
    Associate physical link to OTDR ports.

    Query parameters

    Name

    IsRequired

    Description

    phyLinkOtdrAssociationPayload required phyLinkOtdrAssociationPayload

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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/otdrscan/otdrCustomprofile/{neId}
    Fetches otdr custom profile (getOtdrNeCustomProfile : /data/otn/otdrscan/otdrCustomprofile/{neId})
    'neId' field values can be obtained from the 'emlNeId' field of any Network Element retrieved from the call /data/npr/nes ,This method returns all otdr custom profiles based on the Neid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required 'neId' field values can be obtained from the 'emlNeId' field of any Network Element retrieved from the call /data/npr/nes ---

    Return type
  • DeferredResult
  • Responses

    Response Messages

    Schema

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

    /data/otn/otdrCustomprofile/22

    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
    [ { "neId": 22, "pack": "OTDRM", "profileId": 1, "description": "160 Km scan", "pulseLength": 3000, "scanRange": 120, "resolution": 20, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDRM_221", "avgTime": "3:0", "id": "OTDRM_221" }, { "neId": 22, "pack": "OTDRM", "profileId": 2, "description": "80 Km scan", "pulseLength": 1000, "scanRange": 80, "resolution": 10, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDRM_222", "avgTime": "3:0", "id": "OTDRM_222" }, { "neId": 22, "pack": "OTDRM", "profileId": 3, "description": "40 Km scan", "pulseLength": 100, "scanRange": 40, "resolution": 2, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDRM_223", "avgTime": "3:0", "id": "OTDRM_223" }, { "neId": 22, "pack": "OTDRM", "profileId": 4, "description": "10 Km scan", "pulseLength": 30, "scanRange": 10, "resolution": 1, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDRM_224", "avgTime": "3:0", "id": "OTDRM_224" }, { "neId": 22, "pack": "OTDRM", "profileId": 5, "description": "Custom profili", "pulseLength": 100, "scanRange": 5, "resolution": 0.5, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": 1563375316000, "key": "customprofile / OTDRM_225", "avgTime": "3:0", "id": "OTDRM_225" }, { "neId": 22, "pack": "OTDRM", "profileId": 6, "description": "Custom Profile", "pulseLength": 10000, "scanRange": 1.6, "resolution": 0.5, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": 1563375316000, "key": "customprofile / OTDRM_226", "avgTime": "3:0", "id": "OTDRM_226" }, { "neId": 22, "pack": "OTDRM", "profileId": 7, "description": "Custom profilie", "pulseLength": 3000, "scanRange": 1.6, "resolution": 0.5, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": 1563375317000, "key": "customprofile / OTDRM_227", "avgTime": "3:0", "id": "OTDRM_227" }, { "neId": 22, "pack": "OTDR", "profileId": 1, "description": "260 Km scan", "pulseLength": 10000, "scanRange": 260, "resolution": 10, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_221", "avgTime": "3:0", "id": "OTDR_221" }, { "neId": 22, "pack": "OTDR", "profileId": 2, "description": "160 Km scan", "pulseLength": 3000, "scanRange": 160, "resolution": 5, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_222", "avgTime": "3:0", "id": "OTDR_222" }, { "neId": 22, "pack": "OTDR", "profileId": 3, "description": "80 Km scan", "pulseLength": 1000, "scanRange": 80, "resolution": 2.5, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_223", "avgTime": "3:0", "id": "OTDR_223" }, { "neId": 22, "pack": "OTDR", "profileId": 4, "description": "40 Km scan", "pulseLength": 100, "scanRange": 40, "resolution": 0.64, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_224", "avgTime": "3:0", "id": "OTDR_224" }, { "neId": 22, "pack": "OTDR", "profileId": 5, "description": "20 Km scan", "pulseLength": 30, "scanRange": 20, "resolution": 0.32, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_225", "avgTime": "3:0", "id": "OTDR_225" }, { "neId": 22, "pack": "OTDR", "profileId": 6, "description": "10 Km scan", "pulseLength": 10, "scanRange": 10, "resolution": 0.16, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0.5, "ior": 1.465, "lastUpdated": null, "key": "customprofile / OTDR_226", "avgTime": "3:0", "id": "OTDR_226" }, { "neId": 22, "pack": "OTDR", "profileId": 7, "description": null, "pulseLength": 2000, "scanRange": 0, "resolution": 0, "avgTimeMin": 0, "avgTimeSec": 0, "eventThreshold": 0, "ior": 0, "lastUpdated": 1563375316000, "key": "customprofile / OTDR_227", "avgTime": "0:0", "id": "OTDR_227" }, { "neId": 22, "pack": "OTDR", "profileId": 8, "description": null, "pulseLength": 2000, "scanRange": 0, "resolution": 0, "avgTimeMin": 0, "avgTimeSec": 0, "eventThreshold": 0, "ior": 0, "lastUpdated": 1563375316000, "key": "customprofile / OTDR_228", "avgTime": "0:0", "id": "OTDR_228" }, { "neId": 22, "pack": "OTDR", "profileId": 9, "description": null, "pulseLength": 10000, "scanRange": 1.6, "resolution": 0, "avgTimeMin": 3, "avgTimeSec": 0, "eventThreshold": 0, "ior": 1.465, "lastUpdated": 1563375316000, "key": "customprofile / OTDR_229", "avgTime": "3:0", "id": "OTDR_229" } ]

    External Docs
    See Also :

    Operation

    get /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • /data/otn/darkfiber/list

  • Operation

    head /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_7)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • /data/otn/darkfiber/list

  • Operation

    put /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_8)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • /data/otn/darkfiber/list

  • Operation

    post /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_9)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • /data/otn/darkfiber/list

  • Operation

    delete /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_10)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • /data/otn/darkfiber/list

  • Operation

    patch /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_11)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • /data/otn/darkfiber/list

  • Operation

    options /data/otn/scanprofile/darkfiber/{dfId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByDarkfiberId : /data/otn/scanprofile/darkfiber/{dfId}_12)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'dfId' is the unique id for a Dark fiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • /data/otn/darkfiber/list

  • Operation

    get /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    head /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_1)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    put /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_2)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    post /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_3)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    delete /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_4)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    patch /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_5)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    options /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/otdrscan/scanprofile/physicalconn/{phyLinkId}_6)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    get /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    head /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_13)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    put /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_14)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    post /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_15)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    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 :
  • get : /data/npr/physicalConns

  • Operation

    delete /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_16)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    patch /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_17)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    options /data/otn/scanprofile/physicalconn/{phyLinkId}
    Get recently used otdr scan profile(s) for the specified physical connection. (getOtdrScanProfileByPhysicaLinkId : /data/otn/scanprofile/physicalconn/{phyLinkId}_18)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • Map
  • Responses

    Response Messages

    Schema

    200success Map
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    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 :
  • get : /data/npr/physicalConns

  • Operation

    get /data/otn/summary/{phyLinkId}
    Get otdr scan result for the specified physical connection. (getOtdrScanResult : /data/otn/summary/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required phyLinkId ---

    Return type
  • OtnOtdrScanResultEntity
  • Responses

    Response Messages

    Schema

    200success OtnOtdrScanResultEntity
    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 :
  • get : /data/npr/physicalConns

  • Operation

    get /data/otn/otdrscan/scanresult/physicalconn/{phyLinkId}
    Get otdr scan results for the specified physical connection. Returns list of map containing key value pairs. (getOtdrScanResultByPhysicalLinkId : /data/otn/otdrscan/scanresult/physicalconn/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • OtdrScanResultResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/otdrscan/scanresult/physicalconn/91

    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
    [ { "lastScanTime": 1502966958850, "userEnteredLength": 0, "sourceNE": "PSS32-20-5-225", "baselineFilename": "otdrscan-91-aztx-bl.sor", "lastScanLength": 0.04, "srcPort": "ASWG-5-16-LINEOUT", "fiberCutStatus": 0, "sourceNeId": 25, "destNE": "PSS32-20-5-226", "baselineTime": 1502966958850, "destPort": "ASWG-5-11-LINEIN", "id": 0, "destNeId": 27, "lastScanFilename": "otdrscan-91-aztx-bl.sor", "baselineFiberLength": 0.04, "phyLinkId": 91, "span": "AZ", "triggeredBy": "Manual" }, { "lastScanTime": 1502966958850, "userEnteredLength": 0, "sourceNE": "PSS32-20-5-226", "baselineFilename": "otdrscan-91-aztx-bl.sor", "lastScanLength": 0.04, "srcPort": "ASWG-5-11-LINEIN", "fiberCutStatus": 0, "sourceNeId": 27, "destNE": "PSS32-20-5-225", "baselineTime": 1502966958850, "destPort": "ASWG-5-16-LINEOUT", "id": 1, "destNeId": 25, "lastScanFilename": "otdrscan-91-aztx-bl.sor", "baselineFiberLength": 0.04, "phyLinkId": 91, "span": "AZ", "triggeredBy": "Manual" }, { "lastScanTime": 1502966958850, "userEnteredLength": 0, "sourceNE": "PSS32-20-5-226", "baselineFilename": "otdrscan-91-zatx-bl.sor", "lastScanLength": 0.04, "srcPort": "ASWG-5-11-LINEOUT", "fiberCutStatus": 0, "sourceNeId": 27, "destNE": "PSS32-20-5-225", "baselineTime": 1502966958850, "destPort": "ASWG-5-16-LINEIN", "id": 2, "destNeId": 25, "lastScanFilename": "otdrscan-91-zatx-bl.sor", "baselineFiberLength": 0.04, "phyLinkId": 91, "span": "ZA", "triggeredBy": "Manual" }, { "lastScanTime": 1502966958850, "userEnteredLength": 0, "sourceNE": "PSS32-20-5-225", "baselineFilename": "otdrscan-91-zatx-bl.sor", "lastScanLength": 0.04, "srcPort": "ASWG-5-16-LINEIN", "fiberCutStatus": 0, "sourceNeId": 25, "destNE": "PSS32-20-5-226", "baselineTime": 1502966958850, "destPort": "ASWG-5-11-LINEOUT", "id": 3, "destNeId": 27, "lastScanFilename": "otdrscan-91-zatx-bl.sor", "baselineFiberLength": 0.04, "phyLinkId": 91, "span": "ZA", "triggeredBy": "Manual" } ]

    External Docs
    See Also :
  • get : /data/npr/physicalConns

  • Operation

    get /data/otn/scanresult/physicalconn/{phyLinkId}
    Get otdr scan results for the specified physical connection. Returns list of map containing key value pairs. (getOtdrScanResultByPhysicalLinkId : /data/otn/scanresult/physicalconn/{phyLinkId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • OtdrScanResultResponse
  • Responses

    Response Messages

    Schema

    200success OtdrScanResultResponse
    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 :
  • get : /data/npr/physicalConns

  • Operation

    get /data/otn/otdrscan/physicallink/association/{phyLinkId}
    Get OTDR port association for the physical connection (getPhyLinkOtdrAssociation : /data/otn/otdrscan/physicallink/association/{phyLinkId})
    Get physical link association to OTDR ports

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

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

    /data/otn/otdrscan/physicallink/association/21

    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
    { "statusCode": 200, "message": "Retrieved PhyLink Otdr port association for the PhysicalLink 21", "responseObject": { "phyLinkId": 21, "phyLinkLabel": null, "srcNeName": "10.42.27.225", "destNeName": "10.42.27.226", "azTx": { "phyLinkPort": "ASWG-1-15-LINEOUT", "otdrScanPort": "IROADM-12-5-LINEOUT", "associationType": "External" }, "azRx": { "phyLinkPort": "ASWG-1-16-LINEIN", "otdrScanPort": "ASWG-10-12-LINEIN", "associationType": "External" }, "zaTx": { "phyLinkPort": "ASWG-1-15-LINEOUT", "otdrScanPort": "IROADM-12-5-LINEOUT", "associationType": "External" }, "zaRx": { "phyLinkPort": "ASWG-1-16-LINEIN", "otdrScanPort": "ASWG-10-12-LINEIN", "associationType": "External" } } }

    External Docs
    See Also :

    Operation

    get /data/otn/physicallink/association/{phyLinkId}
    Get OTDR port association for the physical connection (getPhyLinkOtdrAssociation : /data/otn/physicallink/association/{phyLinkId})
    Get physical link association to OTDR ports

    Path parameters

    Name

    IsRequired

    Description

    Enum

    phyLinkId required 'phyLinkId' is the unique id for a physical connection which can be retrieved as 'id' from the REST call '/data/npr/physicalConns' ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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/otdrscan/rebaseline/darkfiber/{dfId}
    Rebaseline Otdr Scan result based on last scan result for the physical connection. (rebaselineOtdrLastScanForDarkFiber : /data/otn/otdrscan/rebaseline/darkfiber/{dfId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required 'dfId' is the unique id for a Darkfiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required 'sourcePortFdnList' is the list of physical connection endpoints on which rebaseline need to be done and is retrieved as '{sourceNE}/{sourcePort}' for given span as '{span}' from the REST call '/data/otn/darkfiber/scanresult/{dfId}' array[String] ---

    Return type
  • OtnOtdrScanReferenceEntity
  • Responses

    Response Messages

    Schema

    200success OtnOtdrScanReferenceEntity
    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 /data/otn/rebaseline/darkfiber/{dfId}
    Rebaseline Otdr Scan result based on last scan result for the physical connection. (rebaselineOtdrLastScanForDarkFiber : /data/otn/rebaseline/darkfiber/{dfId})

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required 'dfId' is the unique id for a Darkfiber which can be retrieved as 'id' from the REST call '/data/otn/darkfiber/list' ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required 'sourcePortFdnList' is the list of physical connection endpoints on which rebaseline need to be done and is retrieved as '{sourceNE}/{sourcePort}' for given span as '{span}' from the REST call '/data/otn/darkfiber/scanresult/{dfId}' array[String] ---

    Return type
  • OtnOtdrScanReferenceEntity
  • Responses

    Response Messages

    Schema

    200success OtnOtdrScanReferenceEntity
    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 /data/otn/otdrscan/setprofile
    Perform set OTDR Profile (setOTDRProfiles : /data/otn/otdrscan/setprofile)
    setOTDRProfiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional profile OtdrProfileObj ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel
    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

    /data/otn/otdrscan/setprofile Payload: [avgTime: "00:17", description: "Custom profile", eventThreshold: "0.30", ior: "1.465", neId: "22", pack: "OTDRM", profileId: "6", pulseLength: "3000", resolution: "5", scanRange: "40"]

    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.
    • */*
    Example Response Data
    [ { "status": "Success" } ]

    External Docs
    See Also :

    Operation

    post /data/otn/setprofile
    Perform set OTDR Profile (setOTDRProfiles : /data/otn/setprofile)
    setOTDRProfiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional profile OtdrProfileObj ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/otn/otdrscan/sync/{neId}
    Perform OTDR Custom Profile Sync for the given NE ID. (syncOTDRProfiles : /data/otn/otdrscan/sync/{neId})
    'neId' field values can be obtained from the 'emlNeId' field of any Network Element retrieved from the call /data/npr/nes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---

    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 /data/otn/sync/{neId}
    Perform OTDR Custom Profile Sync for the given NE ID. (syncOTDRProfiles : /data/otn/sync/{neId})
    'neId' field values can be obtained from the 'emlNeId' field of any Network Element retrieved from the call /data/npr/nes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---

    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 :

    Chronology

    Name

    Type

    Description

    Enum

    calendarType String string --- ---
    id String string --- ---

    DeferredResult

    Name

    Type

    Description

    Enum

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

    JobDetailConfiguration

    Name

    Type

    Description

    Enum

    key String string Key ---
    value String string Value ---
    state String string State ---

    LocalDateTime

    Name

    Type

    Description

    Enum

    monthValue Integer integer --- ---
    nano Integer integer --- ---
    year Integer integer --- ---
    month String string --- [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]
    dayOfMonth Integer integer --- ---
    dayOfWeek String string --- [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
    dayOfYear Integer integer --- ---
    hour Integer integer --- ---
    minute Integer integer --- ---
    second Integer integer --- ---
    chronology Chronology Chronology --- ---

    OtdrProfileObj

    Name

    Type

    Description

    Enum

    neId String string --- ---
    pack String string --- ---
    profileId String string --- ---
    profileName String string --- ---
    pulseLength String string --- ---
    scanRange String string --- ---
    resolution String string --- ---
    avgTime String string --- ---
    description String string --- ---
    eventThreshold String string --- ---
    ior String string --- ---

    OtdrResponse

    Name

    Type

    Description

    Enum

    statusCode Integer integer Specifies the status of the request---Example:200 for success ---
    message String string Specifies the response message if any, for the request---Example:Scan scheduled successfully. ---
    responseObject Object object Specifies the response object for the request ---

    OtdrScanResultResponse

    Name

    Type

    Description

    Enum

    srcPort String string Source port where otdr scan is triggered ---
    sourceNeId String string Source NE Id where otdr scan is triggered ---
    fiberCutStatus String string Specifies difference between baseline and last scan fiberlength values. Note: This includes OTDR tolerance factor while computing fuber cut. ---
    baselineFilename String string Otdr baseline scan result file name. Prefix filename with https://:/oms1350/otn/schedule/otdr/file/ to download file from server. ---
    triggeredBy String string Specifies how otdr scan was triggered - Manual/Scheduled/Auto. Manual means otdr scan triggered by operator using otdr scanNow option. Scheduled means otdr scan triggered by operator using otdr schedule option. Auto means otdr scan initiated by notification from Node. ---
    sourceNE String string Specifies physical link's source NE name ---
    baselineTime String string Specifies time at which baseline scan result processed. ---
    id String string Specifies sequence number of otdr scan result list ---
    destNE String string Specifies physical link's destination NE name ---
    baselineFiberLength String string Specifies baseline fiber length (KMtrs by defualt) ---
    lastScanLength String string Specifies last scan fiber length (KMtrs by default) ---
    destNeId String string Specifies physical link's destination NE Id ---
    lastScanTime String string Specifies time at which last otdr scan result processed ---
    phyLinkId String string Specifies Physical link's connection Id ---
    lastScanFilename String string Otdr last scan result file name. Prefix filename with https://:/oms1350/otn/schedule/otdr/file/ to download file from server. ---
    userEnteredLength String string Specifies user specified fiber length ---
    destPort String string Specifies Physical link's destination port name. ---
    span String string Specifies Physical link's span - AZ or ZA direction ---

    OtnOtdrScanReferenceEntity

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    objectState String string --- [UNSPECIFIED, CREATED_INMEMORY, CREATED_PERSISTED, MODIFIED_INMEMORY, MODIFIED_PERSISTED, DELETED_INMEMROY, PURGED, PERSISTED]
    phyLinkId Long long --- ---
    sourceNeId Long long --- ---
    sourcePort String string --- ---
    destNeId Long long --- ---
    destPort String string --- ---
    portDirection String string --- ---
    timeStamp LocalDateTime LocalDateTime --- ---
    fiberLength Double double --- ---
    scanType String string --- ---
    scanRef String string --- ---
    sorFileName String string --- ---
    scanProfId Long long --- ---
    triggeredBy String string --- ---

    OtnOtdrScanResultEntity

    Name

    Type

    Description

    Enum

    nprtlid Long long --- ---
    otdrStatus String string --- [NO_SCAN, BASELINE_COMPLETED, TROUBLESHOOT_COMPLETED, BASELINE_NOT_DONE, FIBERCUT_DETECTED, NO_FIBERCUT, LOS_NO_FIBERCUT, FIBERCUT_DETECTED_NO_BASELINE, OTDRSCAN_NOTAPPLICABLE]
    azSpanPlotFile String string --- ---
    zaSpanPlotFile String string --- ---

    ResponseDtModel

    Name

    Type

    Description

    Enum

    identifier String string Identifer attribute ---
    items array[Serializable] Serializable Items attribute ---
    status String string Status attribute ---
    message String string Message attribute ---

    Serializable

    Name

    Type

    Description

    Enum

    Void

    Name

    Type

    Description

    Enum