Data Governance Guide
Also available as:
PDF
loading table of contents...

EntityResource

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 applicable:

/entities

POST

Submits an entity definition (instance) corresponding to a given type.

Response Body

element:

(custom)

media types:

application/json

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

PUT

Adds a property to the entity ID.

Parameters

name

description

type

default

GUID

The globally unique identifier of the entity.

path

property

The property that must be added.

query

value

The value of the property.

query

Response Body

element:

(custom)

media types:

application/json

Response payload as JSON.

/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