Salesforce · JSON Structure

Salesforce Get List View Recordsby Id Structure

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

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

Properties

count currentPageToken currentPageUrl fields listInfoETag listReference nextPageToken nextPageUrl optionalFields pageSize previousPageToken previousPageUrl records searchTerm sortBy where

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

JSON Structure

Raw ↑
{
  "type": "object",
  "name": "GetListViewRecordsbyID",
  "properties": {
    "count": {
      "type": "integer"
    },
    "currentPageToken": {
      "type": "string"
    },
    "currentPageUrl": {
      "type": "string"
    },
    "fields": {
      "type": "array",
      "description": "",
      "items": {
        "type": "string"
      }
    },
    "listInfoETag": {
      "type": "string"
    },
    "listReference": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "listViewApiName": {
          "type": "string"
        },
        "objectApiName": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "listViewApiName",
        "objectApiName",
        "type"
      ]
    },
    "nextPageToken": {
      "type": "string"
    },
    "nextPageUrl": {
      "type": "string"
    },
    "optionalFields": {
      "type": "array",
      "description": "",
      "items": {
        "type": "string"
      }
    },
    "pageSize": {
      "type": "integer"
    },
    "previousPageToken": {
      "type": "['string', 'null']"
    },
    "previousPageUrl": {
      "type": "['string', 'null']"
    },
    "records": {
      "type": "array",
      "description": "",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string"
          },
          "childRelationships": {
            "type": "object"
          },
          "eTag": {
            "type": "string"
          },
          "fields": {
            "type": "object",
            "properties": {
              "BillingCountry": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "['string', 'null']"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "CreatedDate": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Id": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "LastModifiedById": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "LastModifiedDate": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Name": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Owner": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "string"
                  },
                  "value": {
                    "type": "object",
                    "properties": {
                      "apiName": {
                        "type": "object"
                      },
                      "childRelationships": {
                        "type": "object"
                      },
                      "eTag": {
                        "type": "object"
                      },
                      "fields": {
                        "type": "object"
                      },
                      "id": {
                        "type": "object"
                      },
                      "lastModifiedById": {
                        "type": "object"
                      },
                      "lastModifiedDate": {
                        "type": "object"
                      },
                      "recordTypeId": {
                        "type": "object"
                      },
                      "recordTypeInfo": {
                        "type": "object"
                      },
                      "systemModstamp": {
                        "type": "object"
                      }
                    },
                    "required": [
                      "apiName",
                      "childRelationships",
                      "eTag",
                      "fields",
                      "id",
                      "lastModifiedById",
                      "lastModifiedDate"
                    ]
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "OwnerId": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Phone": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "['string', 'null']"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Site": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "['string', 'null']"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "SystemModstamp": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              },
              "Type": {
                "type": "object",
                "properties": {
                  "displayValue": {
                    "type": "['string', 'null']"
                  },
                  "value": {
                    "type": "['string', 'null']"
                  }
                },
                "required": [
                  "displayValue",
                  "value"
                ]
              }
            },
            "required": [
              "BillingCountry",
              "CreatedDate",
              "Id",
              "LastModifiedById",
              "LastModifiedDate",
              "Name",
              "Owner",
              "OwnerId",
              "Phone",
              "Site",
              "SystemModstamp",
              "Type"
            ]
          },
          "id": {
            "type": "string"
          },
          "lastModifiedById": {
            "type": "string"
          },
          "lastModifiedDate": {
            "type": "string"
          },
          "recordTypeId": {
            "type": "string"
          },
          "recordTypeInfo": {
            "type": "['string', 'null']"
          },
          "systemModstamp": {
            "type": "string"
          }
        },
        "required": [
          "apiName",
          "childRelationships",
          "eTag",
          "fields",
          "id",
          "lastModifiedById",
          "lastModifiedDate",
          "recordTypeId",
          "recordTypeInfo",
          "systemModstamp"
        ]
      }
    },
    "searchTerm": {
      "type": "['string', 'null']"
    },
    "sortBy": {
      "type": "string"
    },
    "where": {
      "type": "['string', 'null']"
    }
  },
  "required": [
    "count",
    "currentPageToken",
    "currentPageUrl",
    "fields",
    "listInfoETag",
    "listReference",
    "nextPageToken",
    "nextPageUrl",
    "optionalFields",
    "pageSize",
    "previousPageToken",
    "previousPageUrl",
    "records",
    "searchTerm",
    "sortBy",
    "where"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}