TypesResource
This class provides RESTful API for Types. A type is the description of any representable item; e.g. a Hive table You could represent any meta model representing any domain using these types.
The following resources are applicable:
/types
The following operations are supported on this resource:
POST
Submits a type definition corresponding to a given type representing a meta model of a domain. Could represent things like Hive Database, Hive Table, etc.
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
PUT
Update of existing types - if the given type doesn't exist, creates new type Allowed updates are: 1. Add optional attribute 2. Change required to optional attribute 3. Add super types - super types shouldn't contain any required attributes
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
GET
Gets the list of trait type names registered in the type system.
Parameters
| name | description | type | default |
|---|---|---|---|
| type | type should be the name of enum org.apache.atlas.typesystem.types.DataTypes.TypeCategory Typically, would be one of all, TRAIT, CLASS, ENUM, STRUCT | query | all |
Response Body
| element: | (custom) |
| media types: | application/json |
entity names response payload as json
/types/{typeName}
GET
Fetch the complete definition of a given type name which is unique.
Parameters
| name | description | type | default |
|---|---|---|---|
| typeName | name of a type which is unique. | path |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)