Data Governance
Also available as:
PDF

TypesResource

This class provides a RESTful API for types. A type is the description of any representable item, for example, a Hive table. You can represent any meta model of any domain using these types. The following resources are available:

/types

POST

Submits a type definition that corresponds to a type that represents a domain meta model. This method can represent objects like a Hive database, Hive table, and so on.

Response Body

element:

(custom)

media types:

application/json

PUT

Updates existing types. If the specified type doesn't exist, a new type is created. Allowed updates are: 1. Add optional attribute 2. Change required to optional attribute 3. Add super types. Super types should not contain any required attributes.

Response Body

element:

(custom)

media types:

application/json

GET

Fetches a list of trait type names that are registered in the type system.

Parameters

name

description

type

default

type

The name of the enumerator

org.apache.atlas.typesystem. types.DataTypes.TypeCategory.

Typically, this can be one of:

all, TRAIT, CLASS, ENUM, STRUCT.

query

all

Response Body

element:

(custom)

media types:

application/json

The entity names response payload represented as JSON.

/types/{typeName}

GET

Fetches the complete definition of a unique type name.

Parameters

name

description

type

default

typename

The unique name of the type.

path

Response Body

element:

(custom)

media types:

application/json