REST interface for IBM Process Federation Server resources - Indexers Backup State Resource - DELETE Method

Sample method invocation

Usage Notes

Parameters

Optional parameters

Name	Value Type	Description
federatedSystemsFilter	string	A comma separated list of id, systemID or displayName that a federated system must match to be processed by the REST API.

Request content

None

Response content

The default content type is application/json.

MIME type: application/json

{  "description": "Indexers Backup State", 
   "type": "object",
   "properties":
   {
      "results":
      [
         {  
         	"federatedSystem": {
         		"type": "object",
            	"description": "The federated system for which the result is provided.",
            	"properties": {
            		"systemID": {
            			"type": "string",
            			"description": "the id of the federated system, as returned by the /systems API."
            		},
            		"id": {
            			"type": "string",
            			"description": "the id of the federated system, as declared in the server.xml configuration file"
            		},
            		"displayName": {
            			"type": "string",
            			"description": "the display name of the federated system, as declared in the server.xml configuration file"
            		}
            	}
            },
            "indexName": {
            	"type": "string",
             	"description": "the name of the Elasticsearch index for the federated system."
            },
            "status": {
            	"type": "string",
             	"description": "the status of the operation, which is 'ok' if the operation was successfully performed and 'error' if it failed."
            },
            "errorMessage": {
            	"type": "string",
             	"description": "when the status attribute is 'error', this attribute contains a message that explains why the operation failed for the federated system"
            },
            "message": {
            	"type": "string",
             	"description": "when the status attribute is 'ok', this attribute may contains a message that provides more information about the result of the operation for the federated system"
            },
            "restorationTimestamp": {
            	"type": "string",
             	"description": "when the status attribute is 'ok', this attribute contains an UTC timestamp that indicates the timestamp of the PFS Change log table entries in the federated system database from which indexing will resume if the indexers state is restored."
            },
            "recordTimestamp": {
            	"type": "string",
             	"description": "when the status attribute is 'ok', this attribute contains an UTC timestamp that indicates when the backup of the indexers state was performed."
            }
         }
      ]
   }    
}

{
    "results": [
        {
            "federatedSystem": {
                "systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
                "displayName": "BPD2102",
                "id": "bpd2102"
            },
            "indexName": "bpd2102",
            "message": "indexer state backup deleted: it is now impossible to restore a previous snapshot of this index",
            "status": "ok"
        },
        {
            "federatedSystem": {
                "systemID": "_PK:90230172.e73e2c1c.1460ef53.182e0002",
                "displayName": "BPEL2103",
                "id": "bpel2103"
            },
            "indexName": "bpel2103",
            "message": "indexer state backup deleted: it is now impossible to restore a previous snapshot of this index",
            "status": "ok"
        }
    ]
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	The request completed successfully.
401 Unauthorized	The caller is not authorized for this request.
403 Forbidden	The caller is not allowed to complete this request.
404 Not Found	The resource does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem occurred.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

21.0.0.3

Parent Topic: Indexers Backup State Resource