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
application/json;charset=UTF-8 (custom)
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

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "CLASSIFICATION",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              
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
application/json;charset=UTF-8 (custom)

Example

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

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "NONE",
    "relationshipCategory" : "COMPOSITION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              

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
application/json;charset=UTF-8 (custom)
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
application/json;charset=UTF-8 (custom)

Example

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

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "CLASSIFICATION",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "BOTH",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "BOTH",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "NONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              

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
application/json;charset=UTF-8 (custom)
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
application/json;charset=UTF-8 (custom)

Example

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

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "CLASSIFICATION",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "NONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "CLASSIFICATION",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "ONE_TO_TWO",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "OBJECT_ID_TYPE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "COMPOSITION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ARRAY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENUM",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

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

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "category" : "RELATIONSHIP",
  "guid" : "...",
  "name" : "...",
  "serviceType" : "..."
} ]
                
              

GET /v2/types/businessmetadatadef/guid/{guid}

Get the businessMetadata definition for the given guid

Request Parameters
name type description
guid path businessMetadata guid
Response Codes
code condition
200 On successful lookup of the the businessMetadata definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasBusinessMetadataDef (JSON) businessMetadata definition
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/businessmetadatadef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "STRUCT",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "CEILING"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

GET /v2/types/businessmetadatadef/name/{name}

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

Request Parameters
name type description
name path businessMetadata name
Response Codes
code condition
200 On successful lookup of the the businessMetadata definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasBusinessMetadataDef (JSON) businessMetadata definition
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/businessmetadatadef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "MAP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "CEILING"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/classificationdef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entityTypes" : [ "...", "..." ],
  "subTypes" : [ "...", "..." ],
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "STRUCT",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_EVEN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/classificationdef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entityTypes" : [ "...", "..." ],
  "subTypes" : [ "...", "..." ],
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "RELATIONSHIP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "UP"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/entitydef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "businessAttributeDefs" : {
    "property1" : [ {
      "cardinality" : "LIST",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "property2" : [ {
      "cardinality" : "LIST",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ]
  },
  "relationshipAttributeDefs" : [ {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "subTypes" : [ "...", "..." ],
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "MAP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_UP"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/entitydef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "businessAttributeDefs" : {
    "property1" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "property2" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      }, {
        "params" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "..."
      } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ]
  },
  "relationshipAttributeDefs" : [ {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "isLegacyAttribute" : true,
    "relationshipTypeName" : "...",
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "subTypes" : [ "...", "..." ],
  "superTypes" : [ "...", "..." ],
  "attributeDefs" : [ {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "ARRAY",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_EVEN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/enumdef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "defaultValue" : "...",
  "elementDefs" : [ {
    "description" : "...",
    "ordinal" : 12345,
    "value" : "..."
  }, {
    "description" : "...",
    "ordinal" : 12345,
    "value" : "..."
  } ],
  "category" : "BUSINESS_METADATA",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_DOWN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/enumdef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "defaultValue" : "...",
  "elementDefs" : [ {
    "description" : "...",
    "ordinal" : 12345,
    "value" : "..."
  }, {
    "description" : "...",
    "ordinal" : 12345,
    "value" : "..."
  } ],
  "category" : "OBJECT_ID_TYPE",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "UNNECESSARY"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

GET /v2/types/relationshipdef/guid/{guid}

Get the relationship definition for the given guid

Request Parameters
name type description
guid path relationship guid
Response Codes
code condition
200 On successful lookup of the the relationship definition by it's guid
404 On Failed lookup for the given guid
Response Body
media type data type description
application/json AtlasRelationshipDef (JSON) relationship definition
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/relationshipdef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "endDef1" : {
    "cardinality" : "LIST",
    "description" : "...",
    "isContainer" : true,
    "isLegacyAttribute" : true,
    "name" : "...",
    "type" : "..."
  },
  "endDef2" : {
    "cardinality" : "SET",
    "description" : "...",
    "isContainer" : true,
    "isLegacyAttribute" : true,
    "name" : "...",
    "type" : "..."
  },
  "propagateTags" : "BOTH",
  "relationshipCategory" : "ASSOCIATION",
  "relationshipLabel" : "...",
  "attributeDefs" : [ {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "ENTITY",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "CEILING"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

GET /v2/types/relationshipdef/name/{name}

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

Request Parameters
name type description
name path relationship name
Response Codes
code condition
200 On successful lookup of the the relationship definition by it's name
404 On Failed lookup for the given name
Response Body
media type data type description
application/json AtlasRelationshipDef (JSON) relationship definition
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/relationshipdef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "endDef1" : {
    "cardinality" : "LIST",
    "description" : "...",
    "isContainer" : true,
    "isLegacyAttribute" : true,
    "name" : "...",
    "type" : "..."
  },
  "endDef2" : {
    "cardinality" : "SET",
    "description" : "...",
    "isContainer" : true,
    "isLegacyAttribute" : true,
    "name" : "...",
    "type" : "..."
  },
  "propagateTags" : "ONE_TO_TWO",
  "relationshipCategory" : "COMPOSITION",
  "relationshipLabel" : "...",
  "attributeDefs" : [ {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "STRING",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "MAP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "CEILING"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/structdef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "cardinality" : "LIST",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "STRUCT",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_EVEN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/structdef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "attributeDefs" : [ {
    "cardinality" : "SINGLE",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  }, {
    "cardinality" : "SET",
    "constraints" : [ {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    }, {
      "params" : {
        "property1" : { },
        "property2" : { }
      },
      "type" : "..."
    } ],
    "defaultValue" : "...",
    "description" : "...",
    "displayName" : "...",
    "includeInNotification" : true,
    "indexType" : "DEFAULT",
    "isIndexable" : true,
    "isOptional" : true,
    "isUnique" : true,
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "searchWeight" : 12345,
    "typeName" : "...",
    "valuesMaxCount" : 12345,
    "valuesMinCount" : 12345
  } ],
  "category" : "RELATIONSHIP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "DOWN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/typedef/guid/{guid}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "category" : "ARRAY",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "HALF_DOWN"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

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
application/json;charset=UTF-8 (custom)

Example

Request
GET /v2/types/typedef/name/{name}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "category" : "MAP",
  "createTime" : 12345,
  "createdBy" : "...",
  "dateFormatter" : {
    "availableLocales" : [ "...", "..." ],
    "calendar" : 12345,
    "dateInstance" : { },
    "dateTimeInstance" : { },
    "instance" : { },
    "lenient" : true,
    "numberFormat" : {
      "availableLocales" : [ "...", "..." ],
      "currency" : "...",
      "currencyInstance" : { },
      "groupingUsed" : true,
      "instance" : { },
      "integerInstance" : { },
      "maximumFractionDigits" : 12345,
      "maximumIntegerDigits" : 12345,
      "minimumFractionDigits" : 12345,
      "minimumIntegerDigits" : 12345,
      "numberInstance" : { },
      "parseIntegerOnly" : true,
      "percentInstance" : { },
      "roundingMode" : "UP"
    },
    "timeInstance" : { },
    "timeZone" : {
      "DSTSavings" : 12345,
      "ID" : "...",
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "rawOffset" : 12345
    }
  },
  "description" : "...",
  "guid" : "...",
  "name" : "...",
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceType" : "...",
  "typeVersion" : "...",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345
}
                
              

DELETE /v2/types/typedef/name/{typeName}

Delete API for type identified by its name.

Request Parameters
name type description
typeName path Name of the type 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/typedef/name/{typeName}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 204 No Content