EntityService

Entity management operations. An entity is an instance of a type. Entities conform to the definition of the type that they they correspond to. The following resources are available:

/entities

POST

Submits the entity definitions (instances). The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any unique attribute for the give type.

Response Body

element:	(custom)
media types:	application/json

PUT

Completely updates a set of entities. Unspecified values are replaced with null and removed. Adds or updates the entities specified by GUID or a unique attribute.

Response Body

element:	(custom)
media types:	application/json

DELETE

Deletes entities from the repository identified by their GUIDs (including their composite references), or deletes a single entity identified by its type and unique attribute (including composite references).

Parameters

name	description	type	default
guid	A list of deletion candidate GUIDs.	query
type	The entity type.	query
property	The unique attribute used to identify the entity.	query
value	The unique attribute value used to identify the entity.	query

Response Body

element:	(custom)
media types:	application/json

Response payload as json -- includes guids of entities (including composite references from that entity) that were deleted.

GET

Fetches the list of entities for an entity type.

Parameters

name	description	type	default
type	The name of a unique type.	query

Response Body

element:	(custom)
media types:	application/json

/entities/{guid}

GET

Fetches the complete definition of the entity identified by the GUID.

Parameters

name	description	type	default
GUID	The globally unique identifier of the entity.	path

Response Body

element:	(custom)
media types:	application/json

POST

Updates an entity identified by its GUID. Supports partial update of an entity -- adds/updates any new values specified. Does not support removal of attribute values.

Parameters

name	description	type	default
GUID	The globally unique identifier of the entity.	path
property	The property that must be added.	query

Response Body

element:	(custom)
media types:	application/json

Response payload as JSON.

/entities/{guid}/audit

GET

Returns the entity audit events for a given entity GUID. The events are returned in decreasing order based on timestamp.

Parameters

name	description	type	default
guid	The globally unique identifier of the entity.	path
startKey	Used for pagination. Startkey is inclusive; the returned results contain the event with the given startkey. The first time getAuditEvents() is called for an entity, startKey should be null, with count = (number of events required + 1). The next time getAuditEvents() is called for the same entity, startKey should be equal to the entityKey of the last event returned in the previous call.	query
count	The number of events required	query	100

Response Body

element:	(custom)
media types:	application/json

A list of trait names for the entity that is identified by the GUID.

/entities/{guid}/traits

GET

Gets the list of trait names for the entity that is represented by the GUID.

Parameters

name	description	type	default
GUID	The globally unique identifier of the entity.	path

Response Body

element:	(custom)
media types:	application/json

A list of trait names for the entity that is identified by the GUID.

POST

Submits a new trait to an existing entity that is represented by the GUID.

Parameters

name	description	type	default
GUID	The globally unique identifier of the entity.	path

Response Body

element:	(custom)
media types:	application/json

/entities/{guid}/traits/{traitName}

DELETE

Deletes a trait from the entity that is represented by the GUID.

Parameters

name	description	type	default
GUID	The globally unique identifier of the entity.	path
traitName	The name of the trait.	path

Response Body

element:	(custom)
media types:	application/json

/entities/qualifiedName

POST

Adds or Updates a given entity identified by its unique attribute (entityType, attributeName and value). Updates support only partial update of an entity -- adds or updates any new values specified. Updates do not support removal of attribute values.

Parameters

name	description	type	default
type	The entity type.	query
property	The unique attribute used to identify the entity	query
value	The unique attribute's value.	query

Response Body

element:	(custom)
media types:	application/json

Response payload as json – The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any unique attribute for the give type.

​EntityService

EntityService