BIbigchange
Worksheets

Set answers against a worksheet

Changed on

Sets one or more answers against a worksheet for a given entity. Supported entity types are Job and ContactNote (required scope worksheets:write)

put/v1/worksheets/{worksheetId}/answers

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/worksheets/{worksheetId}/answers
  • Auth
    HTTP bearer

Path parameters

worksheetIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

entityType'job' | 'contactNote' | 'stockItem' | 'activityLog' | 'activitySign' | 'assetCheck' required

Enumeration representing different types of worksheet answers<p>Possible values:</p><ul><li><b>job</b>: Answer relating to a job entity</li><li><b>contactNote</b>: Answer relating to a contact note entity</li><li><b>stockItem</b>: Answer relating to a stock item entity</li><li><b>activityLog</b>: Answer relating to an activity log entity</li><li><b>activitySign</b>: Answer relating to an activity sign entity</li><li><b>assetCheck</b>: Answer relating to an asset check entity</li></ul>

entityIdinteger required

The unique identifier of the entity that the answers relate to

Example request

{
  "entityType": "job",
  "entityId": 5514123,
  "answers": [
    {
      "questionId": 5514123,
      "note": "This answer was completed on Tuesday morning"
    }
  ]
}

Response

No Content

Changes