Salesforce · JSON Structure

Salesforce Get List View Metadataby Api Name Structure

Type: object Properties: 18 Required: 18
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

GetListViewMetadatabyAPIName is a JSON Structure definition published by Salesforce, describing 18 properties, of which 18 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

cloneable createable deletable displayColumns filterLogicString filteredByInfo hasMassActions inlineEditDetails label listReference listShares objectApiNames orderedByInfo scope updateable userPreferences visibility visibilityEditable

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "name": "GetListViewMetadatabyAPIName",
  "properties": {
    "cloneable": {
      "type": "boolean"
    },
    "createable": {
      "type": "boolean"
    },
    "deletable": {
      "type": "boolean"
    },
    "displayColumns": {
      "type": "array",
      "description": "",
      "items": {
        "type": "object",
        "properties": {
          "fieldApiName": {
            "type": "string"
          },
          "inlineEditAttributes": {
            "type": "object"
          },
          "label": {
            "type": "string"
          },
          "lookupId": {
            "type": "['string', 'null']"
          },
          "searchable": {
            "type": "boolean"
          },
          "sortable": {
            "type": "boolean"
          }
        },
        "required": [
          "fieldApiName",
          "inlineEditAttributes",
          "label",
          "lookupId",
          "searchable",
          "sortable"
        ]
      }
    },
    "filterLogicString": {
      "type": "['string', 'null']"
    },
    "filteredByInfo": {
      "type": "array",
      "description": "",
      "items": {
        "type": "string"
      }
    },
    "hasMassActions": {
      "type": "boolean"
    },
    "inlineEditDetails": {
      "type": "object"
    },
    "label": {
      "type": "string"
    },
    "listReference": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "listViewApiName": {
          "type": "string"
        },
        "objectApiName": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "listViewApiName",
        "objectApiName",
        "type"
      ]
    },
    "listShares": {
      "type": "object"
    },
    "objectApiNames": {
      "type": "array",
      "description": "",
      "items": {
        "type": "string"
      }
    },
    "orderedByInfo": {
      "type": "array",
      "description": "",
      "items": {
        "type": "object",
        "properties": {
          "fieldApiName": {
            "type": "string"
          },
          "isAscending": {
            "type": "boolean"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "fieldApiName",
          "isAscending",
          "label"
        ]
      }
    },
    "scope": {
      "type": "object"
    },
    "updateable": {
      "type": "boolean"
    },
    "userPreferences": {
      "type": "object",
      "properties": {
        "columnWidths": {
          "type": "object",
          "properties": {
            "Site": {
              "type": "integer"
            },
            "Type": {
              "type": "integer"
            },
            "BillingCountry": {
              "type": "integer"
            },
            "Owner.Alias": {
              "type": "integer"
            },
            "Phone": {
              "type": "integer"
            },
            "Name": {
              "type": "integer"
            }
          },
          "required": [
            "Site",
            "Type",
            "BillingCountry",
            "Owner.Alias",
            "Phone",
            "Name"
          ]
        },
        "columnWrap": {
          "type": "object",
          "properties": {
            "Site": {
              "type": "boolean"
            },
            "Type": {
              "type": "boolean"
            },
            "BillingCountry": {
              "type": "boolean"
            },
            "Owner.Alias": {
              "type": "boolean"
            },
            "Phone": {
              "type": "boolean"
            },
            "Name": {
              "type": "boolean"
            }
          },
          "required": [
            "Site",
            "Type",
            "BillingCountry",
            "Owner.Alias",
            "Phone",
            "Name"
          ]
        }
      },
      "required": [
        "columnWidths",
        "columnWrap"
      ]
    },
    "visibility": {
      "type": "string"
    },
    "visibilityEditable": {
      "type": "boolean"
    }
  },
  "required": [
    "cloneable",
    "createable",
    "deletable",
    "displayColumns",
    "filterLogicString",
    "filteredByInfo",
    "hasMassActions",
    "inlineEditDetails",
    "label",
    "listReference",
    "listShares",
    "objectApiNames",
    "orderedByInfo",
    "scope",
    "updateable",
    "userPreferences",
    "visibility",
    "visibilityEditable"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}