Delete Classification

Deletes objects that support document classification.

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.

A Collection Sequence is an ordered list of collections that documents are assessed against; each collection is considered in order until the document matches a collection with a stop on match instruction. Documents can match multiple collections in a collection sequence.

The Delete Classification API allows collection sequences, collections, conditions, field sources, lexicons, and lexicon expressions to be deleted.

Quick Start

Using this API you can delete classification objects. For example:

/1/api/[async|sync]/deleteclassificationobjects/v1?type=collection_sequence&id=1&id=2

The following classification object types can be deleted:

  • collection. A set of documents that share some common criteria.
  • collection sequence. An ordered set of Collections.
  • condition. Each Collection is identified using one or more Conditions.
  • field source. Information on how to retrieve a property value from a document for Condition assessment.
  • lexicon. A list of terms, phrases, or expressions that can be used when defining Conditions.
  • lexicon expression. An entry in a Lexicon.
Synchronous
https://api.havenondemand.com/1/api/sync/deleteclassificationobjects/v1
Asynchronous
https://api.havenondemand.com/1/api/async/deleteclassificationobjects/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> The IDs of the object or objects to delete.
type
enum The type of classification object.
Enumeration Types

This API's parameters use the enumerations described below:

type
The type of classification object.
collection_sequence Collection Sequence
A Collection Sequence classification object.
collection Collection
A Collection classification object.
condition Condition
A Condition classification object.
field_source Field Source
Defines actions to be taken to populate missing fields.
lexicon Lexicon
A Lexicon classification object.
lexicon_expression Lexicon Expression
A Lexicon Expression classification object.

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 Classification Response {
result ( array[Result] )
}
Delete Classification 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.