Operation

get /esmBrowser/jobList/AbortJob/{jobName}/{offset}
abortJob (abortJob : /esmBrowser/jobList/AbortJob/{jobName}/{offset})
abortJob

Path parameters

Name

IsRequired

Description

Enum

jobName required jobName ---
offset required offset ---

Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/DeleteAllInprogressJobs
    deleteAllInprogressJob (deleteAllInprogressJob : /esmBrowser/jobList/DeleteAllInprogressJobs)
    deleteAllInprogressJob

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqObjHolder ReqObjHolder ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/DeleteJobList/{jobId}
    deleteJobList (deleteJobList : /esmBrowser/jobList/DeleteJobList/{jobId})
    deleteJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqObjHolder ReqObjHolder ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /esmBrowser/jobList/FetchJobListForIds/{clientZoneOffset}/{type}
    FetchJobListForIds (fetchJobListForIds : /esmBrowser/jobList/FetchJobListForIds/{clientZoneOffset}/{type})
    FetchJobListForIds

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    type required type ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional jobIdList array[String] ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

    200success JobListUIData
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobList/{clientZoneOffset}
    getJobList (getJobList : /esmBrowser/jobList/GetJobList/{clientZoneOffset})
    getJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobList/{clientZoneOffset}/{type}
    getJobList (getJobList : /esmBrowser/jobList/GetJobList/{clientZoneOffset}/{type})
    getJobList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    type required type ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListByObjectTypeAndObjectHandle/{objectType}/{objectHandle}
    getJobListByObjectTypeAndObjectHandle (getJobListByObjectTypeAndObjectHandle : /esmBrowser/jobList/GetJobListByObjectTypeAndObjectHandle/{objectType}/{objectHandle})
    getJobListByObjectTypeAndObjectHandle

    Path parameters

    Name

    IsRequired

    Description

    Enum

    objectType required objectType ---
    objectHandle required objectHandle ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListByObjectTypeAndObjectId/{objectType}/{objectHandle}/{clientZoneOffset}
    getJobListByObjectTypeAndObjectId (getJobListByObjectTypeAndObjectId : /esmBrowser/jobList/GetJobListByObjectTypeAndObjectId/{objectType}/{objectHandle}/{clientZoneOffset})
    getJobListByObjectTypeAndObjectId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    objectType required objectType ---
    objectHandle required objectHandle ---
    clientZoneOffset required clientZoneOffset ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListByObjectTypeAndObjectIdJ/{objectType}/{objectHandle}/{clientZoneOffset}
    getJobListByObjectTypeAndObjectIdJ (getJobListByObjectTypeAndObjectIdJ : /esmBrowser/jobList/GetJobListByObjectTypeAndObjectIdJ/{objectType}/{objectHandle}/{clientZoneOffset})
    getJobListByObjectTypeAndObjectIdJ

    Path parameters

    Name

    IsRequired

    Description

    Enum

    objectType required objectType ---
    objectHandle required objectHandle ---
    clientZoneOffset required clientZoneOffset ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListByObjectTypeObjectId/{objectType}/{objectHandle}/{clientZoneOffset}
    getJobListByObjectTypeObjectId (getJobListByObjectTypeObjectId : /esmBrowser/jobList/GetJobListByObjectTypeObjectId/{objectType}/{objectHandle}/{clientZoneOffset})
    getJobListByObjectTypeObjectId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    objectType required objectType ---
    objectHandle required objectHandle ---
    clientZoneOffset required clientZoneOffset ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListForId/{jobId}
    getJobListForId (getJobListForId : /esmBrowser/jobList/GetJobListForId/{jobId})
    getJobListForId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Query parameters

    Name

    IsRequired

    Description

    jobIdList optional ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListForName/{name}/{clientZoneOffset}
    getJobListForName (getJobListForName : /esmBrowser/jobList/GetJobListForName/{name}/{clientZoneOffset})
    getJobListForName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    name required name ---
    clientZoneOffset required clientZoneOffset ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type}
    getJobListJ (getJobListJ : /esmBrowser/jobList/GetJobListJ/{clientZoneOffset}/{type})
    getJobListJ

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    type required type ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobListJson/{type}
    getJobListJson (getJobListJson : /esmBrowser/jobList/GetJobListJson/{type})
    getJobListJson

    Path parameters

    Name

    IsRequired

    Description

    Enum

    type required type ---
    Query parameters

    Name

    IsRequired

    Description

    queryMap optional ---

    Return type
  • JobListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobRunHistory/{clientZoneOffset}/{jobId}
    getJobRunHistory (getJobRunHistory : /esmBrowser/jobList/GetJobRunHistory/{clientZoneOffset}/{jobId})
    getJobRunHistory

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobId required jobId ---

    Return type
  • JobRunListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobRunTaskList/{clientZoneOffset}/{jobId}/{runId}
    getJobRunTaskList (getJobRunTaskList : /esmBrowser/jobList/GetJobRunTaskList/{clientZoneOffset}/{jobId}/{runId})
    getJobRunTaskList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobId required jobId ---
    runId required runId ---

    Return type
  • JobTaskListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobRunTaskListJ/{clientZoneOffset}/{jobId}/{runId}
    getJobRunTaskListJ (getJobRunTaskListJ : /esmBrowser/jobList/GetJobRunTaskListJ/{clientZoneOffset}/{jobId}/{runId})
    getJobRunTaskListJ

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobId required jobId ---
    runId required runId ---

    Return type
  • JobTaskListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobTaskList/{clientZoneOffset}/{jobId}
    getJobTaskList (getJobTaskList : /esmBrowser/jobList/GetJobTaskList/{clientZoneOffset}/{jobId})
    getJobTaskList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobId required jobId ---

    Return type
  • JobTaskListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetJobTaskListJ/{clientZoneOffset}/{jobId}
    getJobTaskListJ (getJobTaskListJ : /esmBrowser/jobList/GetJobTaskListJ/{clientZoneOffset}/{jobId})
    getJobTaskListJ

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobId required jobId ---

    Return type
  • JobTaskListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetTaskSummaryList/{clientZoneOffset}/{jobTaskId}
    getTaskSummaryList (getTaskSummaryList : /esmBrowser/jobList/GetTaskSummaryList/{clientZoneOffset}/{jobTaskId})
    getTaskSummaryList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobTaskId required jobTaskId ---

    Return type
  • JobTaskSummaryListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/GetTaskSummaryListWithRecentFirst/{clientZoneOffset}/{jobTaskId}
    getTaskSummaryListWithRecentFirst (getTaskSummaryListWithRecentFirst : /esmBrowser/jobList/GetTaskSummaryListWithRecentFirst/{clientZoneOffset}/{jobTaskId})
    getTaskSummaryListWithRecentFirst

    Path parameters

    Name

    IsRequired

    Description

    Enum

    clientZoneOffset required clientZoneOffset ---
    jobTaskId required jobTaskId ---

    Return type
  • JobTaskSummaryListUIData
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/JobUserValidation/{jobId}
    jobUserValidation (jobUserValidation : /esmBrowser/jobList/JobUserValidation/{jobId})
    jobUserValidation

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /esmBrowser/jobList/RescheduleJob/{jobName}/{taskName}/{triggerExpression}/{offset}
    rescheduleJob (rescheduleJob : /esmBrowser/jobList/RescheduleJob/{jobName}/{taskName}/{triggerExpression}/{offset})
    rescheduleJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobName required jobName ---
    taskName required taskName ---
    triggerExpression required triggerExpression ---
    offset required offset ---

    Return type
  • ResponseHeader
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    JobListUIData

    Name

    Type

    Description

    Enum

    items array[JobUIData] JobUIData --- ---

    JobRunListUIData

    Name

    Type

    Description

    Enum

    jobRunData array[JobRunUIData] JobRunUIData --- ---

    JobRunUIData

    Name

    Type

    Description

    Enum

    runId Long long --- ---
    jobId Long long --- ---
    jobName String string --- ---
    jobDescription String string --- ---
    status String string --- ---
    startTime String string --- ---
    endTime String string --- ---
    duration Long long --- ---

    JobTaskListUIData

    Name

    Type

    Description

    Enum

    jobTaskData array[JobTaskUIData] JobTaskUIData --- ---
    items array[JobTaskUIData] JobTaskUIData --- ---

    JobTaskSummaryListUIData

    Name

    Type

    Description

    Enum

    items array[JobTaskSummaryUIData] JobTaskSummaryUIData --- ---
    identifier String string --- ---
    label String string --- ---

    JobTaskSummaryUIData

    Name

    Type

    Description

    Enum

    label String string --- ---
    taskDetail String string --- ---
    startTime String string --- ---
    endTime String string --- ---
    duration String string --- ---
    status String string --- ---
    errorReason String string --- ---
    id String string --- ---
    parent String string --- ---
    subTask String string --- ---
    esmVneLog String string --- ---
    hasChildren Boolean boolean --- ---

    JobTaskUIData

    Name

    Type

    Description

    Enum

    taskId Long long --- ---
    jobId Long long --- ---
    taskName String string --- ---
    taskDetails String string --- ---
    status String string --- ---
    startTime String string --- ---
    endTime String string --- ---
    duration Long long --- ---
    runId Long long --- ---
    taskType String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    JobUIData

    Name

    Type

    Description

    Enum

    jobName String string --- ---
    jobId Long long --- ---
    description String string --- ---
    jobType String string --- ---
    jobTypeStr String string --- ---
    userName String string --- ---
    latestTaskStatus String string --- ---
    schedule String string --- ---
    nextTask String string --- ---
    jobState String string --- ---
    createTime String string --- ---
    lastModificationTime String string --- ---
    runsExecuted Long long --- ---
    objType Long long --- ---
    appType String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---

    RequestHeader

    Name

    Type

    Description

    Enum

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

    ResponseHeader

    Name

    Type

    Description

    Enum

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