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
Example Request Data
/data/plat/br/jobs/{jobId}
Produces
*/*
Example Response Data
{ "ok": true, "id": "77649318356908", "responseMessage": "ok", "responseList": null, "HTTPResponse": 200, "httpresponse": 200 }
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 | --- |
Example Request Data
GET: /data/plat/backups
Produces
*/*
Example Response Data
[{ "guiLabel": "ALL", "className": "Backup", "status": "plat_Not_Started", "description": "", "destination": "", "lastExecution": null, "backupCreation": "2019-11-07T08:18:20.000Z", "percentage": "0%", "supportedDataTypes": "Log,Operator,SystemConfiguration,SWDL,Alarm,PM,Network", "domain": "OTNE_1-19", "id": 1 }, { "guiLabel": "Operator", "className": "Backup", "status": "plat_Not_Started", "description": "", "destination": "", "lastExecution": null, "backupCreation": "2019-11-07T09:14:55.000Z", "percentage": "0%", "supportedDataTypes": "Operator", "domain": "OTNE_1-19", "id": 2 }, { "guiLabel": "SystemConfiguration", "className": "Backup", "status": "plat_Not_Started", "description": "", "destination": "", "lastExecution": null, "backupCreation": "2019-11-07T09:16:15.000Z", "percentage": "0%", "supportedDataTypes": "SystemConfiguration", "domain": "OTNE_1-19", "id": 3 }, { "guiLabel": "Log", "className": "Backup", "status": "plat_Not_Started", "description": "", "destination": "", "lastExecution": null, "backupCreation": "2019-11-07T09:17:08.000Z", "percentage": "0%", "supportedDataTypes": "Log", "domain": "OTNE_1-19", "id": 4 }, { "ObjectId": 5, "EventType": "Add", "guiLabel": "ALL", "className": "Backup", "status": "plat_Not_Started", "description": "", "destination": "", "lastExecution": null, "backupCreation": "2019-11-15T10:18:25.000Z", "percentage": "0%", "supportedDataTypes": "Log,Operator,SystemConfiguration,SWDL,Alarm,PM,Network", "domain": "OTNE_1-19", "id": 5 } ]
External Docs
Operation
post /data/plat/ts/tasks/newtask
Syntax ex{'name':'backup log','command':'Backup_Log','localtime':'2020-01-07 09:45:36 GMT+01:00','activate':'plat_task_active','startAt':'2020-01-07 09:45:36','stopAt':'2020-01-10 09:45:36','timezone':'local','rep':'00:00:30:00','weekend':'N','comment':''}name :Name of Scheduled task
command :Backup_
localtime :time with GMT
activate: plat_task_active/plat_task_inactive
startAt: start Time
stopAt : stop Time
timezone':local
rep:repetion (dd:hh:mm:ss)
weekend:Y/N
comment: comment of new task
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
Example Request Data
https://{{serverIp}}:8443/oms1350/data/plat/ts/tasks/newtask Request Body { "Tag": "", "name": "backup", "command": "Backup_Log", "localtime": "2020-01-27 13:20:45 GMT+01:00", "activate": "plat_task_inactive", "startAt": "2020-01-27 13:20:45", "stopAt": "2020-01-30 13:20:45", "timezone": "local", "rep": "00:00:15:00", "weekend": "N", "comment": "" }
Produces
*/*
Example Response Data
{ "ok": true, "id": "1046854946724233", "responseMessage": null, "responseList": null, "HTTPResponse": 0, "httpresponse": 0 }
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
Backup
Name |
Type |
Description |
Enum |
---|---|---|---|
ObjectId | Integer integer |
--- | --- |
EventType | String string |
--- | --- |
ClassType | String string |
--- | --- |
IdClass | Integer integer |
--- | --- |
guiLabel | String string |
Restore Name | --- |
className | String string |
--- | --- |
status | String string |
Restore Status | --- |
description | String string |
Restore Description | --- |
destination | String string |
--- | --- |
lastExecution | String string |
Restore Last Execution Date | --- |
backupCreation | String string |
--- | --- |
percentage | String string |
--- | --- |
supportedDataTypes | String string |
Support Data Types(Log,Operator,SystemConfiguration,SWDL,Alarm,PM,Network) | --- |
domain | String string |
Restore Domain (OTNE_ |
--- |
id | Integer integer |
--- | --- |
BackupJob
Name |
Type |
Description |
Enum |
---|---|---|---|
ObjectId | Integer integer |
--- | --- |
EventType | String string |
--- | --- |
ClassType | String string |
--- | --- |
IdClass | Integer integer |
--- | --- |
guiLabel | String string |
Backup Name | --- |
className | String string |
--- | --- |
status | String string |
Backup Status | --- |
description | String string |
Backup Description | --- |
destination | String string |
Backup Destination | --- |
lastExecution | String string |
Backup Last Execution Date | --- |
backupCreation | String string |
--- | --- |
percentage | String string |
--- | --- |
supportedDataTypes | String string |
Support Data Types(Log,Operator,SystemConfiguration,SWDL,Alarm,PM,Network) | --- |
domain | String string |
Backup Domain (OTNE_ |
--- |
id | Integer integer |
--- | --- |