afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/Survey.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "field_reference"
  ],
  "title": "Survey - Data API",
  "description": "Represents a survey.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ActiveVersionID": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the survey version currently activated."
    },
    "Description": {
      "type": "string",
      "properties": "Nillable",
      "description": "The description of the survey. This field isn’t visible in the UI."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The survey’s unique API name."
    },
    "IsPartialSaveEnabled": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether to save the partial responses for the survey (true) or not (false). The default value is false."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that the current user last viewed a record related to the survey."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed the survey."
    },
    "LatestVersionId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the most recent version of this survey."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The name of the survey that appears in the UI. This field is read-only from API version 50.0."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the user who created the survey."
    },
    "SurveyType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Type of the survey. The default value is Survey. Possible values are: ASSESSMENT — Survey type for sales enablement teams. Available from API version 58.0 and later. BASIC — Survey with a question page with like or dislike, long text, multiple selection, NPS, rating, short text, and single selection questions, and without inserted participant responses, display logic, and page branching logic. SURVEY — Survey with all the available features."
    },
    "TotalVersionsCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of versions of the survey."
    }
  },
  "associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **SurveyChangeEvent**: Change events are available for the object.\n- **SurveyFeed (API version 42.0)**: Feed tracking is available for the object.\n- **SurveyOwnerSharingRule**: Sharing rules are available for the object.\n- **SurveyShare**: Sharing is available for the object.",
  "field_reference": {
    "ActiveVersionId": {
      "field_label": "Survey Version ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "65535"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "Id": {
      "field_label": "Survey ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsPartialSaveEnabled": {
      "field_label": "Allow Partial Save",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LatestVersionId": {
      "field_label": "Survey Version ID",
      "type": "reference",
      "length": "18"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "SurveyType": {
      "field_label": "Type",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalVersionsCount": {
      "field_label": "Number of Versions",
      "type": "int",
      "digits": "9"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}