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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "Dashboard - Data API",
  "description": "Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "BackgroundDirection": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
      "description": "Returns the direction of the background fade. Available values are: Top to Bottom Left to Right Diagonal (default value) Label is Background Fade Direction."
    },
    "BackgroundEnd": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "Returns the ending fade color in hexadecimal. Label is Ending Color."
    },
    "BackgroundStart": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "Returns the starting fade color in hexadecimal. Label is Starting Color."
    },
    "ChartTheme": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Returns the background theme used for charts. Possible values are: dark—Dark Background light—Light Background"
    },
    "ColorPalette": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Returns the color palette used for the dashboard. Possible values are: Default—Default Palette accessible—Mineral(Accessible) Palette bluegrass—Branding Palette bluegrass—Bluegrass Palette colorSafe—Color Safe Palette dusk—Dusk Palette earth—Lake Palette fire—Fire Palette gray—Gray Palette heat—Heat Palette justice—Wildflowers Palette nightfall—Nightfall Palette pond—Pond Palette sunrise—Sunrise Palette tropic—Ocean Palette unity—Aurora Palette water—Water Palette watermelon—Watermelon Palette"
    },
    "DashboardResultRefreshedDate": {
      "type": "string",
      "properties": "Nillable",
      "description": "Returns the date on which the dashboard results were last refreshed."
    },
    "DashboardResultRunningUser": {
      "type": "string",
      "properties": "Nillable",
      "description": "The user whose security settings were used to generate the dashboard results."
    },
    "Description": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Returns the description of the dashboard. Limit: 255 characters."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Dashboard Unique Name. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.",
      "required": true
    },
    "FolderId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "Returns the ID of the Folder that contains the dashboard. See Folder. This is a relationship field.",
      "relationship_name": "Folder",
      "relationship_type": "Lookup",
      "refers_to": "Folder, User",
      "required": true
    },
    "FolderName": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "Name of the folder that contains the dashboard. Available in API version 35.0 and later."
    },
    "IsDeleted": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter",
      "description": "Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted."
    },
    "LastReferencedDate": {
      "type": "datetime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
    },
    "LastViewedDate": {
      "type": "datetime",
      "properties": "Filter, Nillable, Sort,",
      "description": "The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it."
    },
    "LeftSize": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Returns the size of the left column of the dashboard. Available values are: Narrow Medium Wide"
    },
    "MiddleSize": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Returns the size of the middle column of the dashboard. Available values are: Narrow Medium Wide"
    },
    "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."
    },
    "RightSize": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Returns the size of the right column in the dashboard. Available values are: Narrow Medium Wide"
    },
    "RunningUserId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "Returns the ID of the running user specified for the dashboard.If the dashboard was created in Lightning Experience and is configured to run as the viewing user, it returns the user ID of the dashboard creator. If the dashboard was created in Salesforce Classic and is configured to run as the logged-in user, returns the user ID of the last specified running user. This is a relationship field.",
      "relationship_name": "RunningUser",
      "relationship_type": "Lookup",
      "refers_to": "User"
    },
    "TextColor": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "Returns the body text color in hexadecimal. Label is Text Color."
    },
    "Title": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "Returns the title of the dashboard. Limit: 80 characters."
    },
    "TitleColor": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "Returns the title text color in hexadecimal. Label is Title Color."
    },
    "TitleSize": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "Returns the title font size in points. Label is Title Size."
    },
    "Type": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
      "description": "Returns the dashboard type. Available values are: SpecifiedUser—The dashboard displays data according to the access level of one specific running user. LoggedInUser—The dashboard displays data according to the access level of the logged-in user. MyTeamUser—The dashboard displays data according to the access level of the logged-in user, and managers can view dashboards from the point of view of users beneath them in the role hierarchy."
    }
  },
  "usage": "Provides read-only access to the current values in the dashboard fields.",
  "associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **DashboardFeed**: Feed tracking is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"Dashboard\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"BackgroundDirection\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"BackgroundEnd\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"BackgroundStart\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"ChartTheme\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ColorPalette\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DashboardComponents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"DashboardResultRefreshedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DashboardResultRunningUser\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Folder\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Folder\"/>\n        <element name=\"FolderId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"FolderName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LeftSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MiddleSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RightSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"RunningUser\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"RunningUserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TextColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"Title\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"TitleColor\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"TitleSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "BackgroundDirection": {
      "field_label": "Background Fade Direction",
      "type": "picklist",
      "length": "40"
    },
    "BackgroundEnd": {
      "field_label": "Ending Color",
      "type": "int",
      "digits": "9"
    },
    "BackgroundStart": {
      "field_label": "Starting Color",
      "type": "int",
      "digits": "9"
    },
    "ChartTheme": {
      "field_label": "Chart Background",
      "type": "picklist",
      "length": "40"
    },
    "ColorPalette": {
      "field_label": "Color Palette",
      "type": "picklist",
      "length": "40"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DashboardResultRefreshedDate": {
      "field_label": "Last refreshed for this user",
      "type": "string",
      "length": "256"
    },
    "DashboardResultRunningUser": {
      "field_label": "Running as",
      "type": "string",
      "length": "256"
    },
    "Description": {
      "field_label": "Description",
      "type": "string",
      "length": "255"
    },
    "DeveloperName": {
      "field_label": "Dashboard Unique Name",
      "type": "string",
      "length": "80"
    },
    "FolderId": {
      "field_label": "Folder ID",
      "type": "reference",
      "length": "18"
    },
    "FolderName": {
      "field_label": "Folder Name",
      "type": "string",
      "length": "256"
    },
    "Id": {
      "field_label": "Dashboard ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "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"
    },
    "LeftSize": {
      "field_label": "Left Size",
      "type": "picklist",
      "length": "40"
    },
    "MiddleSize": {
      "field_label": "Middle Size",
      "type": "picklist",
      "length": "40"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "15"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "RightSize": {
      "field_label": "Right Size",
      "type": "picklist",
      "length": "40"
    },
    "RunningUserId": {
      "field_label": "Running User ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TextColor": {
      "field_label": "Text Color",
      "type": "int",
      "digits": "9"
    },
    "Title": {
      "field_label": "Title",
      "type": "string",
      "length": "80"
    },
    "TitleColor": {
      "field_label": "Title Color",
      "type": "int",
      "digits": "9"
    },
    "TitleSize": {
      "field_label": "Title Size",
      "type": "int",
      "digits": "9"
    },
    "Type": {
      "field_label": "Dashboard Running User",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}