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

71 lines
3.9 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "DashboardComponent - Data API",
"description": "Represents a dashboard component, which can be a chart, metric, table, or gauge on a dashboard. Access is read-only. This object is available in API version 21.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"CustomReportId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "Requires the user permission \"Manage All Private Reports and Dashboards.\" The ID of the report that provides data for the dashboard component. See Report."
},
"DashboardId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the dashboard that contains the dashboard component. See Dashboard. This is a relationship field.",
"relationship_name": "Dashboard",
"relationship_type": "Lookup",
"refers_to": "Dashboard"
},
"Name": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The name of the dashboard component."
}
},
"usage": "Provides read only access to the current values in dashboard component 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- **DashboardComponentFeed**: Feed tracking is available for the object.",
"wsdl_segment": "```xml\n<complexType name=\"DashboardComponent\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"CustomReportId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Dashboard\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Dashboard\"/>\n <element name=\"DashboardId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Name\" 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": {
"CustomReportId": {
"field_label": "Report ID",
"type": "reference",
"length": "18"
},
"DashboardId": {
"field_label": "Dashboard ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Dashboard Component ID",
"type": "id",
"length": "18"
},
"Name": {
"field_label": "Dashboard Component Name",
"type": "string",
"length": "80"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}