# OpenLattice edm API

**Canonical:** https://apis.io/apis/openlattice/openlattice-edm-api/  
**Provider:** OpenLattice — https://apis.io/providers/openlattice/  
**Base URL:** https://api.openlattice.com  
**Documentation:** https://github.com/openlattice/api

OpenLattice edm API is one of 7 APIs that [OpenLattice](https://apis.io/providers/openlattice/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include edm. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

API endpoints to the entity data model.

## Operations (50)

| Method | Path | Summary |
|---|---|---|
| GET | `/datastore/edm/` | Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. |
| PATCH | `/datastore/edm/` | Updates the entity data model, including schemas, entity types, association types, and property types. |
| POST | `/datastore/edm/diff/` | Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property... |
| GET | `/datastore/edm/version/` | Returns the current entity data model version. |
| GET | `/datastore/edm/entity/set/{entitySetId}` | Get the EntitySet definition for the given EntitySet UUID. |
| DELETE | `/datastore/edm/entity/set/{entitySetId}` | Deletes the EntitySet definition for the given EntitySet UUID. |
| PATCH | `/datastore/edm/entity/set/{entitySetId}` | Updates the EntityType definition for the given EntitySet UUID with the given metadata. |
| GET | `/datastore/edm/ids/entity/set/{entitySetName}` | Gets the EntitySet UUID for the given EntitySet name. |
| GET | `/datastore/edm/entity/set` | Get all EntitySet definitions. |
| POST | `/datastore/edm/entity/set` | Create new EntitySet definitions if they don"t exist. |
| GET | `/datastore/edm/entity/set/{entitySetId}/property/type` | Get all property type metadata for an entity set. |
| GET | `/datastore/edm/entity/set/{entitySetId}/property/type/{propertyTypeId}/` | Get specified property type metadata for an entity set. |
| POST | `/datastore/edm/entity/set/{entitySetId}/property/type/{propertyTypeId}/` | Updates the property type metadata for the given entity set. |
| GET | `/datastore/edm/entity/type/{entityTypeId}` | Gets the EntityType definition for the given EntityType UUID. |
| DELETE | `/datastore/edm/entity/type/{entityTypeId}` | Deletes the EntityType definition for the given EntityType UUID. |
| PATCH | `/datastore/edm/entity/type/{entityTypeId}` | Updates the EntityType definition for the given EntityType UUID with the given metadata. |
| GET | `/datastore/edm/ids/entity/type/{namespace}/{name}` | Gets the EntityType UUID for the given EntityType FQN. |
| PUT | `/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}` | Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. |
| DELETE | `/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}` | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. |
| DELETE | `/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}/force` | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associate... |
| GET | `/datastore/edm/entity/type/` | Gets all EntityType definitions. |
| POST | `/datastore/edm/entity/type/` | Creates a new EntityType definition, if it doesn't exist. |
| GET | `/datastore/edm/association/type/` | Gets all association EntityType definitions. |
| POST | `/datastore/edm/association/type/` | Creates a new AssociationType definition, if it doesn"t exist. |
| PATCH | `/datastore/edm/entity/type/{entityTypeId}/property/type` | Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. |
| PATCH | `/datastore/edm/entity/type/{entityTypeId}/hierarchy` | Get the EntityType hierarchy for the given EntityType UUID. |
| GET | `/datastore/edm/property/type/{propertyTypeId}` | Gets the PropertyType definition for the given PropertyType UUID. |
| DELETE | `/datastore/edm/property/type/{propertyTypeId}` | Deletes the PropertyType definition for the given PropertyType UUID. |
| PATCH | `/datastore/edm/property/type/{propertyTypeId}` | Updates the PropertyType definition for the given PropertyType UUID with the given metadata. |
| DELETE | `/datastore/edm/property/type/{propertyTypeId}/force` | Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. |
| GET | `/datastore/edm/ids/property/type/{namespace}/{name}` | Gets the PropertyType UUID for the given PropertyType FQN. |
| GET | `/datastore/edm/property/type/` | Gets all PropertyType definitions. |
| POST | `/datastore/edm/property/type/` | Creates a new PropertyType definition, if it doesn"t exist. |
| GET | `/datastore/edm/property/type/namespace/{namespace}` | Gets all PropertyType definitions under the given namespace. |
| GET | `/datastore/edm/association/type/{associationTypeId}` | Get the AssociationType definition for the given AssociationType UUID. |
| DELETE | `/datastore/edm/association/type/{associationTypeId}` | Delete the AssociationType definition for the given AssociationType UUID. |
| GET | `/datastore/edm/association/type/{associationTypeId}/detailed` | Get details about the AssociationType for the given AssociationType UUID. |
| GET | `/datastore/edm/association/type/{associationTypeId}/available` | Get all available associations for the given AssociationType UUID. |
| PUT | `/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}` | Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. |
| DELETE | `/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}` | Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. |
| PUT | `/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}` | Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. |
| DELETE | `/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}` | Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. |
| GET | `/datastore/edm/summary` | Get Property Usage Summary for all properties. |
| GET | `/datastore/edm/summary/{propertyTypeId}` | Get Property Usage Summary for property with given ID. |
| GET | `/datastore/edm/schema/{namespace}/{name}` | Gets the schema contents for a corresponding namespace and name. |
| PUT | `/datastore/edm/schema/{namespace}/{name}` | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. |
| PATCH | `/datastore/edm/schema/{namespace}/{name}` | Edits the schema contents for a corresponding namespace and name. |
| GET | `/datastore/edm/schema` | Gets all schemas. |
| POST | `/datastore/edm/schema` | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. |
| GET | `/datastore/edm/schema/{namespace}` | Gets all schemas associated with a given namespace and accessible by the caller. |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openlattice/refs/heads/main/openapi/openlattice-edm-api-openapi.yml
- **APIReference** — https://github.com/openlattice/api

## Other OpenLattice APIs (6)

- [OpenLattice authorizations API](https://apis.io/apis/openlattice/openlattice-authorizations-api/)
- [OpenLattice data API](https://apis.io/apis/openlattice/openlattice-data-api/)
- [OpenLattice organizations API](https://apis.io/apis/openlattice/openlattice-organizations-api/)
- [OpenLattice permissions API](https://apis.io/apis/openlattice/openlattice-permissions-api/)
- [OpenLattice principal API](https://apis.io/apis/openlattice/openlattice-principal-api/)
- [OpenLattice search API](https://apis.io/apis/openlattice/openlattice-search-api/)

## Tags

edm

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openlattice/openlattice-edm-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openlattice/.