Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CLINTONARMANDO/apiregistropendientes/llms.txt

Use this file to discover all available pages before exploring further.

Notes (notas) are timestamped annotations attached to a work order. They capture free-text observations, the state of the order at the time of writing, and optional images taken in the field. Every time a technician records progress or an issue, a nota is the right place to store it. Base path: /api/notas
All note endpoints require a valid Authorization: Bearer <token> header.

​
POST /api/notas

Create a new note on a work order. Notes are linked to both the pendiente and the employee who wrote them, and they capture the current state of the order for historical context.

​
Request body

​
pendienteId
number
required
ID of the work order this note belongs to.
​
empleadoId
number
required
ID of the employee authoring the note.
​
nota
string
required
The note text. Supports free-form content — describe observations, actions taken, or next steps.
​
estadoPendiente
string
required
Snapshot of the work order’s state at the time of writing. One of: REGISTRADO, ASIGNADO, EN_PROGRESO, PAUSADO, REVISION, POR_VALIDAR, OBSERVADO, FINALIZADO, POSTERGADO, CANCELADO.

​
Response — 200 OK

Returns the created PendienteNotaResponse:
​
id
number
Note ID.
​
pendienteId
number
Parent work order ID.
​
empleadoId
number
Author employee ID.
​
nota
string
Note text.
​
estadoPendiente
string
Work order state captured at creation time.
​
fechaCreacion
string
ISO 8601 timestamp of creation.
​
imagenes
PendienteNotaImagenResponse[]
Array of images attached to this note (empty on creation, populated via the upload endpoint).

​
Example

cURL
curl --request POST \
  --url https://api.example.com/api/notas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "pendienteId": 42,
    "empleadoId": 9,
    "nota": "Llegué al domicilio. El splitter externo está dañado. Procedo con el reemplazo.",
    "estadoPendiente": "EN_PROGRESO"
  }'

​
GET /api/notas/

Retrieve a single note by ID, including its attached images.
​
id
number
required
Note ID.
cURL
curl --request GET \
  --url https://api.example.com/api/notas/15 \
  --header 'Authorization: Bearer <token>'

​
PUT /api/notas/

Update an existing note’s text or state snapshot.
​
id
number
required
ID of the note to update.
Send the same fields as POST /api/notas with the values you want to update.
cURL
curl --request PUT \
  --url https://api.example.com/api/notas/15 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "pendienteId": 42,
    "empleadoId": 9,
    "nota": "Splitter reemplazado. Señal estable en -22 dBm. Entregado al cliente.",
    "estadoPendiente": "POR_VALIDAR"
  }'

​
DELETE /api/notas/

Soft-delete a note. The record is retained in the database but excluded from normal queries.
​
id
number
required
ID of the note to delete.
cURL
curl --request DELETE \
  --url https://api.example.com/api/notas/15 \
  --header 'Authorization: Bearer <token>'

​
GET /api/notas/pendiente/

List all notes for a work order, ordered by fechaCreacion ascending. Each note includes its attached images.
​
pendienteId
number
required
ID of the work order whose notes you want to retrieve.
cURL
curl --request GET \
  --url https://api.example.com/api/notas/pendiente/42 \
  --header 'Authorization: Bearer <token>'

​
POST /api/notas//imagenes/upload

Upload one or more images to an existing note. This endpoint uses multipart/form-data encoding — not JSON. Use this to attach photos taken in the field (e.g. before/after shots of the installation).
​
notaId
number
required
ID of the note to attach images to.
​
files
file[]
required
One or more image files. Use the field name files for each file part. Supported formats depend on server configuration (typically JPEG, PNG).

​
Response — 200 OK

Returns an array of PendienteNotaImagenResponse objects for the newly uploaded images.
​
id
number
Image ID.
​
notaId
number
Parent note ID.
​
url
string
Public URL to access the stored image.
Do not send a Content-Type: application/json header with this request. The browser or HTTP client must set the boundary for multipart automatically.

​
Examples

curl --request POST \
  --url https://api.example.com/api/notas/15/imagenes/upload \
  --header 'Authorization: Bearer <token>' \
  --form 'files=@/path/to/photo1.jpg' \
  --form 'files=@/path/to/photo2.jpg'

​
GET /api/notas//imagenes

Retrieve all images attached to a specific note.
​
notaId
number
required
Note ID.

​
Response — 200 OK

Returns an array of PendienteNotaImagenResponse objects.
cURL
curl --request GET \
  --url https://api.example.com/api/notas/15/imagenes \
  --header 'Authorization: Bearer <token>'

​
PUT /api/notas//imagenes

Update the image records associated with a note. This endpoint accepts a JSON array of image request objects, not multipart form data.
​
notaId
number
required
Note ID.
Send a JSON array of PendienteNotaImagenRequest objects in the request body.
cURL
curl --request PUT \
  --url https://api.example.com/api/notas/15/imagenes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[{"url": "/uploads/notas/photo1.jpg"}, {"url": "/uploads/notas/photo2.jpg"}]'

Build docs developers (and LLMs) love

Get started for freeTalk to us