Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/jobnote/file/list

The action returns files attached to a job note.

Request

FieldDescriptionRequired
note_idUnique identifier for the job notenumberYes

Example:

{
  "note_id": 204
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"note_id":204}' \
     https://ppw.web/svc/jobnote/file/list

Response

FieldDescriptionType
filesList of files attached to the job notearray

Each item in the files array is an object with the following fields:

FieldDescriptionType
file_idUnique identifier for a file attached the job notenumber
file_nameName of the filestring
file_typeMIME type name of the filestring

Example successful response:

{
  "files": [{
    "file_id": 48,
    "file_name": "Work_Order_Electrical_Repair_Conference_Room_2023-10-05.pdf",
    "file_type": "application\/pdf"
  }, {
    "file_id": 49,
    "file_name": "Job_Report_Conference_Room_Electrical_Issue_Repair_2023-10-05.pdf",
    "file_type": "application\/pdf"
  }]
}

Errors

Error TypeDescriptionStatus Code
note_id_requiredValid note_id is required400