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

107 lines
4.3 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"wsdl_segment",
"field_reference"
],
"title": "CustomHelpMenuItem - Data API",
"description": "Represents the items within a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. This object is available in API version 44.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"LinkUrl": {
"type": "url",
"properties": "Create, Filter, Sort, Update",
"description": "The URL for the resource. Specify up to 1,000 characters.",
"required": true
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The name of the resource. Specify up to 100 characters.",
"required": true
},
"ParentId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID of the custom help section the item belongs to. This is a relationship field.",
"relationship_name": "Parent",
"relationship_type": "Lookup",
"refers_to": "CustomHelpMenuSection"
},
"SortOrder": {
"type": "int",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The order of the item within the custom section. Valid values are 1 through 15.",
"required": true
}
},
"wsdl_segment": "```xml\n<complexType name=\"CustomHelpMenuItem\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"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=\"LinkUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:CustomHelpMenuSection\"/>\n <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"SortOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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```",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Custom Help Menu Item 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"
},
"LinkUrl": {
"field_label": "Link URL",
"type": "url",
"length": "1000"
},
"MasterLabel": {
"field_label": "Item Label",
"type": "string",
"length": "100"
},
"ParentId": {
"field_label": "Custom Help Menu Section ID",
"type": "reference",
"length": "18"
},
"SortOrder": {
"field_label": "Sort Order",
"type": "int",
"digits": "9"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}