This set of APIs manages the full lifecycle of a “Note” resource. Each API plays a specific role, and together they provide a standard create–read–update pattern.

1. List Notes API

GET /api-public/1.0/notes

This endpoint retrieves a list of notes that the authenticated user is authorized to view.

Operation:

• The authenticated client sends a GET request with query parameters.
• The server returns an object containing records and count, where records contains the notes records and count indicates how many records were returned.

Use query parameters to:

• Limit the number of records to return with limit
• List records before or after the given field value together with sort
• Control sort direction with order
• Limit the returned fields with fields
• Filter results by supported (string based) note fields, such as noteType, caseID, etc.

Typical Response (200 Notes retrieved successfully):

{
  "records": [
    {
      "id": "string",
      "createdDate": "UTC time"
      ...
    }
  ],
  ...
  "count": integer
}

Purpose:

• View existing note information.
• Find and query all notes meeting certain criteria.

2. Create Note API

POST /note

This endpoint is responsible for creating a new note in the system.

Operation:

• The authenticated client sends note details in the request body.
• The server validates and stores the new note.
• A unique note id is generated and returned in the response.

Typical Response (201 Created):

{
  "id": "uuid string",
  "createdDate": "UTC time"
  ...
}

Purpose:

• Initialize a fresh note record.
• Retrieve the ID required for further operations (retrieval, updates).

3. Retrieve Note API

GET /note/:id

This endpoint is used to fetch an existing note by its ID.

Operation:

• Client sends a GET request with the id returned from the create step.
• The server validates the ID and returns the note details.

Typical Response (200 OK):

{
  "id": "uuid string",
  "createdDate": "UTC time"
  ...
}

Purpose:

• View existing profile information.
• Confirm data that was created or previously updated.

4. Update Note API

PUT /note/:id or PATCH /note/:id

These endpoints allow modifying an existing profile.

• PUT: replaces the entire profile record with the new payload.
• PATCH: applies a partial update, only modifying provided fields.

Operation:

• Client sends updated fields with the correct id.
• Server applies the update and returns the updated record or status.

Typical Response (200 OK):

{
  "id": "12345",
  "createdDate": "UTC time",
  ...
}

Purpose:

• Modify or correct profile information.
• Progress the profile through its lifecycle.

How They Work Together

1. Create a note using POST /note.
2. Server returns an id.
3. Use this ID to either:
   1. Retrieve the profile (GET /note/:id)
   2. Update the profile (PUT/PATCH /note/:id)

This flow ensures all note operations are securely tied to an authenticated session, and that each note is managed consistently using its unique identifier.