Attributes¶

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

Parameter	Type	Purpose
repository	string	The Repository name
entity	int	The Entity ID

Show All¶

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes¶: Get a list of all attributes for an Entity.

GET /api/repositories/jupiter/entities/1/attributes HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
500	Server error

The response will be a Standard Response, with a list of the attributes in the Entity.

The columns array will contain the list of columns for each data row:

Human Name	Column Name	Description
Name	_humanised_name	The name for the attribute
Ref	ATTRIBUTE_ID	Internal attribute reference
Entity name	_ename	Entity that owns this attribute
BR Compliance %	_b_rules_compliance	Measure of the attribute compliance to the Business Rules
Values	value.UNIQUE_COUNT	The number of distinct values in the attribute
Value Dist %	value.UNIQUE_DIST	The measure of how distinct the attribute is
Patterns	pat.UNIQUE_COUNT	The count of distinct data patterns found in the attribute
Pattern Values	pat.VALUES	The count of values with patterns
Pattern Mode	pat.MODE	The most frequent pattern
Pattern Shortest	pat.SHORTEST	The shortest pattern
Pattern Longest	pat.LONGEST	The longest pattern
Pattern Minimum	pat.MIN	The minimum pattern
Pattern Maximum	pat.MAX	The maximum pattern
Min	value.MIN	The discovered minimum value
Max	value.MAX	The discovered maximum value
Min Len	value.SHORTEST	The shortest length of a value
Max Len	value.LONGEST	The longest length of a value
Null Count	value.NULL_COUNT	The number of Null values in the attribute
Null Dist %	value.NULL_DIST	The percentage of values that are NULL
Mode Count	value.MODE_COUNT	The number of values with highest frequency
Schema Null Rule	__SCHEMA_NULL_RULE	The documented rule regarding whether Nulls are allowed. Default is that they are not allowed.
Space Count	SPACE_COUNT	The number of rows that contain only spaces for a given attribute
Space Dist %	SPACE_DIST	Distribution of space values
Inferred Datatype	__INFERRED_TYPE	The inferred datatype for the attribute
Definition	SCHEMA_DATA_DEFINITION	The datatype and length in terms of the original source metadata
Strings	string.UNIQUE_COUNT	The count of non-numeric values
Strings Dist %	string.VALUE_DIST	The percentage of string values.
String Min	string.MIN	The lowest string value.
String Max	string.MAX	The highest string value.
Decimals	decimal.UNIQUE_COUNT	The count of decimal values
Dec Dist %	decimal.VALUE_DIST	The percentage of decimal values
Decimal Min	decimal.MIN	The minimum decimal value
Decimal Max	decimal.MAX	The maximum decimal value
Integers	integer.UNIQUE_COUNT	The count of integer values
Integer Dist %	integer.VALUE_DIST	The Percentage of integer values
Integer Min	integer.MIN	The minimum integer value
Integer Max	integer.MAX	The maximum integer value
Values Trunc.	TRUNC_COUNT	Number of values with truncated spaces
Trunc Dist %	TRUNC_DIST	Percentage of values with truncated spaces
Variable Spaces	_vspaces	Indicates if all space values of different lengths are present
Metaphones	mtp.UNIQUE_COUNT	The count of distinct metaphones
Metaphone Values	mtp.VALUES	The count of values with metaphones
Metaphone Mode	mtp.MODE	The most frequent metaphone
Metaphone Shortest	mtp.SHORTEST	The shortest metaphone
Metaphone Longest	mtp.LONGEST	The longest metaphone
Metaphone Minimum	mtp.MIN	The minimum metaphone
Metaphone Maximum	mtp.MAX	The maximum metaphone
Masks	mask.UNIQUE_COUNT	The count of distinct masks
Mask Values	mask.VALUES	The count of values with masks
Mask Mode	mask.MODE	The most frequent mask
Mask Shortest	mask.SHORTEST	The shortest mask
Mask Longest	mask.LONGEST	The longest mask
Mask Minimum	mask.MIN	The minimum mask
Mask Maximum	mask.MAX	The maximum mask
Soundexes	sdx.UNIQUE_COUNT	The count of distinct coarse phonetic patterns found in the attribute
Soundex Values	sdx.VALUES	The count of values with soundexs
Soundex Mode	sdx.MODE	The most frequent soundex
Soundex Shortest	sdx.SHORTEST	The shortest soundex
Soundex Longest	sdx.LONGEST	The longest soundex
Soundex Minimum	sdx.MIN	The minimum soundex
Soundex Maximum	sdx.MAX	The maximum soundex
Phrases	phrase.UNIQUE_COUNT	The count of distinct phrases found in the attribute
Standard Deviation	deviation_extn.STD_DEV	Standard deviation of the numeric data found in the attribute
Permanent Keys	KEYS_PERMANENT	The number of Permanent Related keys
Discovered Keys	KEYS_DISCOVERED	The number of Discovered Related keys
Permanent Deps	DEPENDENCIES_PERMANENT	The number of Permanent Dependencies involving the attribute, either on the RHS or LHS
Discovered Deps	DEPENDENCIES_DISCOVERED	The number of Discovered Dependencies involving the attribute, either on the RHS or LHS
Permanent Joins	_joins_permanent	Number of permanent joins involving this attribute
Discovered Joins	_joins_discovered	Number of discovered joins involving this attribute
Business Description	BUSINESS_DESCRIPTION	The attribute business description
Documented Datatype	__DISCOVERY_TYPE	The documented data type for this attribute
Target Datatype	__TARGET_TYPE	The datatype required to hold all existing values of the attribute
Schema Name	SCHEMA_NAME	The schema name for the attribute
Schema Len	SCHEMA_DISPLAY_LENGTH	The documented value length
Schema Precision	SCHEMA_PRECISION	The total number of digits in a numeric attribute (not including COBOL scale factors)
Schema Scale	SCHEMA_SCALE	The number of digits after the decimal point in a decimal attribute
Schema Byte Offset	SCHEMA_BYTE_OFFSET	For COBOL, the number of bytes from the start of the record
Schema Byte Length	SCHEMA_BYTE_LENGTH	For COBOL, the number of bytes in the field
Inferred Precision	_precision	The inferred precision for the attribute
Inferred Scale	_scale	The inferred scale for the attribute
Value Count	value.VALUES	The total count of values in the attribute
Notes	note.COUNT	The number of notes for this attribute
Entity Id	entity.ENTITY_ID	Internal Entity reference
Entity Status	__entity.STATE	The entity status
Priority	PRIORITY	Priority, a measure of the importance of this attribute
Group	GROUP_NAME	The Cobol group level
Redefines	REDEFINES	Cobol redefinition field
Schema Scale Factor	SCHEMA_SCALE_FACTOR	COBOL scale factor, the number of decimal places to scale a COBOL numeric value (- left + right)
Source Type	__entity.SOURCE_TYPE	The entity source type
Type	__STATUS	The type of attribute
Array	ARRAY	Cobol occurs indicator
Pattern	_pattern_encoding	Pattern format used by the data analyser to create the patterns
Min Trunc.	TRUNC_MIN	Minimum number of spaces removed
Max Trunc.	TRUNC_MAX	Maximum number of spaces removed
Spc min len	SPACE_MIN	Shortest value containing only spaces
Spc max len	SPACE_MAX	Longest value containing only spaces
Total	NUMERIC_SUM	The sum of the numeric values
Mean	NUMERIC_AVG	The average value (integers and decimals only according to the discovered datatype)
Decimal Avg	decimal.AVERAGE	The average decimal value
Integer Avg	integer.AVERAGE	The average integer value
Encoding	ENCODING	Encoding used when loading the data
Joins Analysis	JOIN_ANALYSIS	Whether this attribute will be included in joins analysis
Deps Analysis	FDEP_ANALYSIS	Whether this attribute will be included in dependency analysis
Keys Analysis	KEY_ANALYSIS	Whether this attribute will be included in key analysis
Index Status	__INVERTED_INDEX	Whether the attribute has an index
Entity State Change Date	_state_changed_date	When the entity state changed
Entity State Changed By	entity.STATE_CHANGED_BY	Who changed the entity state
Entity Loaded Date	_entity_loaded_date	When the entity data was analyzed
Attribute Date Created	_created_date	When this attribute was created
Attribute Created By	CREATED_BY	Who created this attribute
Attribute Edited Date	_edited_date	When this attribute was last edited
Attribute Edited By	EDITED_BY	Who last edited this attribute
Column Name	COLUMN_NAME	The columnised name for the attribute
Unique Value Count	_value_single_freq_count	The number of values in the attribute that occur only once

