Attribute Metaphones

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/metaphones

Parameter	Type	Purpose
repository	string	The repository name
entity	int	The entity ID
attribute	int	The attribute ID

Only POST requests are supported for this endpoint.

POST /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/metaphones

Get a page of metaphones for an attribute

POST /api/repositories/jupiter/entities/1/attributes/55/metaphones HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "pageStart": 1,
        "pageSize": 32
    }
}

The response is a Standard Response.

The columns array will show the following columns:

Human Name	Column Name	Description
Metaphone	_value	The fine-grain phonetic pattern
Value Count	VALUE_COUNT	The number of values that match the Metaphone.
Frequency	FREQUENCY_COUNT	The frequency of all the values that match the metaphone.
Dist %	_distribution	A measure of how much of the attribute contains values that match the Metaphone.

A datarow element will look like:

{
    "dataRow": [
        "BSNSKRTTNJ",
        "1",
        "42",
        "2.964"
    ]
}

Export

Some or all of the rows may be exported as a scheduled task.

POST /api/repositories/jupiter/entities/1/attributes/2/metaphones HTTP/1.1
Content-Type: application/json

{
    "command": "export",
    "data": {
        "filename": "filename.csv",
        "filetype": "csv",
        "encoding": "utf-8"
    },
    "options": {
        "where": "Frequency = 3"
    }
}

Response Code	Reason
200	No error
400	Invalid data passed with request
500	Server error

The request packet must contain the command and data elements. The options element is not required, but may specify the columns to export, and/or the rows to filter.

The following table shows which fields are required in the data element:

Field	Required
filename	Y
filetype	N
encoding	N

If filetype is not specified, it defaults to csv. If encoding is not specified, it defaults to the server native encoding.

The response will contain the URL of the scheduled task and the link to download the exported file.

{
    "job": "/api/repositories/jupiter/scheduler/1",
    "file": "/api/repositories/jupiter/download/filename.csv"
}