Operation

post /esmService/commonJobs/createJobService
createJobService (createJobService : /esmService/commonJobs/createJobService)
createJobService

Request body

Name

IsRequired

Description

Data Type

Enum

body optional req CommonJobListData ---

Return type
  • Response Header Model
  • Responses

    Response Messages

    Schema

    200success Response Header Model
    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 /esmService/commonJobs/createJobTaskService
    createJobTaskService (createJobTaskService : /esmService/commonJobs/createJobTaskService)
    createJobTaskService

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CommonJobTaskListData ---

    Return type
  • CommonJobTaskData
  • Responses

    Response Messages

    Schema

    200success CommonJobTaskData
    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 /esmService/commonJobs/createTaskInfo
    createTaskInfo (createTaskInfo : /esmService/commonJobs/createTaskInfo)
    createTaskInfo

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CommonTaskInfo ---

    Return type
  • CommonTaskInfo
  • Responses

    Response Messages

    Schema

    200success CommonTaskInfo
    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 /esmService/commonJobs/updateJob
    updateJob (updateJob : /esmService/commonJobs/updateJob)
    updateJob

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CommonJobListData ---

    Return type
  • Response Header Model
  • Responses

    Response Messages

    Schema

    200success Response Header Model
    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 /esmService/commonJobs/updateJobState
    updateJobState (updateJobState : /esmService/commonJobs/updateJobState)
    updateJobState

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobIdList array[Long] ---

    Return type
  • Response Header Model
  • Responses

    Response Messages

    Schema

    200success Response Header Model
    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 /esmService/commonJobs/updateJobTask
    updateJobTask (updateJobTask : /esmService/commonJobs/updateJobTask)
    updateJobTask

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CommonJobTaskListData ---

    Return type
  • Response Header Model
  • Responses

    Response Messages

    Schema

    200success Response Header Model
    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 /esmService/commonJobs/updateTaskInfo
    updateTaskInfo (updateTaskInfo : /esmService/commonJobs/updateTaskInfo)
    updateTaskInfo

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req CommonTaskInfo ---

    Return type
  • Response Header Model
  • Responses

    Response Messages

    Schema

    200success Response Header Model
    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 :

    CommonJobListData

    Name

    Type

    Description

    Enum

    objectHandle Long long --- ---
    objectName String string --- ---
    objectType String string --- [ESM_ERP, ESM_SERVICE, ESM_PORT, ESM_ERP_SERVICE, ESM_LAG, ESM_MCLAG, ESM_OAM_TEST, ESM_NETWORK, ESM_OAM_TEST_CASE, ESM_SYNC, OTN_INFRASTRUCTURE, OTN_SERVICE, OTN_PATH_SYNC, ESM_RMDDISCOVER, ESM_RMD, OTDR_SCAN, ASON_NPA, ASON_TELINK, ASON_LINK, ASON_SNC, ASON_CTRPLANE, ESM_MPLSTP_NPA, ESM_MPLSTP_TUNNEL, ESM_MPLSTP_NPA_PACK, ESM_MPLSTP_CHANNEL, ESM_QOS, PHYSICAL_LINK, LICENSE_MGMT, CHANGE_NE_PASSWORD, ESM_MUTIPORT_QOS, PING_SWEEP, ESM_SAT, ESM_PACKET_SWITCH, PM_BIN, IMPORT_FIBER, SET_TIME_ZONE, GRI, CURRENT_PM, TCM, CPM_TCA, SET_SYNC_PROTOCOL, OTN_ELINE_LINK, PHYSICAL_CONNECTION, DARKFIBER_LINK, ASON_REVERSION, OTDR_CUSTOM_PROFILE, SYNC, DF_OTDR_SCAN, FULL_SYNC, NEPARAM_SYNC, CLUSTER_SYNC, EQUIPMENT_SYNC, PORT_SYNC, ALARM_SYNC, INTERNALTL_SYNC, PG_SYNC, CROSSCONNECTION_SYNC, SUBNETWORKCONNECTION_SYNC, PATH_SYNC, TXPARAM_SYNC, ASAP_SYNC, ETHERNETPORT_SYNC, ENABLE_LLDP, External_TL_Discovery, NTSM_TIME_DISTRIBUTION_SERVICE, NTSM_FREQ_DISTRIBUTION_SERVICE, NTSM_SYNC, NTSM_DISCOVERY, PING_NODE, CREATE_NODE, MODIFY_NODE, DELETE_NODE, START_SUP, STOP_SUP, PACK_PAIR, MODIFY_PM, ESM_HEALTH_CHECK, ESM_HEALTH_CHECK_OAM, NES, FAILED_SYNC, BROADCAST_DROP_POINT, SHAREDRISKGROUP, CORRELATE_PROFILE, UNCORRELATE_PROFILE, NETWORK_TRANSFORMATION, REVERSIONGROUP]
    jobType String string --- [CREATE, DELETE, MODIFY, SYNC, MOVEBACKTOALLOATE, ACTIVATE, DEACTIVATE, FORCECOMPLETE, FORCEACTIVESTANDBY, CLEARACTIVESTANDBY, DISCOVERY, EXECUTION, CANCELLATION, ABORTION, SCHEDULER, RESET, SWITCH, CLEARSWITCH, ASSIGN, UNASSIGN, IMPLEMENT, DEIMPLEMENT, ADDDATA, GETDATA, INSERT, FORCESWITCH, MANUALSWITCH, LOCKOUT, SAT, FORCE_DEPLOY, STOP_SAT, CLEANUP_SAT, DELETE_SAT_PROFILE, UNDEPLOYANDDELETE, CLEAR_PM_BIN, IMPORT_FIBER, COMPUTE_LATENCY, CONFIGURE_SOAM, DETACH_CLIENTS, REATTACH_CLIENTS, ASSOCIATE, DISSOCIATE, TCM, PACK_SWAP, RETRIEVE, SET_TP, CORRELATE, SET_TCA, UNCORRELATE_TP, UNCORRELATE_DELETE, ENABLE_PM, DISABLE_PM, IMPLEMENTATION, ALLOCATED, COMMISSIONED, SUPERVISION, STOP_SUPERVISION, ADD, REMOVE, MOVENE, CORRELATE_REPORT_PROFILE, UNCORRELATE_REPORT_PROFILE, MOVE_TRAFFIC, INSERT_NODE, REMOVE_NODE, PORT_STAT_RESET, CERT_UPLOAD, CERT_DELETE]
    taskName String string --- ---
    taskDetails String string --- ---
    description String string --- ---
    jobId array[Long] long --- ---
    state String string --- [S_NOT_APPLICABLE, S_CREATED, S_COMPLETED, S_FAILED, S_TIMEOUT, S_INPROGRESS, S_INEXEPROGRESS, S_INUNEXEPROGRESS, S_SUCCESS, S_ABORT, S_SKIPPED, S_WARNING]
    startTime Long long --- ---
    endTime Long long --- ---
    schedulerRequest CommonJobSchedulerData CommonJobSchedulerData --- ---
    commonJobTaskData array[CommonJobTaskData] CommonJobTaskData --- ---

    CommonJobSchedulerData

    Name

    Type

    Description

    Enum

    trigger CommonJobTriggerData CommonJobTriggerData --- ---
    jobName String string --- ---
    jobDescription String string --- ---
    userName String string --- ---

    CommonJobTaskData

    Name

    Type

    Description

    Enum

    taskName String string --- ---
    jobId Long long --- ---
    taskId Long long --- ---
    objectHandle Long long --- ---
    status String string --- [SUCCESS, PARTIAL, FAILURE, INPROGRESS, SCHEDULED, ABORTED, EXPIRED]
    startTime Long long --- ---
    endTime Long long --- ---
    taskDetails String string --- ---
    scheduler CommonJobSchedulerData CommonJobSchedulerData --- ---

    CommonJobTaskListData

    Name

    Type

    Description

    Enum

    objectHandle Long long --- ---
    objectName String string --- ---
    objectType String string --- [ESM_ERP, ESM_SERVICE, ESM_PORT, ESM_ERP_SERVICE, ESM_LAG, ESM_MCLAG, ESM_OAM_TEST, ESM_NETWORK, ESM_OAM_TEST_CASE, ESM_SYNC, OTN_INFRASTRUCTURE, OTN_SERVICE, OTN_PATH_SYNC, ESM_RMDDISCOVER, ESM_RMD, OTDR_SCAN, ASON_NPA, ASON_TELINK, ASON_LINK, ASON_SNC, ASON_CTRPLANE, ESM_MPLSTP_NPA, ESM_MPLSTP_TUNNEL, ESM_MPLSTP_NPA_PACK, ESM_MPLSTP_CHANNEL, ESM_QOS, PHYSICAL_LINK, LICENSE_MGMT, CHANGE_NE_PASSWORD, ESM_MUTIPORT_QOS, PING_SWEEP, ESM_SAT, ESM_PACKET_SWITCH, PM_BIN, IMPORT_FIBER, SET_TIME_ZONE, GRI, CURRENT_PM, TCM, CPM_TCA, SET_SYNC_PROTOCOL, OTN_ELINE_LINK, PHYSICAL_CONNECTION, DARKFIBER_LINK, ASON_REVERSION, OTDR_CUSTOM_PROFILE, SYNC, DF_OTDR_SCAN, FULL_SYNC, NEPARAM_SYNC, CLUSTER_SYNC, EQUIPMENT_SYNC, PORT_SYNC, ALARM_SYNC, INTERNALTL_SYNC, PG_SYNC, CROSSCONNECTION_SYNC, SUBNETWORKCONNECTION_SYNC, PATH_SYNC, TXPARAM_SYNC, ASAP_SYNC, ETHERNETPORT_SYNC, ENABLE_LLDP, External_TL_Discovery, NTSM_TIME_DISTRIBUTION_SERVICE, NTSM_FREQ_DISTRIBUTION_SERVICE, NTSM_SYNC, NTSM_DISCOVERY, PING_NODE, CREATE_NODE, MODIFY_NODE, DELETE_NODE, START_SUP, STOP_SUP, PACK_PAIR, MODIFY_PM, ESM_HEALTH_CHECK, ESM_HEALTH_CHECK_OAM, NES, FAILED_SYNC, BROADCAST_DROP_POINT, SHAREDRISKGROUP, CORRELATE_PROFILE, UNCORRELATE_PROFILE, NETWORK_TRANSFORMATION, REVERSIONGROUP]
    jobType String string --- [CREATE, DELETE, MODIFY, SYNC, MOVEBACKTOALLOATE, ACTIVATE, DEACTIVATE, FORCECOMPLETE, FORCEACTIVESTANDBY, CLEARACTIVESTANDBY, DISCOVERY, EXECUTION, CANCELLATION, ABORTION, SCHEDULER, RESET, SWITCH, CLEARSWITCH, ASSIGN, UNASSIGN, IMPLEMENT, DEIMPLEMENT, ADDDATA, GETDATA, INSERT, FORCESWITCH, MANUALSWITCH, LOCKOUT, SAT, FORCE_DEPLOY, STOP_SAT, CLEANUP_SAT, DELETE_SAT_PROFILE, UNDEPLOYANDDELETE, CLEAR_PM_BIN, IMPORT_FIBER, COMPUTE_LATENCY, CONFIGURE_SOAM, DETACH_CLIENTS, REATTACH_CLIENTS, ASSOCIATE, DISSOCIATE, TCM, PACK_SWAP, RETRIEVE, SET_TP, CORRELATE, SET_TCA, UNCORRELATE_TP, UNCORRELATE_DELETE, ENABLE_PM, DISABLE_PM, IMPLEMENTATION, ALLOCATED, COMMISSIONED, SUPERVISION, STOP_SUPERVISION, ADD, REMOVE, MOVENE, CORRELATE_REPORT_PROFILE, UNCORRELATE_REPORT_PROFILE, MOVE_TRAFFIC, INSERT_NODE, REMOVE_NODE, PORT_STAT_RESET, CERT_UPLOAD, CERT_DELETE]
    taskName String string --- ---
    taskDetails String string --- ---
    description String string --- ---
    jobId array[Long] long --- ---
    state String string --- [S_NOT_APPLICABLE, S_CREATED, S_COMPLETED, S_FAILED, S_TIMEOUT, S_INPROGRESS, S_INEXEPROGRESS, S_INUNEXEPROGRESS, S_SUCCESS, S_ABORT, S_SKIPPED, S_WARNING]
    startTime Long long --- ---
    endTime Long long --- ---
    schedulerRequest CommonJobSchedulerData CommonJobSchedulerData --- ---
    commonJobTaskData array[CommonJobTaskData] CommonJobTaskData --- ---
    jobHandle Long long --- ---
    jobTaskData array[CommonJobTaskData] CommonJobTaskData --- ---
    latestTaskStatus String string --- [SUCCESS, PARTIAL, FAILURE, INPROGRESS, SCHEDULED, ABORTED, EXPIRED]
    jobState String string --- [SCHEDULED, INPROGRESS, ABORTED, EXPIRED, COMPLETED, DELETED, PAUSED]
    jobName String string --- ---

    CommonJobTriggerData

    Name

    Type

    Description

    Enum

    triggerName String string --- ---
    triggerType String string --- ---
    deployType String string --- ---
    startTime Date DateTime --- ---
    offset String string --- ---
    expression String string --- ---

    CommonTaskInfo

    Name

    Type

    Description

    Enum

    taskName String string --- ---
    taskDetail String string --- ---
    status String string --- [S_NOT_APPLICABLE, S_CREATED, S_COMPLETED, S_FAILED, S_TIMEOUT, S_INPROGRESS, S_INEXEPROGRESS, S_INUNEXEPROGRESS, S_SUCCESS, S_ABORT, S_SKIPPED, S_WARNING]
    errorReason String string --- ---
    parentId Long long --- ---
    taskType String string --- [TASK, SUBTASK]
    startTime Long long --- ---
    endTime Long long --- ---
    taskHandle array[Long] long --- ---

    Request Header

    Name

    Type

    Description

    Enum

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

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---
    output Object object --- ---