latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Worksheets

Get a collection of worksheet questions related to a worksheet

Retrieve the details of worksheet questions for a given worksheet (required scope worksheets:read)

get/v1/worksheets/{worksheetId}/worksheetQuestions

Path parameters

worksheetIdinteger required

The unique identifier of the worksheet

Query parameters

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

idinteger

The unique identifier of the worksheet question

questionTextstring

The title associated with the given question

orderinteger

The order of the question in the worksheet

Enumeration representing different types of worksheet questionsPossible values:<ul><li>boolean: Used for Yes/No worksheet Question types</li><li>numberInteger: Used for Whole Number worksheet question types which allow the user to provide a whole number without a decimal place</li><li>numberDecimal: Used for Decimal worksheet question types. Responses contain a number with a decimal place</li><li>text: Used for Text worksheet question types</li><li>listMulti: 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>signature: Used for Signature worksheet question types. When used, a name and signature box will be presented for the user to complete</li><li>statement: Used for statement worksheet question types. This presents a text-based statement which may be presented to the resource or the customer</li><li>cost: Used for Cost question types. This allow a response including a description and an amount</li><li>date: Used for worksheet questions with a type of Date</li><li>photo: Used for photo worksheet question types. It requires the user to upload a photo or multiple photos</li><li>time: Used for worksheet questions with the type of Time in the format of HH:MM</li><li>listSingle: 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>barcode: Used for barcode worksheet questions. This stores the text contained within a barcode and may be scanned in via a device</li><li>appLaunch: 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>listIconSingle: 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>listIconMulti: 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>ocr: Used for worksheet question with a type of OCR</li><li>file: Used for worksheet question type of View File</li><li>unknown: Represents an unknown worksheet question type</li></ul>

isMandatoryboolean

Indicates whether the answer to the worksheet question is mandatory

defaultRawAnswerTextstring nullable

Default answer text for a given question

maxLengthinteger nullable

The maximum length allowed for the answer for a question of type Text

validItemsstring[] nullable

A list of valid items that can be selected or entered as answers for a question of type ListSingle, ListMulti, ListIconSingle, or ListIconMulti

Example response

{
  "id": 123,
  "questionText": "Example question title",
  "order": 9,
  "type": "boolean",
  "isMandatory": true,
  "defaultRawAnswerText": "This is my default answer",
  "maxLength": 255,
  "validItems": [
    "Option1",
    "Option2",
    "Option3"
  ]
}