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
Return the list of type names in the type system which match the specified filter.
Parameters
name | description | type | default |
---|---|---|---|
type | returns types whose category is the given typeCategory | query | |
supertype | returns types which contain the given supertype | query | |
notsupertype | returns types which do not contain the given supertype Its possible to specify combination of these filters in one request and the conditions are combined with AND For example, typeCategory = TRAIT && supertype contains 'X' && supertype !contains 'Y' If there is no filter, all the types are returned | query |
Response Body
element: | (custom) |
media types: | application/json |
list of type names
/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)