# COTSurvey

###### tags: `in the making` `surveys`

## Description {#description}
Surveys are used to gather data from users. The _Surveys Data Model_ (COTSurvey) is the main information of a survey and consilidates its other parts: [COTSurveyChat](/docs/documentation/models/surveys/model_surveychats), [COTQuestion](/docs/documentation/models/surveys/model_questions), [COTAnswer](/docs/documentation/models/surveys/model_answers) .

## JSON Sample {#json-sample}

{
    "_id" : "614117b1dd1e5a64b1f93771",
    "__v" : 0,
    "code" : "maintenance_001",
    "company" : "614117afdd1e5a3086f92020",
    "createdAt" : "2021-09-14T21:44:17.778Z",
    "groupPermission" : "61438ed076b99e7941b8ff09",
    "groupPermissionsV2" : ["61439155467286620370b2a2", "6143916555dedbe9efe9baf0"],
    "isActive" : true,
    "isSystemModel" : false,
    "modifiedAt" : "2021-09-14T21:44:17.778Z",
    "name" : "Maintenance Order",
    "onlyChannelCreation" : false,
    "onlySubSurvey" : false,
    "permissions" : ["614391becb12b21c7f6adc75"],
    "permissionsV2" : ["report-surveys-read"],
    "propertiesChannel" : ["equipment_section_01"],
    "propertiesLimit" : ["machines_01"],
    "responders" : [
        {
            "filter" : "accessrole",
            "value" : "614393df19e63208e49d2297"
        }
    ],
    "skipCodeValidation" : false,
    "version" : 1
}

## Fields {#fields}

| Field | Description | [Type](/docs/documentation/models/overview_model#data-types) | Notes |
| ---- | ---- | ---- | ---- |
| id | The survey's unique identification code | ObjectId<COTSurvey\> | |
| __v | Version number | number | For internal system use only |
| code | The survey's unique identification name | string | Maximum 60 characters; only lowercase letters, numbers, and underscore allowed; must be unique. |
| company | Indicates the company the survey is found in | ObjectId<COTCompany\> | |
| createdAt | Date the survey was created | ISODate | YYYY-MM-DDTHH:mm:ss.SSSZ |
| groupPermission | Limits the use of the survey to specific group | ObjectId<COTGroup\> | Soon to be deprecated and replaced by `groupPermissionsV2`. |
| groupPermissionsV2 | List of groups where the survey may be used. If empty, the survey can be used in any group. | string[ ] | |
| isActive | Indicates if the survey is available for use | boolean | |
| isSystemModel | If true, the survey cannot be changed, even by admins | boolean | |
| modifiedAt | Indicates the last time the survey was modified | ISODate | YYYY-MM-DDTHH:mm:ss.SSSZ |
| name | The survey's displayed name in the administrative panel | string | |
| onlySubSurvey | If set as true, survey can _only_ be used within another survey, i.e., [COTQuestionContentType](/docs/documentation/models/surveys/model_questionContentType) `survey+survey` | boolean | [Survey Component](/docs/documentation/admin/survey/components/survey) |
| permissions | Users with at least one of the [access roles](/docs/documentation/models/users/model_accessroles) listed can answer the survey | ObjectId<COTAccessRole\>[ ] | Soon to be deprecated and replaced by `permissionsV2`. |
| permissionsV2 | Users with at least one of the permissions listed can access the survey | string[ ] | [List of default permissions](/docs/documentation/admin/admin_accessrole#default-permissions) |
| propertiesChannel | List of collection codes; used along with `propertiesLimit` to show the survey only on the channels that have the same collections and elements assigned. | string[ ] | |
| propertiesLimit | List of element codes; used along with `propertiesChannel` to show the survey only on the channels that have the same collections and elements assigned. | string[ ] | |
| responders | Designates which users can answer the survey | object[ ] | |
| responders[index].filter | Indicates the category or filter by which users will be selected | string | Options: `job`, `email`, `accessrole` |
| responders[index].value | List of filter values | string[ ] | |
| skipCodeValidation | Internal flag for legacy surveys | boolean | |
| version | Indicates the survey version and determines what fields should be used; `1` uses fields prior to January 2019; `2` uses fields created after January 2019 | number | Fields prior to January 2019: `permissions`, `group`, `groupPermissions`. Fields created after January 2019: `permissionsV2`, `groupPermissionsV2`, `onlySubSurvey`. |

## Deprecated {#deprecated}

| Field | Description | [Type](/docs/documentation/models/overview_model#data-types) | Notes |
| ---- | ---- | ---- | ---- |
| cc | Sends a copy of the survey results to the indicated recipients | string[ ] | DEPRECATED |
| editChannel | | string[ ] | DEPRECATED |
| etls | | [ ] | DEPRECATED |
| group | Replaced by `groupPermissionV2` | ObjectId<COTGroup\> | DEPRECATED |
| identifiersNeeded | | string[ ] | DEPRECATED |
| post | Specifies changes that occur _after_ a survey-instance is saved or modified | object | DEPRECATED |
| post.changeNotice | `default` or `null` (send notification to channel about change); `none` (do not send modification notice) | string | DEPRECATED |
| propagateSql | | boolean | DEPRECATED |
| propertiesNeeded | | string[ ] | DEPRECATED |
| src | | string | DEPRECATED |