Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Worksheets

Get a list of worksheet answers

Retrieve a paged collection of worksheet answers. At least one of entityId, worksheetId or questionId must be provided (required scope worksheets:read)

get/v1/worksheetAnswers

Query parameters

questionIdinteger[]

Only return answers where questionId matches the value(s) provided. At least one of questionId, entityId or worksheetId must be provided (Max items: 50)

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>

Example:job

Only return answers where entityType matches the value provided

entityIdinteger[]

Only return answers where entityId matches the value(s) provided. To use this filter, entityType must also be provided. At least one of entityId, worksheetId or questionId must be provided (Max items: 50)

worksheetIdinteger[]

Only return answers where worksheetId matches the value(s) provided. At least one of worksheetId, entityId or questionId must be provided (Max items: 50)

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

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}