- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- UniqueEntityAddNote
Full name: projects.locations.instances.uniqueEntities.addNote
Adds a comment or note to a unique entity. Use this method to record observations or findings related to a specific entity for future investigation or collaboration.
HTTP request
POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/uniqueEntities:addNote Path parameters
| Parameters | |
|---|---|
parent |
Required. Format: projects/{project}/locations/{location}/instances/{instance}/uniqueEntities |
Request body
The request body contains an instance of UniqueEntityAddNote.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/chroniclehttps://www.googleapis.com/auth/chronicle.readonly
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
chronicle.uniqueEntities.update
For more information, see the IAM documentation.
UniqueEntityAddNote
Request message for UniqueEntityAddNote.
| JSON representation |
|---|
{ "author": string, "content": string, "entityIdentifier": string, "entityType": string, "entityEnvironment": string } |
| Fields | |
|---|---|
author |
Required. The author of the note. |
content |
Required. The content of the note. |
entityIdentifier |
Required. The entity identifier. |
entityType |
Required. The entity type. |
entityEnvironment |
Required. The entity environment. |