TypesREST Resource

REST interface for CRUD operations on type definitions

DELETE /v2/types/typedefs

Bulk delete API for all types

Request Body
media type data type description
application/json AtlasTypesDef (JSON) A composite object that captures all types to be deleted
Response Codes
code condition
204 On successful deletion of the requested type definitions
400 On validation failure for any type definitions

Example

Request
DELETE /v2/types/typedefs
Content-Type: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "MAP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "MAP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "PRIMITIVE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "RELATIONSHIP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "PRIMITIVE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}
Response
HTTP/1.1 204 No Content

GET /v2/types/typedefs

Bulk retrieval API for retrieving all type definitions in Atlas

Response Codes
code condition
200 AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions
Response Body
media type data type description
application/json AtlasTypesDef (JSON) A composite wrapper object with lists of all type definitions

Example

Request
GET /v2/types/typedefs
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "STRUCT",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "CLASSIFICATION",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "CLASSIFICATION",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}

POST /v2/types/typedefs

Bulk create APIs for all atlas type definitions, only new definitions will be created. Any changes to the existing definitions will be discarded

Request Body
media type data type description
application/json AtlasTypesDef (JSON) A composite wrapper object with corresponding lists of the type definition
Response Codes
code condition
200 On successful update of requested type definitions
400 On validation failure for any type definitions
Response Body
media type data type description
application/json AtlasTypesDef (JSON) A composite wrapper object with lists of type definitions that were successfully created

Example

Request
POST /v2/types/typedefs
Content-Type: application/json
Accept: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "CLASSIFICATION",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENUM",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "STRUCT",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "PRIMITIVE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "PRIMITIVE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "PRIMITIVE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "STRUCT",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "STRUCT",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "RELATIONSHIP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "CLASSIFICATION",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}

PUT /v2/types/typedefs

Bulk update API for all types, changes detected in the type definitions would be persisted

Request Body
media type data type description
application/json AtlasTypesDef (JSON) A composite object that captures all type definition changes
Response Codes
code condition
200 On successful update of requested type definitions
400 On validation failure for any type definitions
Response Body
media type data type description
application/json AtlasTypesDef (JSON) A composite object with lists of type definitions that were updated

Example

Request
PUT /v2/types/typedefs
Content-Type: application/json
Accept: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "RELATIONSHIP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENUM",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "RELATIONSHIP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "MAP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "STRUCT",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "enumDefs" : [ {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "MAP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "elementDefs" : [ {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    }, {
      "value" : "...",
      "description" : "...",
      "ordinal" : 12345
    } ],
    "defaultValue" : "...",
    "category" : "MAP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "LIST",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ARRAY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "classificationDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "RELATIONSHIP",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "entityDefs" : [ {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "ENTITY",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SINGLE",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    }, {
      "name" : "...",
      "typeName" : "...",
      "isOptional" : true,
      "cardinality" : "SET",
      "valuesMinCount" : 12345,
      "valuesMaxCount" : 12345,
      "isUnique" : true,
      "isIndexable" : true,
      "constraints" : [ { }, { } ]
    } ],
    "category" : "OBJECT_ID_TYPE",
    "guid" : "...",
    "createdBy" : "...",
    "updatedBy" : "...",
    "createTime" : 12345,
    "updateTime" : 12345,
    "version" : 12345,
    "name" : "...",
    "description" : "...",
    "typeVersion" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "empty" : true
}

GET /v2/types/typedefs/headers

Bulk retrieval API for all type definitions returned as a list of minimal information header

Response Codes
code condition
200 Returns a list of AtlasTypeDefHeader matching the search criteria or an empty list if no match.
Response Body
media type data type description
application/json array of AtlasTypeDefHeader (JSON) List of AtlasTypeDefHeader AtlasTypeDefHeader

Example

Request
GET /v2/types/typedefs/headers
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "name" : "...",
  "category" : "PRIMITIVE"
} ]

GET /v2/types/classificationdef/guid/{guid}

Get the classification definition for the given guid

Request Parameters
name type description
guid path classification guid
Response Codes
code condition
200 On successful lookup of the the classification definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasClassificationDef (JSON) classification definition

Example

