Retrieve Component Notes: /component/{component_uuid}/{component_record_id}/notes

Purpose

This API retrieves all notes associated with a specific component record.

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/{component_uuid}/{component_record_id}/notes/{note_uuid}

Purpose

This API retrieves the details of a specific note associated with a component record.

Use Case

Use this endpoint when you need to fetch a single note by its unique identifier (note uuid) within a specific component and record. It is useful for displaying note details, auditing note history, or retrieving attached files for a specific 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 (example: 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/{component_uuid}/{component_record_id}/notes/{note_uuid}/files

Purpose

This API retrieves the list of files attached to a specific note within a component record.

Use Case

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

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/{component_uuid}/{component_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 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