Operation

put /data/plat/ts/tasks/{id}
changetask (changetask : /data/plat/ts/tasks/{id})
changetask

Path parameters

Name

IsRequired

Description

Enum

id required id ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional request ServletWebRequest ---
body2 optional session HttpSession ---
body3 optional form String ---

Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /data/plat/br/jobs/{jobId}
    createJob (createJob : /data/plat/br/jobs/{jobId})
    createJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    delete /data/plat/br/backups/{jobId}
    deleteJob (deleteJob : /data/plat/br/backups/{jobId})
    deleteJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    delete /data/plat/ts/tasks/deletetask/{id}
    deletetask (deletetask : /data/plat/ts/tasks/deletetask/{id})
    deletetask

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /data/plat/ts/tasks/disable/{id}
    disabletask (disabletask : /data/plat/ts/tasks/disable/{id})
    disabletask

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /data/plat/ts/tasks/enable/{id}
    enabletask (enabletask : /data/plat/ts/tasks/enable/{id})
    enabletask

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    post /data/plat/fullSnap
    fullSnap (fullSnap : /data/plat/fullSnap)
    fullSnap

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/plat/ts/tasks/gettime
    getTimeFromServer (getTimeFromServer : /data/plat/ts/tasks/gettime)
    getTimeFromServer

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

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

    External Docs
    See Also :

    Operation

    get /data/plat/fullSnap
    getfullsnap (getfullsnap : /data/plat/fullSnap)
    getfullsnap

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

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

    External Docs
    See Also :

    Operation

    get /data/plat/jobs
    listJobs (listJobs : /data/plat/jobs)
    listJobs

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[BackupJob]
  • Responses

    Response Messages

    Schema

    200success array[BackupJob]
    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/plat/backups
    listrestoreJobs (listrestoreJobs : /data/plat/backups)
    listrestoreJobs

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Backup]
  • Responses

    Response Messages

    Schema

    200success array[Backup]
    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/plat/tasks
    listtasks (listtasks : /data/plat/tasks)
    listtasks

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[ScheduledTask]
  • Responses

    Response Messages

    Schema

    200success array[ScheduledTask]
    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/plat/ts/tasks/newtask
    newjob (newjob : /data/plat/ts/tasks/newtask)
    newjob

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Operation

    get /data/plat/br/jobs/{jobId}/status
    readBackupStaus (readBackupStaus : /data/plat/br/jobs/{jobId}/status)
    readBackupStaus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[StatusJob]
  • Responses

    Response Messages

    Schema

    200success array[StatusJob]
    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/plat/br/jobs/{jobId}
    readJob (readJob : /data/plat/br/jobs/{jobId})
    readJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • BackupJob
  • Responses

    Response Messages

    Schema

    200success BackupJob
    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/plat/br/backups/{jobId}/status
    readRestoreStatus (readRestoreStatus : /data/plat/br/backups/{jobId}/status)
    readRestoreStatus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[StatusBackup]
  • Responses

    Response Messages

    Schema

    200success array[StatusBackup]
    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/plat/ts/tasks/allcommand
    readallcommandFromServer (readallcommandFromServer : /data/plat/ts/tasks/allcommand)
    readallcommandFromServer

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

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

    External Docs
    See Also :

    Operation

    get /data/plat/br/backups/{jobId}
    readrproprestore (readrproprestore : /data/plat/br/backups/{jobId})
    readrproprestore

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • Backup
  • Responses

    Response Messages

    Schema

    200success Backup
    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/plat/ts/tasks/{id}/status
    readstatustaskid (readstatustaskid : /data/plat/ts/tasks/{id}/status)
    readstatustaskid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[ScheduledStatusTask]
  • Responses

    Response Messages

    Schema

    200success array[ScheduledStatusTask]
    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/plat/ts/tasks/{id}
    readtaskid (readtaskid : /data/plat/ts/tasks/{id})
    readtaskid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[ScheduledTask]
  • Responses

    Response Messages

    Schema

    200success array[ScheduledTask]
    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/plat/backups/reload
    reload (reload : /data/plat/backups/reload)
    reload

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Backup]
  • Responses

    Response Messages

    Schema

    200success array[Backup]
    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/plat/br/backups/{jobId}
    restoreJob (restoreJob : /data/plat/br/backups/{jobId})
    restoreJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

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

    External Docs
    See Also :

    Backup

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    className String string --- ---
    status String string --- ---
    description String string --- ---
    destination String string --- ---
    lastExecution String string --- ---
    backupCreation String string --- ---
    percentage String string --- ---
    supportedDataTypes String string --- ---
    domain String string --- ---
    id Integer integer --- ---

    BackupJob

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    className String string --- ---
    status String string --- ---
    description String string --- ---
    destination String string --- ---
    lastExecution String string --- ---
    backupCreation String string --- ---
    percentage String string --- ---
    supportedDataTypes String string --- ---
    domain String string --- ---
    id Integer integer --- ---

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---

    ScheduledStatusTask

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    cmd SJcmd SJcmd --- ---
    commandName String string --- ---
    guiLabel String string --- ---
    taskState String string --- ---
    status String string --- ---
    comments String string --- ---
    running String string --- ---
    domain String string --- ---
    start String string --- ---
    stop String string --- ---
    tz String string --- ---
    weekEnd String string --- ---
    rep String string --- ---
    id Integer integer --- ---
    rifId Integer integer --- ---
    className String string --- ---

    ScheduledTask

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    cmd SJcmd SJcmd --- ---
    commandName String string --- ---
    guiLabel String string --- ---
    taskState String string --- ---
    status String string --- ---
    comments String string --- ---
    running String string --- ---
    domain String string --- ---
    start String string --- ---
    stop String string --- ---
    tz String string --- ---
    weekEnd String string --- ---
    rep String string --- ---
    id Integer integer --- ---
    className String string --- ---

    SJcmd

    Name

    Type

    Description

    Enum

    name String string --- ---
    parameters array[String] string --- ---
    description String string --- ---
    command String string --- ---
    cmdName String string --- ---

    StatusBackup

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    className String string --- ---
    status String string --- ---
    lastExecution String string --- ---
    percentage String string --- ---
    domain String string --- ---
    description String string --- ---
    destination String string --- ---
    id Integer integer --- ---
    rifId Integer integer --- ---
    dataTypes String string --- ---

    StatusJob

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    className String string --- ---
    status String string --- ---
    lastExecution String string --- ---
    percentage String string --- ---
    domain String string --- ---
    description String string --- ---
    destination String string --- ---
    id Integer integer --- ---
    rifId Integer integer --- ---
    dataTypes String string --- ---