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

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "CompactLayoutInfo - Tooling API",
  "description": "Represents the metadata for a custom or standard compact layout.",
  "supported_soap_calls": "`query()`",
  "supported_rest_api_http_methods": "`GET`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The developer’s internal name for the compact layout (for example, CL_c) used in the API."
    },
    "DurableId": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field."
    },
    "EntityDefinition": {
      "type": "EntityDefinition",
      "properties": "Filter, Group, Sort",
      "description": "Available starting with version 32.0. The entity definition for the object associated with this CompactLayoutInfo.",
      "required": true
    },
    "EntityDefinitionId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "ID of the record associated with this CompactLayoutInfo. The record’s object type is in EntityDefinition.",
      "required": true
    },
    "FullName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The unique name used as the compact layout identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "IsDefault": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "If true, this compact layout is the default for the associated object."
    },
    "Items": {
      "type": "QueryResult",
      "properties": "Filter, Group, Sort",
      "description": "A foreign key field pointing to CompactLayoutItemsInfo. Because this field represents a relationship, use only in subqueries."
    },
    "Label": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The compact layout’s label."
    },
    "Metadata": {
      "type": "mns: CompactLayout",
      "properties": "Create, Nillable, Update",
      "description": "Metadata that defines compact layouts. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The namespace prefix associated with this object. Each Developer Edition organization 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 organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"CompactLayoutInfo\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:CompactLayout\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"CompactLayout\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"fields\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ID\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:length value=\"18\"/>\n    <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </xsd:restriction>\n</xsd:simpleType>\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```"
}