Attribute Values¶
/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/values
Parameter | Type | Purpose |
---|---|---|
repository | string | The repository name |
entity | int | The entity ID |
attribute | int | The attribute ID |
-
GET
/api/repositories/
(string: repository)/entities/
(int: entityID)/attributes/
(int: attributeID)/values
¶ Gets a complete list of values for an attribute.
GET /api/repositories/jupiter/entities/1/attributes/3/values HTTP/1.1
Accept: application/json
The list of values may be quite long; if so, the list can be paged:
-
POST
/api/repositories/
(string: repository)/entities/
(int: entityID)/attributes/
(int: attributeID)/values
¶ Get a page of values for an attribute
POST /api/repositories/jupiter/entities/1/attributes/3/values 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 |
---|---|---|
Value | VALUE | The data value |
Frequency | FREQUENCY_COUNT | The number of times the data value occurs in the attribute |
Dist % | _distribution | A measure of how much of the attribute contains the data value |
Length | _length | The length of the data value |
Soundex | _soundex | The coarse-grain phonetic representation of the data value |
Metaphone | _metaphone | The fine-grain phonetic representation of the data value |
Pattern | _pattern | The structure of the data value |
Mask | _mask | The mask pattern of the data value |
Percent Rank | _percentile | The percentile of the data value |
Deviation | _deviation | The deviation of the data value |
Row Id | _rowid | The row id of the data value |
A datarow
element will look like:
{
"dataRow": [
"Dr",
"449",
"64.791",
"2",
"D600",
"TR",
"a2",
"AA",
"",
"",
"12"
]
}
Export¶
Some or all of the rows may be exported as a scheduled task.
POST /api/repositories/jupiter/entities/1/attributes/3/values HTTP/1.1
Content-Type: application/json
{
"command": "export",
"data": {
"filename": "filename.csv",
"filetype": "csv",
"encoding": "utf-8"
},
"options": {
"columns": ["VALUE", "FREQUENCY_COUNT"],
"where": "Frequency = 10"
}
}
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"
}