Each data row will contain the data for a single attribute; the metadata will contain the URL to drill-down to the attribute’s metadata:

{
    "dataRow": [
        "Branch",
        "8",
        "0.000",
        "9",
        "18.000",
        "1",
        "101",
        "145",
        "3",
        "3",
        "0",
        "0.000",
        "1",
        "Nulls allowed",
        "0",
        "0",
        "Integer",
        "",
        "0",
        "0",
        "",
        "",
        "0",
        "0",
        "",
        "",
        "9",
        "100.000",
        "101",
        "145",
        "",
        "",
        "N",
        "0",
        "1",
        "0",
        "",
        "10.284",
        "",
        "",
        "",
        "2",
        "0",
        "0",
        "",
        "Unknown",
        "Integer",
        "branch",
        "",
        "",
        "",
        "",
        "",
        "3",
        "0",
        "50",
        "",
        "6231.0",
        "124.62"
    ],
    "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/8"
    }
}

If there are no attributes, rows will be an empty string.

Show Some¶

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

Lists attributes of the corresponding Entity that match various criteria

JSON Parameters:
	body – The request body

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

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

Response Code	Reason
200	Success
500	Server error

The request requires a Standard Request packet. Available commands are:

Command	Description
get	Lists attributes of an Entity that matches the criteria in Options

