Delete Jobs
/essbase/rest/v1/jobs/purge
Deletes jobs data based on query parameters.
Request
-
application: string
Application name.
-
database: string
Database name.
-
jobstatus: integer(int32)
Job Status code.
Status code Meaning 100 In progress 200 Completed 300 Completed with warnings 400 Failed -
jobtype: string
The type of job. Examples:
dataload,dimbuild,calc,clear,importExcel,exportExcel,lcmExport,lcmImport,clearAggregation,buildAggregation,asoBufferDataLoad,asoBufferCommit,exportData,mdxScript. -
olderthan: integer(int64)
Time in milliseconds, if you want to remove jobs data older than the specified time.
-
rangeEndTime: integer(int64)
End Time range in milliseconds.
-
rangeStartTime: integer(int64)
Start Time range in milliseconds.
Response
- application/json
200 Response
OK
Purge request executed successfully.
500 Response
Internal Server Error.
503 Response
Service Unavailable
Naming exception or server exception.
Examples
The following example shows how to delete an Essbase job.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.
Script with cURL Command
This example purges the listing of all jobs that had successful status (200) against the Rating cube in the Facility application.
call properties.bat
curl -X DELETE "https://myserver.example.com:9001/essbase/rest/v1/jobs/purge?application=Facility&database=Rating&jobstatus=200" -H "accept:application/json" -u %User%:%Password%