Change an entity
PUT/v1/blueprints/:blueprint_identifier/entities/:entity_identifier
This route allows you to edit a specific entity in your software catalog and update its properties.
To learn more about entities, check out the documentation.
Request
Path Parameters
Possible values: non-empty
The identifier of the entity you want to change.
Possible values: non-empty
The identifier of the blueprint the entity belongs to.
Query Parameters
If true, this call will also create missing related entities.
This is useful when you want to create an entity and its related entities in one call, or if you want to create an entity whose related entity does not exist yet.
You can provide a run_id to associate the modified entity with a specific action run.
- application/json
Body
- String identifier
- Search query
Array [
- Equals rule
- MOD2
- Search query
- MOD1
- MOD2
Array [
- `=` Rule
- `in` Rule
- String
- Number
]
]
identifier
object
oneOf
The new identifier of the entity.
string
Possible values: Value must match regular expression ^[A-Za-z0-9@_.:\\/=-]+$
A search query to define the entity's identifier based on a property of the entity.
Read more here.
Possible values: [and, or]
rules
object[]
required
One or more rules to define the entity's identifier based on a property of the entity.
anyOf
Possible values: [=]
value
object
required
anyOf
string
number
Possible values: [in]
Possible values: [and, or]
rules
object[]
required
A search query to define the entity's identifier based on a property of the entity.
Read more here.
anyOf
Possible values: [=]
value
object
required
anyOf
string
number
Possible values: [in]
The new title of the entity.
The new icon of the entity.
The Port team/s to which the entity will belong.
An object containing the properties of the entity, in "key":"value" pairs where the key is the property's identifier, and the value is its value.
An object containing the relations of the new entity, in "key":"value" pairs where the key is the relation's identifier, and the value is the related entity's identifier.
Responses
- 200
- 400
- 403
- 404
- 409
- 413
- 422
- 500
Successfully changed the entity
One of the following errors occurred:
| Error | Description |
|---|---|
run_exhausted | Action run has already finished execution |
One of the following errors occurred:
| Error | Description |
|---|---|
required_relation | Relation cannot be deleted because it is a required relation |
missing_permissions | You do not have permissions to perform the requested operation. For further details, please contact your admin |
One of the following errors occurred:
| Error | Description |
|---|---|
not_found | A blueprint with the provided identifier was not found |
not_found | An entity with the provided identifier was not found |
One of the following errors occurred:
| Error | Description |
|---|---|
identifier_taken | The provided identifier already exists, identifiers must be unique |
One of the following errors occurred:
| Error | Description |
|---|---|
bad_request | Request body is too large (limit is 1MiB) |
One of the following errors occurred:
| Error | Description |
|---|---|
invalid_request | The provided data does not match the route schema |
team_inheritance_enabled | The blueprint's entities inherite their team from other entities through an existing relation |
blueprint_schema_mismatch | The provided entity does not match the blueprint's schema |
required_relation | A relation is required |
relation_many_violation | A provided relation cannot contain more than one entity |
One of the following errors occurred:
| Error | Description |
|---|---|
internal_error | An internal error occurred |