The response will be a Standard Response, same as described for the above get requests, with a list of attributes in the corresponding Entity matching the given criteria in Options.

Export¶

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

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

{
    "command": "export",
    "data": {
        "filename": "filename.csv",
        "filetype": "csv",
        "encoding": "utf-8"
    },
    "options": {
        "columns": ["_humanised_name", "ATTRIBUTE_ID"],
        "where": "Ref = 1"
    }
}

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"
}

Edit¶

POST /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)¶: Edit the name and description of an attribute in a given Entity.

POST /api/repositories/jupiter/entities/1/attributes/(int:attributeID) HTTP/1.1
Content-Type: application/json

{
    "command": "edit",
    "data": {
        "name": "my vin",
        "description": "my vin description"
    }
}

Response Code	Reason
200	Success
400	Bad Request
500	Server error

Attribute Metadata¶

Get¶

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)¶: Get a list of all metadata statistics for an attribute in a given Entity.

GET /api/repositories/jupiter/entities/1/attributes/(int:attributeID) HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
500	Server error

The response will be a Standard Response, with a list of the metadata statistics for an attribute in a given Entity.

The columns array will contain the list of columns for each data row:

Human Name	Column Name	Description
Metadata	_col0	The name of the metadata statistic
Value	_col1	The value of the metadata statistic
Description	_col2	A description of the metadata statistic

Each data row will contain the data for a single attribute metadata statistic; if a metadata statistic can be drilled-down further then metadata will contain the URL to drill-down further into the given metadata statistic:

