EntityResource
Entity management operations as REST API. An entity is an "instance" of a Type. Entities conform to the definition of the Type they correspond with.
The following resources are applicable:
- /entities
- /entities/{guid}
- /entities/{guid}/audit
- /entities/{guid}/traits
- /entities/{guid}/traits/{traitName}
- /entities/qualifiedName
/entities
The following operations are supported on this resource:
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 |
(no documentation provided)
PUT
Complete update of a set of entities - the values not specified will be replaced with null/removed Adds/Updates given entities identified by its GUID or unique attribute
Response Body
| element: | (custom) |
| media types: | application/json |
response payload as json
DELETE
Delete entities from the repository identified by their guids (including their composite references) or Deletes a single entity identified by its type and unique attribute value from the repository (including their composite references)
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | list of deletion candidate guids or | 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 - including guids of entities(including composite references from that entity) that were deleted
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| type | (no documentation provided) | query | |
| property | (no documentation provided) | query | |
| value | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/{guid}
POST
Updates entity identified by its GUID Support Partial update of an entity - Adds/updates any new values specified Does not support removal of attribute values
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | (no documentation provided) | path | |
| property | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
GET
Fetch the complete definition of an entity given its GUID.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | GUID for the entity | path |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/{guid}/audit
GET
Returns the entity audit events for a given entity id. The events are returned in the decreasing order of timestamp.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | entity id | path | |
| startKey | used for pagination. Startkey is inclusive, the returned results contain the event with the given startkey. First time getAuditEvents() is called for an entity, startKey should be null, with count = (number of events required + 1). 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 | number of events required | query | 100 |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/{guid}/traits
GET
Gets the list of trait names for a given entity represented by a guid.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | globally unique identifier for the entity | path |
Response Body
| element: | (custom) |
| media types: | application/json |
a list of trait names for the given entity guid
POST
Adds a new trait to an existing entity represented by a guid.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | globally unique identifier for the entity | path |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/{guid}/traits/{traitName}
DELETE
Deletes a given trait from an existing entity represented by a guid.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | globally unique identifier for the entity | path | |
| traitName | name of the trait | path |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/qualifiedName
POST
Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value) Updates support only partial update of an entity - Adds/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 attributes 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.