Salesforce · Schema

GetLookupFieldSuggestions

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
lookupResults object
metadata object
View JSON Schema on GitHub

JSON Schema

salesforce-get-lookup-field-suggestions-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "lookupResults": {
      "type": "object",
      "properties": {
        "Account": {
          "type": "object",
          "properties": {
            "count": {
              "type": "integer",
              "example": 42
            },
            "currentPageToken": {
              "type": "['string', 'null']",
              "example": "CAUQAA"
            },
            "currentPageUrl": {
              "type": "string",
              "example": "https://www.example.com"
            },
            "nextPageToken": {
              "type": "['string', 'null']",
              "example": "CAUQAA"
            },
            "nextPageUrl": {
              "type": "['string', 'null']",
              "example": "https://www.example.com"
            },
            "previousPageToken": {
              "type": "['string', 'null']",
              "example": "CAUQAA"
            },
            "previousPageUrl": {
              "type": "['string', 'null']",
              "example": "https://www.example.com"
            },
            "records": {
              "type": "array",
              "description": "",
              "example": [],
              "items": {
                "type": "object",
                "properties": {
                  "apiName": {
                    "type": "string",
                    "example": "example_value"
                  },
                  "childRelationships": {
                    "type": "object",
                    "example": "example_value"
                  },
                  "eTag": {
                    "type": "string",
                    "example": "example_value"
                  },
                  "fields": {
                    "type": "object",
                    "properties": {
                      "Id": {
                        "type": "object"
                      },
                      "Name": {
                        "type": "object"
                      },
                      "Site": {
                        "type": "object"
                      }
                    },
                    "required": [
                      "Id",
                      "Name",
                      "Site"
                    ]
                  },
                  "id": {
                    "type": "string",
                    "example": "abc123"
                  },
                  "lastModifiedById": {
                    "type": "string",
                    "example": "500123"
                  },
                  "lastModifiedDate": {
                    "type": "string",
                    "example": "example_value"
                  },
                  "recordTypeId": {
                    "type": "string",
                    "example": "500123"
                  },
                  "recordTypeInfo": {
                    "type": "['string', 'null']",
                    "example": "example_value"
                  },
                  "systemModstamp": {
                    "type": "string",
                    "example": "example_value"
                  },
                  "weakEtag": {
                    "type": "integer",
                    "example": 10
                  }
                },
                "required": [
                  "apiName",
                  "childRelationships",
                  "eTag",
                  "fields",
                  "id",
                  "lastModifiedById",
                  "lastModifiedDate",
                  "recordTypeId",
                  "recordTypeInfo",
                  "systemModstamp",
                  "weakEtag"
                ]
              }
            }
          },
          "required": [
            "count",
            "currentPageToken",
            "currentPageUrl",
            "nextPageToken",
            "nextPageUrl",
            "previousPageToken",
            "previousPageUrl",
            "records"
          ]
        }
      },
      "required": [
        "Account"
      ]
    },
    "metadata": {
      "type": "object",
      "properties": {
        "Account": {
          "type": "object",
          "properties": {
            "fieldApiName": {
              "type": "['string', 'null']",
              "example": "example_value"
            },
            "objectApiName": {
              "type": "['string', 'null']",
              "example": "example_value"
            },
            "secondaryField": {
              "type": "string",
              "example": "example_value"
            },
            "targetInfo": {
              "type": "object",
              "example": "example_value"
            }
          },
          "required": [
            "fieldApiName",
            "objectApiName",
            "secondaryField",
            "targetInfo"
          ]
        }
      },
      "required": [
        "Account"
      ]
    }
  },
  "required": [
    "lookupResults",
    "metadata"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "GetLookupFieldSuggestions"
}