{
  "metadata": {
    "viewName": "list_attributes_pivoted_v1",
    "pageStart": 1,
    "dataSize": 39,
    "totalCount": "39"
  },
  "columns": [
    {
      "columnisedName": "_col0",
      "humanisedName": "Metadata",
      "description": "The name of the metadata statistic"
    },
    {
      "columnisedName": "_col1",
      "humanisedName": "Value",
      "description": "The value of the metadata statistic"
    },
    {
      "columnisedName": "_col2",
      "humanisedName": "Description",
      "description": "A description of the metadata statistic"
    }
  ],
  "rows": [
    {
      "dataRow": [
        "Name",
        "Line 01",
        "The name for the attribute"
      ]
    },
    {
      "dataRow": [
        "Ref",
        "1",
        "Internal attribute reference"
      ]
    },
    {
      "dataRow": [
        "BR Compliance %",
        "0.000",
        "Measure of the attribute compliance to the Business Rules"
      ]
    },
    {
      "dataRow": [
        "Values",
        "50",
        "The number of distinct values in the attribute"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values"
      }
    },
    {
      "dataRow": [
        "Value Dist %",
        "100.000",
        "The measure of how distinct the attribute is"
      ]
    },
    {
      "dataRow": [
        "Min Value",
        "Bill Barwick ",
        "The discovered minimum value"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values/minimum"
      }
    },
    {
      "dataRow": [
        "Max Value",
        "Tyler's Tales",
        "The discovered maximum value"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values/maximum"
      }
    },
    {
      "dataRow": [
        "Patterns",
        "48",
        "The count of distinct data patterns found in the attribute"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/patterns"
      }
    },
    ...
  ]
}

Post¶

POST /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)¶: Get a list of all metadata statistics for an attribute in a given Entity.

POST /api/repositories/jupiter/entities/1/attributes/(int:attributeID) HTTP/1.1
Content-Type: application/json

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

Response Code	Reason
200	Success
400	Bad Request
500	Server error

The response will be a Standard Response, with a list of the metadata statistics for an attribute in a given Entity.

The columns array will contain the list of columns for each data row:

Human Name	Column Name	Description
Metadata	_col0	The name of the metadata statistic
Value	_col1	The value of the metadata statistic
Description	_col2	A description of the metadata statistic

Each data row will contain the data for a single attribute metadata statistic; if a metadata statistic can be drilled-down further then metadata will contain the URL to drill-down further into the given metadata statistic.

NOTE: If columns are filtered using ‘columns’ option, then metadata will not contain the URLs to drill-down further into the given metadata statistic.

{
  "metadata": {
    "viewName": "list_attributes_pivoted_v1",
    "pageStart": 1,
    "dataSize": 39,
    "totalCount": "39"
  },
  "columns": [
    {
      "columnisedName": "_col0",
      "humanisedName": "Metadata",
      "description": "The name of the metadata statistic"
    },
    {
      "columnisedName": "_col1",
      "humanisedName": "Value",
      "description": "The value of the metadata statistic"
    },
    {
      "columnisedName": "_col2",
      "humanisedName": "Description",
      "description": "A description of the metadata statistic"
    }
  ],
  "rows": [
    {
      "dataRow": [
        "Name",
        "Line 01",
        "The name for the attribute"
      ]
    },
    {
      "dataRow": [
        "Ref",
        "1",
        "Internal attribute reference"
      ]
    },
    {
      "dataRow": [
        "BR Compliance %",
        "0.000",
        "Measure of the attribute compliance to the Business Rules"
      ]
    },
    {
      "dataRow": [
        "Values",
        "50",
        "The number of distinct values in the attribute"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values"
      }
    },
    {
      "dataRow": [
        "Value Dist %",
        "100.000",
        "The measure of how distinct the attribute is"
      ]
    },
    {
      "dataRow": [
        "Min Value",
        "Bill Barwick ",
        "The discovered minimum value"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values/minimum"
      }
    },
    {
      "dataRow": [
        "Max Value",
        "Tyler's Tales",
        "The discovered maximum value"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/values/maximum"
      }
    },
    {
      "dataRow": [
        "Patterns",
        "48",
        "The count of distinct data patterns found in the attribute"
      ],
      "metadata": {
        "url": "/api/repositories/jupiter/entities/1/attributes/1/patterns"
      }
    },
    ...
  ]
}

TSS REST API

Attributes¶

Show All¶

Show Some¶

Export¶

Edit¶

Attribute Metadata¶

Get¶

Post¶

Table Of Contents