afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/RelatedListDefinition.json

83 lines
5.5 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"special_access_rules",
"wsdl_segment"
],
"title": "RelatedListDefinition - Tooling API",
"description": "Represents information about a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later.",
"supported_soap_calls": "`describeSObjects()`, `query()`",
"supported_rest_api_http_methods": "`Query`",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"DefaultSort": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The default sort string for the related list."
},
"DurableId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The unique identifier for the related list. Always retrieve this value before using it, as the value can change from one release to the next. Simplify queries by using this field instead of making multiple queries."
},
"EntityDefinitionId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the entity containing the related list. This is a relationship field.",
"relationship_name": "EntityDefinition",
"relationship_type": "Lookup",
"refers_to": "EntityDefinition"
},
"IsCustomizable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether columns on the related list can be customized (true) or not (false). The default value is false."
},
"IsDescribable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the related list can appear in describeLayout call results (true) or not (false). The default value is false."
},
"IsLayoutable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the related list can be assigned to a layout. (true) or not (false). The default value is false."
},
"Label": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The label for the related list."
},
"ParentEntityDefinitionId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the ParentEntityDefinition thats associated with the rows in the related list. This is a relationship field.",
"relationship_name": "ParentEntityDefinition",
"relationship_type": "Lookup",
"refers_to": "EntityDefinition"
},
"RelatedListId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the related list."
},
"RelatedListName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The unique name of the related list in the API."
}
},
"special_access_rules": "This object is read-only.",
"wsdl_segment": "```xml\n<xsd:simpleType name=\"QueryLocator\">\n <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"QueryResult\">\n <xsd:sequence>\n <xsd:element name=\"done\" type=\"xsd:boolean\"/>\n <xsd:element name=\"entityTypeName\" type=\"xsd:string\"/>\n <xsd:element name=\"nextRecordsUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"queryLocator\" type=\"tns:QueryLocator\"/>\n <xsd:element name=\"records\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"ens:sObject\"/>\n <xsd:element name=\"size\" type=\"xsd:int\"/>\n <xsd:element name=\"totalSize\" type=\"xsd:int\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"RelatedListDefinition\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"DefaultSort\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"DurableId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"EntityDefinition\" minOccurs=\"0\" type=\"ens:EntityDefinition\" nillable=\"true\"/>\n <xsd:element name=\"EntityDefinitionId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"IsCustomizable\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsDescribable\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsLayoutable\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"Label\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"ParentEntityDefinition\" minOccurs=\"0\" type=\"ens:EntityDefinition\" nillable=\"true\"/>\n <xsd:element name=\"ParentEntityDefinitionId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"RelatedListColumnDefinitions\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n <xsd:element name=\"RelatedListId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"RelatedListName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
}