Create a Component Note with or without Attachments: /component/{CC_UUID}/{CC_RECORD_ID}/notes
Purpose
This API allows you to create a new note for a specific component record, with the option to attach one or more files (such as images, PDFs, or documents). It enables users to add contextual notes and supporting files directly to component records, ensuring better traceability and documentation in inspection or service workflows.
Use Case
Use this endpoint when you need to log a new note against a component record, such as recording inspection findings, technician comments, or incident reports. You can also upload related attachments (photos, scanned documents, or evidence files) alongside the note to keep all information centralized in the system.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
CC_UUID |
string | Yes | Unique identifier of the component. |
CC_RECORD_ID |
string | Yes | Unique identifier of the component record where the note is being added. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
The request body must be sent as form-data.
| Field | Type | Required | Description |
|---|---|---|---|
note |
string | Yes | Text content of the note to be created. |
attachment |
file | Optional | One or more files to be uploaded and linked to the note. Supports multiple file attachments. |
Response
The response returns a JSON object wrapped under the component name (e.g., Inspection Service Package). Inside, the notes object provides a unique identifier (uuid) for the newly created note. This UUID is critical for referencing the note in future operations, such as retrieving details, updating, attaching additional files, or deleting the note. If files were attached, they are stored and linked to this note in the system, but only the uuid of the note is returned in this response for lightweight confirmation.
Response Body
{
"Inspection Service Package": {
"notes": {
"uuid": "298bdee6-35ec-4441-834f-91e4af3a6748"
}
}
}| Attribute | Type | Description |
|---|---|---|
uuid |
string | Unique identifier of the created note. |