Retrieve Component Notes: /component/{CC_UUID}/{CC_RECORD_ID}/notes

Purpose

This API retrieves all notes associated with a specific component record. Notes may include text content, attached files, authorship details, timestamps, and custom attributes. It also provides pagination details for handling multiple records.

Use Case

This API is useful for applications where users need to view comments, inspection notes, or audit logs tied to a particular component record. For example, in a field service inspection system, technicians can fetch inspection notes (including remarks, supporting files, and updates) linked to a specific inspection service package or component instance.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a JSON object keyed by the component name (example: Inspection Service Package). Inside, the notes object contains two parts: a notes array with multiple note objects, and a pagination object with record navigation details. Each note includes metadata such as uuid, version, textual content, any attached files, author and timestamp fields (created_by, created_on, last_updated_by, last_updated_on), and custom_attributes. If present, each file provides its own uuid, name, and version.

Response Body

Retrieve Specific Component Note: /component/{CC_UUID}/{CC_RECORD_ID}/notes/{NOTE_UUID} 

Purpose

This API retrieves the details of a specific note associated with a component record. It provides full metadata including content, version, author information, timestamps, attached files, and custom attributes.

Use Case

Use this endpoint when you need to fetch a single note by its unique identifier (NOTE_UUID) within a specific component (CC_UUID) and record (CC_RECORD_ID). It is useful for displaying note details, auditing note history, or retrieving attached files for a specific inspection or service record.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a JSON object grouped under the component name (e.g., Inspection Service Package). Inside, the notes object represents the requested note, containing attributes such as uuid (unique note ID), version, and content (in text or HTML). It also includes files, which is a list of attached file objects with details like uuid, name, and version. Metadata fields such as created_by and created_on specify who created the note and when, while last_updated_by and last_updated_on capture any updates (if available). Finally, custom_attributes holds additional metadata or remains empty if no custom attributes are defined.

Response Body

Retrieve Files Attached to a Note: /component/{CC_UUID}{CC_RECORD_ID}/notes/{NOTE_UUID}/files

Purpose

This API retrieves the list of files attached to a specific note within a component record. It provides metadata about each file, including unique identifiers, names, and versions, along with any custom attributes.

Use Case

Use this endpoint when you need to access the files associated with a note, such as inspection photos, scanned documents, or reference attachments. It is commonly used for previewing, downloading, or validating the files linked to a specific note in inspection workflows or service documentation.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a JSON object grouped under the component name (example: Inspection Service Package). Inside, the notes object contains two properties: files and custom_attributes. The files property is an array of objects, each representing a file attached to the note, including attributes such as uuid (unique file identifier), name (filename with extension), and version. The custom_attributes property provides any additional metadata defined for the note’s files, which may be empty if no custom attributes exist.

Response Body

Retrieve a Specific File from a Note: /component/{CC_UUID}/{CC_RECORD_ID}/notes/{NOTE_UUID}/files/{FILE_UUID}

Purpose

This API retrieves detailed metadata of a single file attached to a specific note in a component record. It is useful for identifying, verifying, or referencing a file before download or processing.

Use Case

Use this endpoint when you need to fetch details of a specific file (such as inspection photos, reports, or attachments) linked to a note. Typical scenarios include previewing file metadata in an inspection system, confirming file versions before updates, or validating attachments in compliance workflows.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a JSON object structured under the component name (example: Inspection Service Package). Inside it, the notes object contains two elements: file and custom_attributes. The file object provides metadata for the requested file, including its uuid (unique identifier), name (original filename with extension), and version (file version). The custom_attributes array holds any additional custom-defined metadata related to the file, which may be empty if no such attributes are defined.

Response Body