Operation
put /data/plat/ts/tasks/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
post /data/plat/br/jobs/{jobId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
delete /data/plat/br/backups/{jobId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
delete /data/plat/ts/tasks/deletetask/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
post /data/plat/ts/tasks/disable/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
post /data/plat/ts/tasks/enable/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
post /data/plat/fullSnap
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
get /data/plat/ts/tasks/gettime
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/fullSnap
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/jobs
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[BackupJob]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/backups
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[Backup]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/tasks
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ScheduledTask]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
post /data/plat/ts/tasks/newtask
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
body3 | optional | form | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
Operation
get /data/plat/br/jobs/{jobId}/status
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
Responses
Response Messages |
Schema |
---|---|
200success |
array[StatusJob]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/br/jobs/{jobId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
BackupJob
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/br/backups/{jobId}/status
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
Responses
Response Messages |
Schema |
---|---|
200success |
array[StatusBackup]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/ts/tasks/allcommand
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/br/backups/{jobId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
Backup
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/ts/tasks/{id}/status
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
Responses
Response Messages |
Schema |
---|---|
200success |
array[ScheduledStatusTask]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/ts/tasks/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
array[ScheduledTask]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
get /data/plat/backups/reload
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | request | ServletWebRequest |
--- |
body2 | optional | session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[Backup]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
post /data/plat/br/backups/{jobId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
NprResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
*/*
External Docs
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 |
--- | --- |
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 |
--- | --- |
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 |
--- | --- |