patch deprecated
https://generic-entity/v1/generic-entities/
Update Generic Entity
The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40.
If your environment is on version 2.3.40 or later, you can optionally migrate to V3.
Contact Customer Success to enable V3 for your account.
Performs partial update, if a field is specified in the request it will be updated
(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| _name | string | true | ||
| _ownerOrganization | object | false | ||
| _ownerOrganization.id | string | true(*) | ||
| Path Parameters: |
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| id | string | true | Generic Entity ID that needs to be updated | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| Query Parameters: |
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| includeReferencers | boolean | false | Optional query parameter that controls whether the response should include referencers metadata. When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments. Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned. |
This API requires PROTECTED_API permission(s).