CheckLists

Update a response to a checklist question

Updates the specified response to a checklist question.

put/checklists/{checkListResponseId}/CheckListResponse

Request

Path parameters

checkListResponseIdinteger required

ID of the response to a checklist question to update. Pass the GET /workorders/{workOrderId}/checklists-responses request to retrieve the response ID.

Query parameters

overrideAttachmentsboolean

Set to true to remove all existing attachments from the checklist response except for the attachment specified by the CheckListResponsePictureId parameter. When the CheckListResponsePictureId parameter is not specified and this parameter is set to true, the method removes all existing attachments and adds the file provided in the file parameter to the checklist response. When the CheckListResponsePictureId parameter is not specified and this parameter is set to false, the method keeps the existing attachments and adds the new file specified by the file parameter. By default, this parameter is set to false.

version'V1' | 'V2'

Version of the response object. The default value is V1. Specify V2 to receive the response object that contains a list of attachments instead of a single attachment.

Request body multipart/form-data

CheckListResponsePictureIdunknown
filestring binary

File to attach to the response to a checklist question. Required for questions with the PictureFlag parameter set to 2.

Response

The specified response to a checklist question is updated. A checklist response object and an attachment object are returned.

Changes

No recorded changes to this operation across all 1 revision of this API.