Sign in
Worksheets

Get a worksheet answer

Retrieve the details of a single worksheet answer (required scope worksheets:read)

get/v1/worksheetAnswers/{worksheetAnswerId}

Path parameters

worksheetAnswerIdinteger required

The unique identifier of the worksheet answer

Headers

Customer-Idinteger required

The customer identifier

Response

OK

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

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

The unique identifier of the entity

questionIdinteger

The unique identifier of the question

questionTextstring

The text body of the question

resourceIdinteger nullable

The unique identifier of the resource

worksheetIdinteger

The unique identifier of the worksheet

worksheetNamestring nullable

The name of the worksheet

questionType'boolean' | 'numberInteger' | 'numberDecimal' | 'text' | 'listMulti' | 'signature' | 'statement' | 'cost' | 'date' | 'photo' | 'time' | 'listSingle' | 'barcode' | 'appLaunch' | 'listIconSingle' | 'listIconMulti' | 'ocr' | 'file' | 'Unknown'

Enumeration representing different types of worksheet questions<p>Possible values:</p><ul><li><b>boolean</b>: Used for Yes/No worksheet Question types</li><li><b>numberInteger</b>: Used for Whole Number worksheet question types which allow the user to provide a whole number without a decimal place</li><li><b>numberDecimal</b>: Used for Decimal worksheet question types. Responses contain a number with a decimal place</li><li><b>text</b>: Used for Text worksheet question types</li><li><b>listMulti</b>: Used for worksheet type of List when the multiple answer setting is set to yes. Responses contain multiple items from a list defined on the worksheet question</li><li><b>signature</b>: Used for Signature worksheet question types. When used, a name and signature box will be presented for the user to complete</li><li><b>statement</b>: Used for statement worksheet question types. This presents a text-based statement which may be presented to the resource or the customer</li><li><b>cost</b>: Used for Cost question types. This allow a response including a description and an amount</li><li><b>date</b>: Used for worksheet questions with a type of Date</li><li><b>photo</b>: Used for photo worksheet question types. It requires the user to upload a photo or multiple photos</li><li><b>time</b>: Used for worksheet questions with the type of Time in the format of HH:MM</li><li><b>listSingle</b>: Used for worksheet type of List when the multiple answer setting is set to no. Responses contain multiple items from a list defined on the worksheet question</li><li><b>barcode</b>: Used for barcode worksheet questions. This stores the text contained within a barcode and may be scanned in via a device</li><li><b>appLaunch</b>: Used for worksheet questions with a type of Launch App. When used, a separate application specified in the worksheet question will be launched</li><li><b>listIconSingle</b>: Used for worksheet question type of Icon where the multiple answer setting is set to no. Responses contain multiple names or icons defined on the worksheet question</li><li><b>listIconMulti</b>: Used for worksheet question type of Icon where the multiple answer setting is set to yes. Responses contain multiple names or icons defined on the worksheet question</li><li><b>ocr</b>: Used for worksheet question with a type of OCR</li><li><b>file</b>: Used for worksheet question type of View File</li><li><b>unknown</b>: Represents an unknown worksheet question type</li></ul>

worksheetGroupNamestring

The name of the worksheet group

isMandatoryboolean

Is the worksheet answer mandatory

worksheetQuestionOrderinteger

The order of the question in the worksheet

notestring

The note attached to the worksheet answer

rawAnswerTextstring

Represents the raw, unparsed text of the worksheet answer

Example response

{
  "entityType": "job",
  "entityId": 4,
  "questionId": 3,
  "questionText": "How satisfied were you with the job?",
  "resourceId": 2,
  "worksheetId": 5,
  "worksheetName": "Example",
  "questionType": "boolean",
  "worksheetGroupName": "Example",
  "isMandatory": true,
  "worksheetQuestionOrder": 9,
  "note": "Example",
  "rawAnswerText": "Example"
}

Changes