Form Object
Field Guide
The form object has the following attributes when listed in a folder:
| Attribute | Description |
|---|---|
| id | unique identifier of form |
| rowStatus | status of form (active, inactive, etc) |
| ordinal | order of form |
| completed | whether the form is completed |
| completedAt | the date and time the form was completed |
| createdAt | the date and time the form was created |
| completedBy.id | unique identifier of the user who completed the form |
| completedBy.firstName | first name of user who completed the form |
| completedBy.lastName | last name of user who completed the form |
| createdBy.id | unique identifier of user who created the form |
| createdBy.firstName | first name of user who created the form |
| createdBy.lastName | last name of user who created the form |
| locationName | name of form’s location |
| areaName | name of form’s area |
| formTemplate.id | unique identifier of the form’s template |
| formTemplate.name | name of the form’s template |
| asset.id | unique identifier of the form’s asset |
| asset.id1 | id1 of the form’s asset |
| asset.id2 | id2 of the form’s asset |
| classification.id | unique identifier of the form template’s classification |
| classification.name | name of the form template’s classification |
| classification.rowStatus | the status of a form template’s classification (active, inactive, etc) |
| imageUrlSmall | the url of the classification small image icon |
| prioritiesCount.high | the number of high priorities found on the form |
| prioritiesCount.medium | the number of medium priorities found on the form |
| prioritiesCount.low | the number of low priorities found on the form |
| account.id | unique identifier of the form’s account |
| account.name | the name of the form’s account |
| account.num | the num (identifier) of the form’s account |
| note | any additional notes added to the form |
| locationId | unique identifer of the form’s location |
| areaId | unique identifier of the form’s area |
| questionsCount | the number of questions on the form |
| questionsAnsweredCount | the number of completed questions on the form |
| questionsResolvedCount | the number of resolved questions on the form |
| totalPrioritiesCount | the number of answers with low, medium, or high priorities |
A single form get has the following attributes:
| Attribute | Description |
|---|---|
| id | unique identifier of form |
| rowStatus | status of form (active, deleted, etc) |
| instructions | instructions shown at the beginning of the form |
| accountId | unique identifier of the form’s account |
| completed | whether the form is completed |
| completedAt | the date and time the form was completed |
| createdAt | the date and time the form was created |
| completedBy.id | unique identifier of the user who completed the form |
| completedBy.firstName | first name of user who completed the form |
| completedBy.lastName | last name of user who completed the form |
| createdBy.id | unique identifier of user who created the form |
| createdBy.firstName | first name of user who created the form |
| createdBy.lastName | last name of user who created the form |
| formTemplate.id | unique identifier of the form’s template |
| formTemplate.name | name of the form’s template |
| asset.id | unique identifier of the form’s asset |
| asset.id1 | id1 of the form’s asset |
| asset.id2 | id2 of the form’s asset |
| classification.id | unique identifier of the form template’s classification |
| classification.name | name of the form template’s classification |
| classification.rowStatus | the status of a form template’s classification (active, inactive, etc) |
| classification.imageUrlSmall | url of where classification icon is |
| folder.id | unique identifier of form’s folder |
| folder.folderTypeName | name of form’s folder’s type |
| folder.folderTypeColor | color of form’s folder’s type |
| folder.num | id of form’s folder |
| note | any additional notes added to the form |
| locationId | unique identifer of the form’s location |
| areaId | unique identifier of the form’s area |
| formTemplate.id | unique identifier of a form’s template |
| formTemplate.name | the name a form’s template |
| assetId | unique identifier of a form’s asset |
| requiresAsset | whether the form requires an asset |
| reference1 | a custom field for imports or any purpose only displayed through API |
| reference2 | a custom field for imports or any purpose only displayed through API |
| reference3 | a custom field for imports or any purpose only displayed through API |