Request
GET /v2/types/classificationdef/guid/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SINGLE",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SINGLE",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "ARRAY",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/classificationdef/name/{name}

Get the classification definition by it's name (unique)

Request Parameters
name type description
name path classification name
Response Codes
code condition
200 On successful lookup of the the classification definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasClassificationDef (JSON) classification definition

Example

Request
GET /v2/types/classificationdef/name/{name}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SET",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "LIST",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "MAP",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/entitydef/guid/{guid}

Get the Entity definition for the given guid

Request Parameters
name type description
guid path entity guid
Response Codes
code condition
200 On successful lookup of the the entity definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasEntityDef (JSON) Entity definition

Example

Request
GET /v2/types/entitydef/guid/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SET",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "LIST",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "ENTITY",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/entitydef/name/{name}

Get the entity definition by it's name (unique)

Request Parameters
name type description
name path entity name
Response Codes
code condition
200 On successful lookup of the the entity definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasEntityDef (JSON) Entity definition

Example

Request
GET /v2/types/entitydef/name/{name}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SET",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "LIST",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "ARRAY",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/enumdef/guid/{guid}

Get the enum definition for the given guid

Request Parameters
name type description
guid path enum guid
Response Codes
code condition
200 On successful lookup of the the enum definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasEnumDef (JSON) enum definition

Example

Request
GET /v2/types/enumdef/guid/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "elementDefs" : [ {
    "value" : "...",
    "description" : "...",
    "ordinal" : 12345
  }, {
    "value" : "...",
    "description" : "...",
    "ordinal" : 12345
  } ],
  "defaultValue" : "...",
  "category" : "ARRAY",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/enumdef/name/{name}

Get the enum definition by it's name (unique)

Request Parameters
name type description
name path enum name
Response Codes
code condition
200 On successful lookup of the the enum definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasEnumDef (JSON) enum definition

Example

Request
GET /v2/types/enumdef/name/{name}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "elementDefs" : [ {
    "value" : "...",
    "description" : "...",
    "ordinal" : 12345
  }, {
    "value" : "...",
    "description" : "...",
    "ordinal" : 12345
  } ],
  "defaultValue" : "...",
  "category" : "STRUCT",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/structdef/guid/{guid}

Get the struct definition for the given guid

Request Parameters
name type description
guid path struct guid
Response Codes
code condition
200 On successful lookup of the the struct definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasStructDef (JSON) struct definition

Example

Request
GET /v2/types/structdef/guid/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SINGLE",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "LIST",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "ENTITY",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/structdef/name/{name}

Get the struct definition by it's name (unique)

Request Parameters
name type description
name path struct name
Response Codes
code condition
200 On successful lookup of the the struct definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasStructDef (JSON) struct definition

Example

Request
GET /v2/types/structdef/name/{name}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "SET",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  }, {
    "name" : "...",
    "typeName" : "...",
    "isOptional" : true,
    "cardinality" : "LIST",
    "valuesMinCount" : 12345,
    "valuesMaxCount" : 12345,
    "isUnique" : true,
    "isIndexable" : true,
    "constraints" : [ {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    }, {
      "type" : "...",
      "params" : {
        "property1" : { },
        "property2" : { }
      }
    } ]
  } ],
  "category" : "PRIMITIVE",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/typedef/guid/{guid}

Request Parameters
name type description
guid path GUID of the type
Response Codes
code condition
200 Successful lookup
404 Failed lookup
Response Body
media type data type description
application/json AtlasBaseTypeDef (JSON) Type definition

Example

Request
GET /v2/types/typedef/guid/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "category" : "CLASSIFICATION",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}

GET /v2/types/typedef/name/{name}

Get type definition by it's name

Request Parameters
name type description
name path Type name
Response Codes
code condition
200 Successful lookup by name
404 Failed lookup by name
Response Body
media type data type description
application/json AtlasBaseTypeDef (JSON) Type definition

Example

Request
GET /v2/types/typedef/name/{name}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "category" : "MAP",
  "guid" : "...",
  "createdBy" : "...",
  "updatedBy" : "...",
  "createTime" : 12345,
  "updateTime" : 12345,
  "version" : 12345,
  "name" : "...",
  "description" : "...",
  "typeVersion" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  }
}