Prompt
openapi: 3.1.0
info:
title: Salesforce API
version: 1.0.0
description: API for accessing Salesforce sObjects and executing queries.
servers:
- url: https://<subdomain>.my.salesforce.com/services/data/v59.0
description: Salesforce API server
paths:
/query:
get:
summary: Execute a SOQL Query
description: Executes a given SOQL query and returns the results.
operationId: executeSOQLQuery
parameters:
- name: q
in: query
description: The SOQL query string to be executed.
required: true
schema:
type: string
responses:
'200':
description: Query executed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResult'
/search:
get:
summary: Execute a SOSL Search
description: Executes a SOSL search based on the given query and returns matching records.
operationId: executeSOSLSearch
parameters:
- name: q
in: query
description: The SOSL search string (e.g., 'FIND {Acme}').
required: true
schema:
type: string
responses:
'200':
description: Search executed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResult'
components:
schemas:
QueryResult:
type: object
description: Result of a SOQL query.
properties:
totalSize:
type: integer
description: The total number of records matching the query.
done:
type: boolean
description: Indicates if the query result includes all records.
records:
type: array
description: The list of records returned by the query.
items:
$ref: '#/components/schemas/SObject'
SearchResult:
type: object
description: Result of a SOSL search.
properties:
searchRecords:
type: array
description: The list of records matching the search query.
items:
$ref: '#/components/schemas/SObject'
SObject:
type: object
description: A Salesforce sObject, which represents a database table record.
properties:
attributes:
type: object
description: Metadata about the sObject, such as type and URL.
properties:
type:
type: string
description: The sObject type.
url:
type: string
description: The URL of the record.
Id:
type: string
description: The unique identifier for the sObject.
additionalProperties: true