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/detach

The action detaches a file from a job note.

Request

FieldDescriptionTypeRequired
note_idUnique identifier for the job notenumberYes
file_idUnique identifier for a file attached the job notenumberYes

Example:

{
  "note_id": 245,
  "file_id": 53
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"note_id": 245, "file_id": 53}' \
     https://ppw.web/svc/jobnote/file/detach

Response

FieldDescriptionType
messageFile detach messagestring
latest_noteInformation about the latest job note revesionobject

See /jobnote/update for information about the latest_note object.

Example successful response:

{
  "message": "File detached",
  "latest_note": {
    "note_id": 246,
    "revisions": [226, 228, 233, 244, 245, 246],
    "base_revision": 226
  }
}

Errors

Error TypeDescriptionStatus Code
note_id_requiredValid note_id is required400
file_id_requiredValid file_id is required400
file_not_foundFile not found attached to job note400
file_detach_not_allowedFile cannot be detached from the job note400