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
POST
Submits an entity definition (instance) corresponding to a given type.
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
GET
Gets the list of entities for a given entity type.
Parameters
| name | description | type | default |
|---|---|---|---|
| type | name of a type which is unique | query |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/entities/{guid}
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)
PUT
Adds property to the given entity id
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | entity id | path | |
| property | property to add | query | |
| value | property's value | query |
Response Body
| element: | (custom) |
| media types: | application/json |
response payload as json
/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)