Jump to: navigation, search

Purge Services

POST /maintenance/purge

Description

Purge the services which received a started and/or a completed event prior to a limit date. Use this query if your application needs to remove old services from the database.

Important
Your application needs a WRITE role to perform this request.

Operation

Method POST
URL /genesys/1/cs/maintenance/purge
Field Name   Type   Mandatory Description
URI Parameters
limit String yes Specifies the time limit for the service deletion.

Example : 2014-09-02T08:00:00.000Z

operation String yes Specifies the type of operation to be performed when the purging process runs.
  • purge.service.all to purge all the services which received a started event prior to the limit date.
  • purge.service.started.anonymous to purge the anonymous services which received a started event prior to the limit date and are not completed at the date of the purge.
  • purge.service.started to purge the services which received a started event prior to the limit date and are not completed at the date of the purge.
  • purge.service.completed to purge the services which received a started event prior to the limit date and are completed at the date of the purge.
  • purge.service.completed.anonymous to purge the anonymous services which received a started event prior to the limit date and are completed at the date of the purge.

Response

The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.

Response
HTTP code 200
HTTP message OK

<references />

Example

Operation The following operation deletes the given service with its active states and tasks.

POST http://localhost:8080/genesys/1/cs/maintenance/purge
{
"limit": "2014-09-26T16:50:00.000Z",
"operation":"purge.service.all"
}

Result

200 OK

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 7 September 2018, at 03:34.