afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/WaveDashboard.json

50 lines
3.1 KiB
JSON

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "WaveDashboard - Metadata API",
"description": "Represents the WaveDashboard object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.",
"file_information": ".wdash",
"directory_location": "wave",
"fields_columns": [
"type",
"description"
],
"fields": {
"application": {
"type": "string",
"description": "The internal name of the application.",
"required": true
},
"dateVersion": {
"type": "integer",
"description": "The date version for the dashboard. Only available in v55.0 and above."
},
"description": {
"type": "string",
"description": "The dashboard description that appears in the user interface."
},
"masterLabel": {
"type": "string",
"description": "The dashboard name that appears in the user interface.",
"required": true
},
"templateAssetSourceName": {
"type": "string",
"description": "Links the dashboard to the template used to create it. Null for assets not created from a template."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n <xsd:sequence>\n <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MetadataWithContent\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"content\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"WaveComponent\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:WaveDashboard\">\n <xsd:sequence/>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"WaveDashboard\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:MetadataWithContent\">\n <xsd:sequence>\n <xsd:element name=\"application\" type=\"xsd:string\"/>\n <xsd:element name=\"dateVersion\" minOccurs=\"0\" type=\"xsd:int\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n <xsd:element name=\"templateAssetSourceName\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a WaveDashboard component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<WaveDashboard xmlns=\"http://soap.sforce.com/2006/04/metadata\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n <content xsi:nil=\"true\"/>\n <application>dev__app</application>\n <masterLabel>Dashboard1</masterLabel>\n <description>somedesc</description>\n</WaveDashboard>"
}
]
}