Attribute Deviations

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/deviations
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)/deviations

Gets a complete list of deviation levels in an attribute.

GET /api/repositories/jupiter/entities/1/attributes/3/deviations HTTP/1.1
Accept: application/json
POST /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/deviations

Gets a paged list of deviation levels in an attribute

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

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

The response is a Standard Response.

The columns array will show the following columns:

Human Name Column Name Description
Deviation VALUE The mask of the data
Value Count VALUE_COUNT The number of values that match the mask
Frequency FREQUENCY_COUNT The frequency of all the values that match the mask
Dist % _distribution A measure of how much of the attribute contains values that match the mask

A datarow element will look like:

{
    "dataRow": [
        "-1",
        "26",
        "81",
        "10.305"
    ]
}

Export

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

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

{
    "command": "export",
    "data": {
        "filename": "filename.csv",
        "filetype": "csv",
        "encoding": "utf-8"
    },
    "options": {
        "where": "Frequency > 2"
    }
}
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"
}