Get an entity
GET/v1/blueprints/:blueprint_identifier/entities/:entity_identifier
This route allows you to fetch a specific entity in your software catalog.
To learn more about entities, check out the documentation.
Request
Path Parameters
entity_identifier stringrequired
The identifier of the entity you want to fetch.
blueprint_identifier stringrequired
The identifier of the blueprint the entity belongs to.
Query Parameters
exclude_calculated_properties boolean
If true, calculated properties will be excluded from the entity.
include string[]
An array of values from the entity JSON. Only these values will be returned in the response.
For example: { "properties.propertyIdentifier","identifier"}
exclude string[]
An array of values from the entity JSON to be ommitted from the response.
For example: { "properties.propertyIdentifier","identifier"}
Responses
- 200
- 404
- 422
- 500
Success
One of the following errors occurred:
| Error | Description |
|---|---|
not_found | An entity with the provided identifier was not found |
not_found | A blueprint with the provided identifier was not found |
One of the following errors occurred:
| Error | Description |
|---|---|
invalid_request | The provided data does not match the route schema |
One of the following errors occurred:
| Error | Description |
|---|---|
internal_error | An internal error occurred |
Loading...