Operation

delete /data/otn/delete/{jobDetailsId}
delete (delete : /data/otn/delete/{jobDetailsId})
delete

Path parameters

Name

IsRequired

Description

Enum

jobDetailsId required jobDetailsId ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional httpSession HttpSession ---
Query parameters

Name

IsRequired

Description

clean optional ---

Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/otdr/joblist/{jobHandleId}
    delete (delete : /data/otn/otdr/joblist/{jobHandleId})
    delete

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/schedule/delete/{jobDetailsId}
    delete (delete : /data/otn/schedule/delete/{jobDetailsId})
    delete

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    clean optional ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/schedule/otdr/joblist/{jobHandleId}
    delete (delete : /data/otn/schedule/otdr/joblist/{jobHandleId})
    delete

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /otn/schedule/delete/{jobDetailsId}
    delete (delete : /otn/schedule/delete/{jobDetailsId})
    delete

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    clean optional ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /otn/schedule/otdr/joblist/{jobHandleId}
    delete (delete : /otn/schedule/otdr/joblist/{jobHandleId})
    delete

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/otdr/{jobDetailsId}
    deleteOtdr (deleteOtdr : /data/otn/otdr/{jobDetailsId})
    deleteOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/schedule/otdr/{jobDetailsId}
    deleteOtdr (deleteOtdr : /data/otn/schedule/otdr/{jobDetailsId})
    deleteOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /otn/schedule/otdr/{jobDetailsId}
    deleteOtdr (deleteOtdr : /otn/schedule/otdr/{jobDetailsId})
    deleteOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/job/{jobDetailsId}
    findJobDetails (findJobDetails : /data/otn/job/{jobDetailsId})
    findJobDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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/schedule/job/{jobDetailsId}
    findJobDetails (findJobDetails : /data/otn/schedule/job/{jobDetailsId})
    findJobDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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 /otn/schedule/job/{jobDetailsId}
    findJobDetails (findJobDetails : /otn/schedule/job/{jobDetailsId})
    findJobDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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/job/name
    findJobDetailsByName (findJobDetailsByName : /data/otn/job/name)
    findJobDetailsByName

    Query parameters

    Name

    IsRequired

    Description

    name required ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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/schedule/job/name
    findJobDetailsByName (findJobDetailsByName : /data/otn/schedule/job/name)
    findJobDetailsByName

    Query parameters

    Name

    IsRequired

    Description

    name required ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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 /otn/schedule/job/name
    findJobDetailsByName (findJobDetailsByName : /otn/schedule/job/name)
    findJobDetailsByName

    Query parameters

    Name

    IsRequired

    Description

    name required ---

    Return type
  • JobDetails
  • Responses

    Response Messages

    Schema

    200success JobDetails
    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/job/{jobDetailsId}/config
    findJobDetailsConfig (findJobDetailsConfig : /data/otn/job/{jobDetailsId}/config)
    findJobDetailsConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • array[JobDetailConfiguration]
  • Responses

    Response Messages

    Schema

    200success array[JobDetailConfiguration]
    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/schedule/job/{jobDetailsId}/config
    findJobDetailsConfig (findJobDetailsConfig : /data/otn/schedule/job/{jobDetailsId}/config)
    findJobDetailsConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • array[JobDetailConfiguration]
  • Responses

    Response Messages

    Schema

    200success array[JobDetailConfiguration]
    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 /otn/schedule/job/{jobDetailsId}/config
    findJobDetailsConfig (findJobDetailsConfig : /otn/schedule/job/{jobDetailsId}/config)
    findJobDetailsConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    Return type
  • array[JobDetailConfiguration]
  • Responses

    Response Messages

    Schema

    200success array[JobDetailConfiguration]
    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/history/{jobHistoryId}
    findJobHistory (findJobHistory : /data/otn/history/{jobHistoryId})
    findJobHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

    Return type
  • JobHistory
  • Responses

    Response Messages

    Schema

    200success JobHistory
    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/schedule/history/{jobHistoryId}
    findJobHistory (findJobHistory : /data/otn/schedule/history/{jobHistoryId})
    findJobHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

    Return type
  • JobHistory
  • Responses

    Response Messages

    Schema

    200success JobHistory
    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 /otn/schedule/history/{jobHistoryId}
    findJobHistory (findJobHistory : /otn/schedule/history/{jobHistoryId})
    findJobHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

    Return type
  • JobHistory
  • Responses

    Response Messages

    Schema

    200success JobHistory
    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/history/{jobHistoryId}/config
    findJobHistoryConfig (findJobHistoryConfig : /data/otn/history/{jobHistoryId}/config)
    findJobHistoryConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

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

    Response Messages

    Schema

    200success List[Entry«string,JobHistoryConfiguration»]
    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/schedule/history/{jobHistoryId}/config
    findJobHistoryConfig (findJobHistoryConfig : /data/otn/schedule/history/{jobHistoryId}/config)
    findJobHistoryConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

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

    Response Messages

    Schema

    200success List[Entry«string,JobHistoryConfiguration»]
    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 /otn/schedule/history/{jobHistoryId}/config
    findJobHistoryConfig (findJobHistoryConfig : /otn/schedule/history/{jobHistoryId}/config)
    findJobHistoryConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---

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

    Response Messages

    Schema

    200success List[Entry«string,JobHistoryConfiguration»]
    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/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName})
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    head /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_1)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_2)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_3)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_4)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    patch /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_5)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    options /data/otn/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/otdr/{neID}/{grpID}/{ptpName}_6)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName})
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    head /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_19)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_20)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_21)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_22)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    patch /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_23)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    options /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /data/otn/schedule/otdr/{neID}/{grpID}/{ptpName}_24)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName})
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    head /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_37)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_38)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_39)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    delete /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_40)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    patch /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_41)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    options /otn/schedule/otdr/{neID}/{grpID}/{ptpName}
    findSchedule (findSchedule : /otn/schedule/otdr/{neID}/{grpID}/{ptpName}_42)
    findSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---

    Return type
  • OtdrResponse
  • Responses

    Response Messages

    Schema

    200success OtdrResponse
    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/otdr/{jobDetailsId}
    getOtdr (getOtdr : /data/otn/otdr/{jobDetailsId})
    getOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/schedule/otdr/{jobDetailsId}
    getOtdr (getOtdr : /data/otn/schedule/otdr/{jobDetailsId})
    getOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /otn/schedule/otdr/{jobDetailsId}
    getOtdr (getOtdr : /otn/schedule/otdr/{jobDetailsId})
    getOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/otdr/file/{fileName}
    getOtdrFile (getOtdrFile : /data/otn/otdr/file/{fileName})
    getOtdrFile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    fileName required fileName ---

    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/schedule/otdr/file/{fileName}
    getOtdrFile (getOtdrFile : /data/otn/schedule/otdr/file/{fileName})
    getOtdrFile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    fileName required fileName ---

    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 /otn/schedule/otdr/file/{fileName}
    getOtdrFile (getOtdrFile : /otn/schedule/otdr/file/{fileName})
    getOtdrFile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    fileName required fileName ---

    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/otdr/joblist/{jobHandleId}
    getOtdrSchedule (getOtdrSchedule : /data/otn/otdr/joblist/{jobHandleId})
    getOtdrSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/schedule/otdr/joblist/{jobHandleId}
    getOtdrSchedule (getOtdrSchedule : /data/otn/schedule/otdr/joblist/{jobHandleId})
    getOtdrSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /otn/schedule/otdr/joblist/{jobHandleId}
    getOtdrSchedule (getOtdrSchedule : /otn/schedule/otdr/joblist/{jobHandleId})
    getOtdrSchedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId})
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_7)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_8)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_9)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_10)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_11)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /data/otn/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/otdrscaninfo/darkfiber/{dfId}_12)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId})
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_25)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_26)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_27)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_28)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_29)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /data/otn/schedule/otdrscaninfo/darkfiber/{dfId}_30)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId})
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_43)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_44)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_45)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_46)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_47)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /otn/schedule/otdrscaninfo/darkfiber/{dfId}
    getScheduleByDarkFiberId (getScheduleByDarkFiberId : /otn/schedule/otdrscaninfo/darkfiber/{dfId}_48)
    getScheduleByDarkFiberId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId})
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_13)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_14)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_15)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_16)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_17)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /data/otn/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/otdrscaninfo/physicalconn/{physConnId}_18)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId})
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_31)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_32)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_33)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_34)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_35)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /data/otn/schedule/otdrscaninfo/physicalconn/{physConnId}_36)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId})
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    head /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_49)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    put /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_50)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_51)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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

    delete /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_52)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    patch /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_53)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    options /otn/schedule/otdrscaninfo/physicalconn/{physConnId}
    getScheduleByPhysConnId (getScheduleByPhysConnId : /otn/schedule/otdrscaninfo/physicalconn/{physConnId}_54)
    getScheduleByPhysConnId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    physConnId required physConnId ---

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

    Response Messages

    Schema

    200success List[Map«string,object»]
    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 :

    Operation

    get /data/otn/schedule/{page}/{pageSize}
    list (list : /data/otn/schedule/{page}/{pageSize})
    list

    Path parameters

    Name

    IsRequired

    Description

    Enum

    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobDetails»
    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/{page}/{pageSize}
    list (list : /data/otn/{page}/{pageSize})
    list

    Path parameters

    Name

    IsRequired

    Description

    Enum

    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobDetails»
    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 /otn/schedule/{page}/{pageSize}
    list (list : /otn/schedule/{page}/{pageSize})
    list

    Path parameters

    Name

    IsRequired

    Description

    Enum

    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobDetails»
    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/otdr/scanjob/{jobHandleId}
    listConnectionNames (listConnectionNames : /data/otn/otdr/scanjob/{jobHandleId})
    listConnectionNames

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    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/schedule/otdr/scanjob/{jobHandleId}
    listConnectionNames (listConnectionNames : /data/otn/schedule/otdr/scanjob/{jobHandleId})
    listConnectionNames

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    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 /otn/schedule/otdr/scanjob/{jobHandleId}
    listConnectionNames (listConnectionNames : /otn/schedule/otdr/scanjob/{jobHandleId})
    listConnectionNames

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /data/otn/otdr/file
    listFiles (listFiles : /data/otn/otdr/file)
    listFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    operation required ---
    filename optional ---
    runId optional ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/schedule/otdr/file
    listFiles (listFiles : /data/otn/schedule/otdr/file)
    listFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    operation required ---
    filename optional ---
    runId optional ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /otn/schedule/otdr/file
    listFiles (listFiles : /otn/schedule/otdr/file)
    listFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    operation required ---
    filename optional ---
    runId optional ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    get /data/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}
    listHistory (listHistory : /data/otn/schedule/{jobDetailsId}/history/{page}/{pageSize})
    listHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistory»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistory»
    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/{jobDetailsId}/history/{page}/{pageSize}
    listHistory (listHistory : /data/otn/{jobDetailsId}/history/{page}/{pageSize})
    listHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistory»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistory»
    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 /otn/schedule/{jobDetailsId}/history/{page}/{pageSize}
    listHistory (listHistory : /otn/schedule/{jobDetailsId}/history/{page}/{pageSize})
    listHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistory»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistory»
    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/history/{jobHistoryId}/runs/{page}/{pageSize}
    listHistoryRuns (listHistoryRuns : /data/otn/history/{jobHistoryId}/runs/{page}/{pageSize})
    listHistoryRuns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistoryRunDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistoryRunDetails»
    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/schedule/history/{jobHistoryId}/runs/{page}/{pageSize}
    listHistoryRuns (listHistoryRuns : /data/otn/schedule/history/{jobHistoryId}/runs/{page}/{pageSize})
    listHistoryRuns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistoryRunDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistoryRunDetails»
    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 /otn/schedule/history/{jobHistoryId}/runs/{page}/{pageSize}
    listHistoryRuns (listHistoryRuns : /otn/schedule/history/{jobHistoryId}/runs/{page}/{pageSize})
    listHistoryRuns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHistoryId required jobHistoryId ---
    page required page ---
    pageSize required pageSize ---

    Return type
  • SearchResult«JobHistoryRunDetails»
  • Responses

    Response Messages

    Schema

    200success SearchResult«JobHistoryRunDetails»
    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/job/{jobDetailsId}/schedules/{numOfSchedules}
    listNextFireTimes (listNextFireTimes : /data/otn/job/{jobDetailsId}/schedules/{numOfSchedules})
    listNextFireTimes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    numOfSchedules required numOfSchedules ---

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

    External Docs
    See Also :

    Operation

    get /data/otn/schedule/job/{jobDetailsId}/schedules/{numOfSchedules}
    listNextFireTimes (listNextFireTimes : /data/otn/schedule/job/{jobDetailsId}/schedules/{numOfSchedules})
    listNextFireTimes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    numOfSchedules required numOfSchedules ---

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

    External Docs
    See Also :

    Operation

    get /otn/schedule/job/{jobDetailsId}/schedules/{numOfSchedules}
    listNextFireTimes (listNextFireTimes : /otn/schedule/job/{jobDetailsId}/schedules/{numOfSchedules})
    listNextFireTimes

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    numOfSchedules required numOfSchedules ---

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

    External Docs
    See Also :

    Operation

    get /data/otn/otdr/physconn/job/{jobHandleId}
    listPhysicalConn (listPhysicalConn : /data/otn/otdr/physconn/job/{jobHandleId})
    listPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    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/schedule/otdr/physconn/job/{jobHandleId}
    listPhysicalConn (listPhysicalConn : /data/otn/schedule/otdr/physconn/job/{jobHandleId})
    listPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    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 /otn/schedule/otdr/physconn/job/{jobHandleId}
    listPhysicalConn (listPhysicalConn : /otn/schedule/otdr/physconn/job/{jobHandleId})
    listPhysicalConn

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---

    Return type
  • array[OtdrJobListBean]
  • Responses

    Response Messages

    Schema

    200success array[OtdrJobListBean]
    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

    put /data/otn/pause/{jobDetailsId}
    pause (pause : /data/otn/pause/{jobDetailsId})
    pause

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/pause/{jobDetailsId}
    pause (pause : /data/otn/schedule/pause/{jobDetailsId})
    pause

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/pause/{jobDetailsId}
    pause (pause : /otn/schedule/pause/{jobDetailsId})
    pause

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/{jobDetailsId}
    reschedule (reschedule : /data/otn/schedule/{jobDetailsId})
    reschedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/{jobDetailsId}
    reschedule (reschedule : /data/otn/{jobDetailsId})
    reschedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/{jobDetailsId}
    reschedule (reschedule : /otn/schedule/{jobDetailsId})
    reschedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/otdr/{jobDetailsId}
    rescheduleOtdr (rescheduleOtdr : /data/otn/otdr/{jobDetailsId})
    rescheduleOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/otdr/{jobDetailsId}
    rescheduleOtdr (rescheduleOtdr : /data/otn/schedule/otdr/{jobDetailsId})
    rescheduleOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/otdr/{jobDetailsId}
    rescheduleOtdr (rescheduleOtdr : /otn/schedule/otdr/{jobDetailsId})
    rescheduleOtdr

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/otdr/joblist/{jobHandleId}
    rescheduleOtdrFromJobList (rescheduleOtdrFromJobList : /data/otn/otdr/joblist/{jobHandleId})
    rescheduleOtdrFromJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/otdr/joblist/{jobHandleId}
    rescheduleOtdrFromJobList (rescheduleOtdrFromJobList : /data/otn/schedule/otdr/joblist/{jobHandleId})
    rescheduleOtdrFromJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/otdr/joblist/{jobHandleId}
    rescheduleOtdrFromJobList (rescheduleOtdrFromJobList : /otn/schedule/otdr/joblist/{jobHandleId})
    rescheduleOtdrFromJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobHandleId required jobHandleId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/otdr/darkfiber/joblist/{jobDetailsId}
    rescheduleOtdrOnDarkFibers (rescheduleOtdrOnDarkFibers : /data/otn/otdr/darkfiber/joblist/{jobDetailsId})
    rescheduleOtdrOnDarkFibers

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/otdr/darkfiber/joblist/{jobDetailsId}
    rescheduleOtdrOnDarkFibers (rescheduleOtdrOnDarkFibers : /data/otn/schedule/otdr/darkfiber/joblist/{jobDetailsId})
    rescheduleOtdrOnDarkFibers

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/otdr/darkfiber/joblist/{jobDetailsId}
    rescheduleOtdrOnDarkFibers (rescheduleOtdrOnDarkFibers : /otn/schedule/otdr/darkfiber/joblist/{jobDetailsId})
    rescheduleOtdrOnDarkFibers

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/resume/{jobDetailsId}
    resume (resume : /data/otn/resume/{jobDetailsId})
    resume

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /data/otn/schedule/resume/{jobDetailsId}
    resume (resume : /data/otn/schedule/resume/{jobDetailsId})
    resume

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    put /otn/schedule/resume/{jobDetailsId}
    resume (resume : /otn/schedule/resume/{jobDetailsId})
    resume

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobDetailsId required jobDetailsId ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/schedule/{quartzJobName}
    schedule (schedule : /data/otn/schedule/{quartzJobName})
    schedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    quartzJobName required quartzJobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/{quartzJobName}
    schedule (schedule : /data/otn/{quartzJobName})
    schedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    quartzJobName required quartzJobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /otn/schedule/{quartzJobName}
    schedule (schedule : /otn/schedule/{quartzJobName})
    schedule

    Path parameters

    Name

    IsRequired

    Description

    Enum

    quartzJobName required quartzJobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobScheduleWrapperConfig String ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/otdr
    scheduleOtdr (scheduleOtdr : /data/otn/otdr)
    scheduleOtdr

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/schedule/otdr
    scheduleOtdr (scheduleOtdr : /data/otn/schedule/otdr)
    scheduleOtdr

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /otn/schedule/otdr
    scheduleOtdr (scheduleOtdr : /otn/schedule/otdr)
    scheduleOtdr

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/otdr/darkfiber
    scheduleOtdrScanOnDarkFibers (scheduleOtdrScanOnDarkFibers : /data/otn/otdr/darkfiber)
    scheduleOtdrScanOnDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /data/otn/schedule/otdr/darkfiber
    scheduleOtdrScanOnDarkFibers (scheduleOtdrScanOnDarkFibers : /data/otn/schedule/otdr/darkfiber)
    scheduleOtdrScanOnDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Operation

    post /otn/schedule/otdr/darkfiber
    scheduleOtdrScanOnDarkFibers (scheduleOtdrScanOnDarkFibers : /otn/schedule/otdr/darkfiber)
    scheduleOtdrScanOnDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrScanInfo String ---
    body2 optional httpSession HttpSession ---

    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
    • application/xml

    External Docs
    See Also :

    Entry«string,JobHistoryConfiguration»

    Name

    Type

    Description

    Enum

    key JobHistoryConfiguration JobHistoryConfiguration --- ---

    JobDetailConfiguration

    Name

    Type

    Description

    Enum

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

    JobDetails

    Name

    Type

    Description

    Enum

    id Long long id can be retrieved from the REST call '/otn/schedule/job/name?name={jobname}' ---
    jobName String string User specified name of the job ---
    qrtzJobName String string Specifies type of job as in quartz framework like 'OTDR-SCAN-JOB' for OTDR ---
    qrtzJobGroup String string Specifies the Quartz Group of the job, default group name would be qrtzJobName + -ALU-OMS-QRTZ-JOB-GROUP ---
    qrtzTriggerName String string Specifies the Quartz Trigger name defaulted to jobName ---
    qrtzTriggerGroup String string Specifies the Quartz Trigger Group,default group name would be qrtzTriggerName + -ALU-OMS-QRTZ-JOB-GROUP ---
    nextFireTime Date DateTime Specifies the next job runtime ---
    repeatCountMax Long long Specifies the number of repititions of the job which depends on frequency:'type' and ends:'type' of the job ---
    executions Long long Specifies the number of executions completed ---
    jobDetailState String string Specifies the current state of the job [SCHEDULED, COMPLETE, PAUSED, DELETED, INPROGRESS, FAILED]
    endsOn Date DateTime Specifies the end date based on ends 'type' of the job (null if ends type is No of Events,Never or user specified end date if otherwise ---
    scheduledDetails String string Specifies various details of the scheduled job ---
    createdAt Date DateTime Specifies the creation date of the job ---
    version Integer integer Version ---
    jobCode Long long Specifies the quartz job code for the job like '1' for 'OTDR-SCAN-JOB' ---
    jobListHandle Long long 'jobListHandle' can be retrieved as 'jobId' from the REST call '/esmBrowser/jobList/GetJobList/{clientZoneOffset}' ---
    objectHandleId Long long 'objectHandleId' can be retrieved as 'id' from the REST call 'data/npr/physicalConns' ---

    JobHistory

    Name

    Type

    Description

    Enum

    id Long long Specifies the historyId retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' ---
    jobDetails JobDetails JobDetails Specifies the details of the job ---
    startTime Date DateTime Specifies the start time of the job in the format HH:MM:SS ---
    endTime Date DateTime Specifies the end time of the job in the format HH:MM:SS ---
    previousFireTime Date DateTime Specifies the start time of the previous run of the job ---
    scheduledStartTime Date DateTime Specifies the start time of the very first schedule of the job ---
    jobHistoryStatus String string Specifies the status of the latest run of the job [IN_PROGRESS, SUCCESS, FAILURE, PARTIALLY_FAILED, MISFIRED, STOPPED, OTHER]
    failureReason String string Specifies the failure reason if any,for the latest run of the job (will be null otherwise) ---
    notes String string Specifies the notes if any, for the latest run of the job (will be null otherwise) ---
    poll Boolean boolean Indicates if the job is polled or not ---
    jobPollHistory JobPollHistory JobPollHistory Indicates the poll history of the job ---
    statusDesc String string Status Description ---
    version Integer integer Version ---

    JobHistoryConfiguration

    Name

    Type

    Description

    Enum

    key String string Key ---
    value String string Value ---
    state String string State ---
    id Long long id ---

    JobHistoryRunDetails

    Name

    Type

    Description

    Enum

    id Long long Specifies the jobHistoryId which can be retrieved as 'id' from the REST call '/otn/schedule/{jobDetailsId}/history/{page}/{pageSize}' ---
    jobHistory JobHistory JobHistory Specifies the History of the job ---
    name String string Name ---
    input String string Input ---
    ouput String string Output ---
    inputClass String string InputClass ---
    outputClass String string OutputClass ---
    createdAt Date DateTime CreatedAt ---
    version Integer integer Version ---
    endTime Date DateTime EndTime ---

    JobPollHistory

    Name

    Type

    Description

    Enum

    id Long long id ---
    jobPollStatus String string JobPollStatus [INITIAL, IN_PROGRESS, COMPLETE, STOPPED]
    count Long long Count ---
    repeat Long long Repeat ---
    notes String string Notes ---

    OtdrJobListBean

    Name

    Type

    Description

    Enum

    id Long long --- ---
    pcName String string --- ---

    OtdrResponse

    Name

    Type

    Description

    Enum

    statusCode Integer integer --- ---
    message String string --- ---
    responseObject Object object --- ---

    SearchResult«JobDetails»

    Name

    Type

    Description

    Enum

    numberOfElements Integer integer number of elements ---
    last Boolean boolean last ---
    totalPages Integer integer total pages ---
    first Boolean boolean first ---
    total Long long total ---
    size Integer integer Size ---
    content array[JobDetails] JobDetails content ---
    number Integer integer Number ---

    SearchResult«JobHistoryRunDetails»

    Name

    Type

    Description

    Enum

    numberOfElements Integer integer number of elements ---
    last Boolean boolean last ---
    totalPages Integer integer total pages ---
    first Boolean boolean first ---
    total Long long total ---
    size Integer integer Size ---
    content array[JobHistoryRunDetails] JobHistoryRunDetails content ---
    number Integer integer Number ---

    SearchResult«JobHistory»

    Name

    Type

    Description

    Enum

    numberOfElements Integer integer number of elements ---
    last Boolean boolean last ---
    totalPages Integer integer total pages ---
    first Boolean boolean first ---
    total Long long total ---
    size Integer integer Size ---
    content array[JobHistory] JobHistory content ---
    number Integer integer Number ---

    Void

    Name

    Type

    Description

    Enum