Delete Policy

Deletes policies or policy types.

The Policy Management APIs provide an abstracted layer on top of entity extraction, categorization, and related functionality to allow the definition of policies for the management of information. Classifications can be created to group documents and other objects into collections. Policies enact actions upon documents associated with a collection such as indexing.

Classification involves sorting documents into Collections; all documents in a collection share some common criteria, identified using Conditions.

The collection or collections that a document matches can influence how it is indexed and determine policies that are executed against it.

The Delete Policy API allows policy objects to be deleted.

Quick Start

To delete a policy object you must specify a policy object type and id.

For example:

/1/api/[async|sync]/deletepolicyobjects/v1?id=3&type=policy

The following policy object types can be deleted:

  • policy. A policy object is deleted. You cannot delete a policy which is associated with a collection.

  • policy_type. A policy type is deleted.

The id parameter identifies the policy object to be deleted. A single ID or array of IDs can be specified.

Synchronous
https://api.havenondemand.com/1/api/sync/deletepolicyobjects/v1
Asynchronous
https://api.havenondemand.com/1/api/async/deletepolicyobjects/v1
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Required
Name Type Description
id
array<number> An array of policy object IDs.
type
enum The type of policy object to delete.
Enumeration Types

This API's parameters use the enumerations described below:

type
The type of policy object to delete.
policy Policy
A policy object of type policy.
policy_type Policy Type
A policy object of type policy_type.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Delete Policy Response {
result ( array[Result] )
}
Delete Policy Response:Result {
error_message ( , optional)
id ( number )
success ( boolean )
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "result": {
            "items": {
                "properties": {
                    "error_message": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "id": {
                        "multipleOf": 1,
                        "type": "number"
                    },
                    "success": {
                        "type": "boolean"
                    }
                },
                "required": [
                    "id",
                    "success"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "result"
    ],
    "type": "object"
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.