Skip to content

Oms API DELETE job history state

amc1999 edited this page May 6, 2024 · 4 revisions

DELETE state of model run job from history.

There are 2 method to delete a history records of model run job:

  • delete a single job history record by specific model run submission time stamp
  • delete all history records of successfuly completed jobs or history of not successful jobs

It does NOT delete actual model run data, output tables and run parameters are NOT deleted from database. Only history record of model run job is deleted.

Methods:

DELETE /api/service/job/delete/history/:job

DELETE /api/service/job/delete/history-all/:success

Arguments:

:job - (required) model run submission time stamp
:success - (required) `true` of `false` boolean flag, use `true` to delete history successfuly completed jobs

Call examples:

Delete a history record of job 2022_09_13_23_20_50_995:

curl -v -X DELETE http://localhost:4040/api/service/job/delete/history/2022_09_13_23_20_50_995

*   Trying 127.0.0.1:4040...
* Connected to localhost (127.0.0.1) port 4040 (#0)
> DELETE /api/service/job/delete/history/2022_09_13_23_20_50_995 HTTP/1.1
> Host: localhost:4040
> User-Agent: curl/7.83.1
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Content-Location: /api/service/job/delete/history/2022_09_13_23_20_50_995
< Date: Wed, 14 Sep 2022 03:24:17 GMT
< Content-Length: 0

Delete all history records of successfuly completed jobs:

curl -v -X DELETE http://localhost:4040/api/service/job/delete/history-all/true

*   Trying [::1]:4040...
* Connected to localhost (::1) port 4040
> DELETE /api/service/job/delete/history-all/true HTTP/1.1
> Host: localhost:4040
> User-Agent: curl/8.4.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Location: /api/service/job/delete/history-all-success/1
< Date: Mon, 06 May 2024 18:46:02 GMT
< Content-Length: 0

Home

Getting Started

Model development in OpenM++

Using OpenM++

Model Development Topics

OpenM++ web-service: API and cloud setup

Using OpenM++ from Python and R

Docker

OpenM++ Development

OpenM++ Design, Roadmap and Status

OpenM++ web-service API

GET Model Metadata

GET Model Extras

GET Model Run results metadata

GET Model Workset metadata: set of input parameters

Read Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata as CSV

GET Modeling Task metadata and task run history

Update Model Profile: set of key-value options

Update Model Workset: set of input parameters

Update Model Runs

Update Modeling Tasks

Run Models: run models and monitor progress

Download model, model run results or input parameters

Upload model runs or worksets (input scenarios)

Download and upload user files

User: manage user settings

Model run jobs and service state

Administrative: manage web-service state

Clone this wiki locally