Operation

post /swim/jobs
Create Job (createJob : /swim/jobs)
Based on the input provided, Immediate/Deffered Backup/Download/Restore/Partial Download job is created.

Request body

Name

IsRequired

Description

Data Type

Enum

body optional Complete job details SwimJobInputReqModel ---

Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    { "jobName":"Backup-222", "jobType":"Backup", "jobActivationType":"Immediate", "jobNEList":[ { "neLabel":"PSS_177", "neType":"1830PSS-PHN", "neId":"21", "protocol":"SFTP", "ipAddress":"", "userId":"", "password":"", "backupFilePath":"/", "externalServer":false }, { "neLabel":"1830TDMX-BA-01", "neType":"1830PSS-TDMX", "neId":"41", "protocol":"SFTP", "ipAddress":"", "userId":"", "password":"", "backupFilePath":"/", "externalServer":false } ], "misc":{ "activateJob":"TRUE", "activateType":"FALSE", "timeZnOffset":-330 } }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "identifier":"Backup-222", "items":null, "status":"OK" }

    External Docs
    See Also :

    Operation

    put /swim/jobs/deleteCards
    Delete Cards from the Job.. (deleteCardsForJob : /swim/jobs/deleteCards)
    This method is used to deleting Cards from the job.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional cardMap ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    put /swim/jobs/delete
    Delete Job(s) (deleteJob : /swim/jobs/delete)
    Delete is performed on single or multiple jobs with the job names give as input parameter jobNames(comma separated values). ResponseDt contains the attribute (Status) to tell whether the operation was successful or not.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional Job names to be deleted (comma separated values) String ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    oms1350/swim/jobs/delete?request.preventCache=1470508811439 Request Payload Test-1,swdl_job,Bckp,Test-222

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"identifier":null,"items":null,"status":"Success"}

    External Docs
    See Also :

    Operation

    put /swim/jobs/deleteNes
    Delete NEs from the Job.. (deleteNeForJob : /swim/jobs/deleteNes)
    This method is used to deleting Nes from the job.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional neMap ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    put /swim/jobs
    Operation for managing job. (manageJob : /swim/jobs)
    This method is used to perform various operation on the job. Based on the input provided, it will Activate or Abort the job.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional Job details to be modified JobStatsModel ---

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    {"jobName":"bbb","jobstatus":"Activate"}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"identifier":null,"items":null,"status":"Success"}

    External Docs
    See Also :

    CardJobStat

    Name

    Type

    Description

    Enum

    loadState String string --- ---
    jobId String string --- ---
    key String string --- ---
    neId String string --- ---
    emlNeId String string --- ---
    emlDomainid String string --- ---
    neLabel String string --- ---
    neType String string --- ---
    cardLocation String string --- ---
    shelf String string --- ---
    slot String string --- ---
    cardName String string --- ---
    activeRelease String string --- ---
    provisionedRealse String string --- ---
    hitlessLoadState String string --- ---
    hitlessUpgrade String string --- ---
    cardStatus String string --- ---
    cardStatrtTime Long long --- ---
    cardEndTime Long long --- ---
    activedOn Long long --- ---
    provisionedOn Long long --- ---
    elpsesdTime Long long --- ---
    hitlessElpasedTime Long long --- ---
    errorReason String string --- ---
    loadSate String string --- ---
    id String string --- ---

    JobCardListModel

    Name

    Type

    Description

    Enum

    neId String string --- ---
    neLabel String string --- ---
    neType String string --- ---
    cardId String string --- ---
    cardLocation String string --- ---
    cardName String string --- ---
    activeRelease String string --- ---
    activedOn String string --- ---
    provisionedOn String string --- ---
    provisionedRealse String string --- ---
    loadSate String string --- ---
    elpsesdTime String string --- ---
    hitlessLoadState String string --- ---
    hitlessElpasedTime String string --- ---
    hitlessUpgrade String string --- ---

    JobNeListModel

    Name

    Type

    Description

    Enum

    neLabel String string Ne label attribute ---
    neType String string Ne Type attribute ---
    neId String string Ne Id attribute ---
    swVersion String string Sw Version attribute ---
    serverName String string Server Name attribute ---
    swforced String string SW forced attribute ---
    targetNe String string Target Ne attribute ---
    backupFileName String string Backup file Name attribute ---
    misAligmentFlag Boolean boolean Mis Alignment flag attribute ---
    selectedCardType String string Selected card type attribute ---
    step Integer integer Step attribute ---
    protocol String string Porotocl attribute ---
    ipAddress String string Ip Address attribute ---
    userId String string UserId attribute ---
    password String string Password attribute ---
    backupFilePath String string External backup file path attribute ---
    externalServer String string External Server attribute ---
    gneId String string GneId attribute ---
    gneGroupId String string gneGroupId attribute ---

    JobPropertiesModel

    Name

    Type

    Description

    Enum

    activateJob String string activate job attribute ---
    activateType String string activate Type attribute ---
    modifyDetails String string Modify Details attribute ---
    timeZnOffset Integer integer TimeZone offset attribute ---
    serverTimeZoneOffset String string --- ---

    JobStatsModel

    Name

    Type

    Description

    Enum

    jobid Long long Job Id attribute ---
    id String string --- ---
    jobName String string Job Name attribute ---
    jobType String string Job Type attribute ---
    jobActivationType String string Activation Type attribute ---
    duration Integer integer Duration attribute ---
    starttime Long long Start time attribute ---
    completionTime Long long Completion time attribute ---
    activationtime Long long Activation time attribute ---
    jobstatus String string Job Status attribute ---
    periodic String string Periodic attribute ---
    jobNEList array[NEJobStatModel] NEJobStatModel Job Ne List attribute ---
    jobCardList array[CardJobStat] CardJobStat Job Card List attribute ---
    date String string Date attribute ---
    time String string Time attribute ---
    dayOfWeek String string Day of Week attribute ---
    scheduledStartTime Long long Scheduled start time attribute ---
    jobStep Integer integer Job Step attribute ---
    serverTime String string --- ---
    key String string --- ---
    jobTry Integer integer --- ---

    NEJobStatModel

    Name

    Type

    Description

    Enum

    jobId String string --- ---
    key String string --- ---
    neLabel String string Ne Label attribute ---
    neType String string Ne Type attribute ---
    neId String string Ne Id attribute ---
    swVersion String string Sw Version attribute ---
    swName String string SW Name attribute ---
    serverName String string Server Name attribute ---
    swforced String string SW forced attribute ---
    selectedCardType String string Selected card type attribute ---
    progressPercentage Integer integer Progress percentage attribute ---
    swUnit String string SW Unit attribute ---
    misAligmentFlag String string Mis Alignment flag attribute ---
    totalBytes String string Totoal Bytes attribute ---
    protocol String string --- ---
    ipAddress String string --- ---
    userId String string --- ---
    password String string --- ---
    backupFilePath String string --- ---
    externalServer String string --- ---
    backupFileName String string Backup File name attribute ---
    mibActFlag String string Mib Activation Flag attribute ---
    neRelease String string Ne Release attribute ---
    restoreForced String string Restore forced attribute ---
    result String string Result attribute ---
    startDate Long long Start Date attribute ---
    endDate Long long End Date attribute ---
    step Integer integer Step attribute ---
    neStatus String string Ne Status attribute ---
    id String string --- ---

    ResponseDtModel

    Name

    Type

    Description

    Enum

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

    Serializable

    Name

    Type

    Description

    Enum

    SwimJobInputReqModel

    Name

    Type

    Description

    Enum

    jobName String string Job Name attribute ---
    jobType String string Job Type attribute ---
    jobActivationType String string Job Activation Type attribute ---
    duration String string Duration attribute ---
    periodic String string Periodic attribute ---
    time String string Time attribute ---
    date String string Date attribute ---
    dayOfWeek String string Day of the week attribute ---
    jobNEList array[JobNeListModel] JobNeListModel Job Ne List attribute ---
    jobCardList array[JobCardListModel] JobCardListModel Job Card List attribute ---
    misc JobPropertiesModel JobPropertiesModel Misc attribute ---