openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Search API description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously. ' version: v63.0 contact: name: Salesforce Developers url: https://developer.salesforce.com/ license: name: Salesforce Developer Terms url: https://www.salesforce.com/company/legal/agreements/ servers: - url: https://{instance}.salesforce.com/services/data/v{version}/jobs description: Salesforce Bulk API 2.0 jobs endpoint variables: instance: default: yourInstance description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany). ' version: default: '63.0' description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations. ' security: - BearerAuth: [] tags: - name: Search paths: /data/v64.0/chatter/feed-elements: parameters: [] post: tags: - Search summary: Salesforce Feed Elements, Post and Search description: 'Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a describeSObjects() call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element.htm' operationId: FeedElements,PostandSearch parameters: - name: feedElementType in: query description: 'Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values: Bundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values. FeedItem—A feed item has a single parent and is scoped to one community or across all communities. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values. Recommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.' required: true style: form explode: true schema: type: string examples: - FeedItem example: example_value - name: subjectId in: query description: '' required: true style: form explode: true schema: type: string examples: - example: '500123' - name: text in: query description: '' required: true style: form explode: true schema: type: string examples: - New Feed Item example: example_value responses: '201': description: Created headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 22 Nov 2023 11:06:07 GMT Strict-Transport-Security: content: text/plain: schema: type: string contentMediaType: text/plain example: max-age=63072000; includeSubDomains X-Content-Type-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: nosniff X-XSS-Protection: content: text/plain: schema: type: string contentMediaType: text/plain example: 1; mode=block X-Robots-Tag: content: text/plain: schema: type: string contentMediaType: text/plain example: none Cache-Control: content: text/plain: schema: type: string contentMediaType: text/plain example: no-cache,must-revalidate,max-age=0,no-store,private Vary: content: text/plain: schema: type: string contentMediaType: text/plain example: Accept-Encoding Content-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: gzip Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/SuccessfulFeedElementsPostandSearch' - examples: - actor: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal body: isRichText: false messageSegments: - text: New Feed Item type: Text text: New Feed Item capabilities: associatedActions: platformActionGroups: [] bookmarks: isBookmarkedByCurrentUser: false chatterLikes: isLikedByCurrentUser: false likesMessage: null myLike: null page: currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 close: canContextUserUpdateIsClosed: true isClosed: false comments: page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 edit: isEditRestricted: false isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me lastEditedBy: null lastEditedDate: null latestRevision: 1 relativeLastEditedDate: null interactions: count: 0 mute: isMutedByMe: false readBy: isReadByMe: true lastReadDateByMe: '2023-11-22T11:06:07.000Z' page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3 items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 status: feedEntityStatus: Published isApprovableByMe: true topics: canAssignTopics: true items: [] upDownVote: downVoteCount: 0 myVote: None upVoteCount: 0 clientInfo: applicationName: Postman Playground applicationUrl: null createdDate: '2023-11-22T11:06:07.000Z' event: false feedElementType: FeedItem hasVerifiedComment: false header: isRichText: null messageSegments: - motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null reference: id: 005... url: /services/data/v58.0/chatter/users/005... text: Name type: EntityLink text: Name id: 0D5... isDeleteRestricted: false isSharable: false modifiedDate: '2023-11-22T11:06:07.000Z' originalFeedItem: null originalFeedItemActor: null parent: entityLabel: label: Account labelPlural: Accounts id: 001... motif: color: 5867E8 largeIconUrl: /img/icon/accounts64.png mediumIconUrl: /img/icon/accounts32.png smallIconUrl: /img/icon/accounts16.png svgIconUrl: null mySubscription: null name: Burlington Textiles Corp of America type: Account url: /services/data/v58.0/chatter/records/001... photoUrl: https:///profilephoto/729.../T relativeCreatedDate: Just now type: TextPost url: /services/data/v58.0/chatter/feed-elements/0D5... visibility: InternalUsers contentMediaType: application/json;charset=UTF-8 example: actor: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal body: isRichText: false messageSegments: - text: New Feed Item type: Text text: New Feed Item capabilities: associatedActions: platformActionGroups: [] bookmarks: isBookmarkedByCurrentUser: false chatterLikes: isLikedByCurrentUser: false likesMessage: null myLike: null page: currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 close: canContextUserUpdateIsClosed: true isClosed: false comments: page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 edit: isEditRestricted: false isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me lastEditedBy: null lastEditedDate: null latestRevision: 1 relativeLastEditedDate: null interactions: count: 0 mute: isMutedByMe: false readBy: isReadByMe: true lastReadDateByMe: '2023-11-22T11:06:07.000Z' page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3 items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 status: feedEntityStatus: Published isApprovableByMe: true topics: canAssignTopics: true items: [] upDownVote: downVoteCount: 0 myVote: None upVoteCount: 0 clientInfo: applicationName: Postman Playground applicationUrl: null createdDate: '2023-11-22T11:06:07.000Z' event: false feedElementType: FeedItem hasVerifiedComment: false header: isRichText: null messageSegments: - motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null reference: id: 005... url: /services/data/v58.0/chatter/users/005... text: Name type: EntityLink text: Name id: 0D5... isDeleteRestricted: false isSharable: false modifiedDate: '2023-11-22T11:06:07.000Z' originalFeedItem: null originalFeedItemActor: null parent: entityLabel: label: Account labelPlural: Accounts id: 001... motif: color: 5867E8 largeIconUrl: /img/icon/accounts64.png mediumIconUrl: /img/icon/accounts32.png smallIconUrl: /img/icon/accounts16.png svgIconUrl: null mySubscription: null name: Burlington Textiles Corp of America type: Account url: /services/data/v58.0/chatter/records/001... photoUrl: https:///profilephoto/729.../T relativeCreatedDate: Just now type: TextPost url: /services/data/v58.0/chatter/feed-elements/0D5... visibility: InternalUsers deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/search: parameters: [] get: tags: - Search summary: Salesforce Search description: 'Executes the specified SOSL search. The search string must be URL-encoded. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm' operationId: Search parameters: - name: q in: query description: A SOSL statement that is properly URL-encoded. required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/search/scopeOrder: parameters: [] get: tags: - Search summary: Salesforce Search Scope and Order description: 'Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list. The returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using the optimized global search scope. The search string must be URL-encoded. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_scope_order.htm' operationId: SearchScopeandOrder parameters: - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/search/layout: parameters: [] get: tags: - Search summary: Salesforce Search Result Layouts description: 'Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page. This call supports bulk fetch for up to 100 objects in a query. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm' operationId: SearchResultLayouts parameters: - name: q in: query description: Comma delimited object list required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/search/suggestions: parameters: [] get: tags: - Search summary: Salesforce Search for Records Suggested by Autocomplete and Instant Results description: 'Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm' operationId: SearchforRecordsSuggestedbyAutocompleteandInstantResults parameters: - name: q in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: sobject in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/search/suggestSearchQueries: parameters: [] get: tags: - Search summary: Salesforce Search Suggested Queries description: 'Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search. https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm' operationId: SearchSuggestedQueries parameters: - name: q in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: language in: query description: '' required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/parameterizedSearch: parameters: [] get: tags: - Search summary: Salesforce Parameterized Search description: Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches. operationId: ParameterizedSearch parameters: - name: q in: query description: A search string that is properly URL-encoded required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: '' headers: {} deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/tooling/search: parameters: [] get: tags: - Search summary: Salesforce Tooling Search description: Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later). operationId: ToolingSearch parameters: - name: q in: query description: SOSL search statement required: true style: form explode: true schema: type: string example: example_value - name: Content-Type in: header description: '' required: true schema: const: application/json type: string examples: - application/json example: example_value responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 11 Dec 2023 10:34:10 GMT Strict-Transport-Security: content: text/plain: schema: type: string contentMediaType: text/plain example: max-age=63072000; includeSubDomains X-Content-Type-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: nosniff X-Robots-Tag: content: text/plain: schema: type: string contentMediaType: text/plain example: none Cache-Control: content: text/plain: schema: type: string contentMediaType: text/plain example: no-cache,must-revalidate,max-age=0,no-store,private Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=294/15000 queryId: content: text/plain: schema: type: string contentMediaType: text/plain example: -mxbcxdoqukvy Vary: content: text/plain: schema: type: string contentMediaType: text/plain example: Accept-Encoding Content-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: gzip Transfer-Encoding: content: text/plain: schema: type: string contentMediaType: text/plain example: chunked content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ToolingSearch' - examples: - searchRecords: - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA Name: LightningSelfRegisterController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA Name: LightningSelfRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA Name: SiteRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ Name: PrepareSandboxTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ Name: CommunitiesSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE Name: MicrobatchSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4 Name: PrepareSandbox - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ Name: CommunitiesLandingControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ Name: MyProfilePageControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ Name: ForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA Name: SiteLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD Name: AccountTriggerHelperTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA Name: LightningForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA Name: LightningLoginFormControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA Name: LightningLoginFormController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ Name: CommunitiesSelfRegConfirmControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ Name: CommunitiesLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ Name: ChangePasswordControllerTest contentMediaType: application/json;charset=UTF-8 example: searchRecords: - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA Name: LightningSelfRegisterController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA Name: LightningSelfRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA Name: SiteRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ Name: PrepareSandboxTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ Name: CommunitiesSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE Name: MicrobatchSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4 Name: PrepareSandbox - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ Name: CommunitiesLandingControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ Name: MyProfilePageControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ Name: ForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA Name: SiteLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD Name: AccountTriggerHelperTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA Name: LightningForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA Name: LightningLoginFormControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA Name: LightningLoginFormController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ Name: CommunitiesSelfRegConfirmControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ Name: CommunitiesLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ Name: ChangePasswordControllerTest deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /search: get: operationId: executeSearch summary: Salesforce Execute a Sosl Search description: 'Executes a SOSL (Salesforce Object Search Language) search query across multiple objects simultaneously. The SOSL query is passed as a query parameter. Returns matching records from all specified objects, supporting full-text search capabilities. ' tags: - Search parameters: - name: q in: query required: true description: 'The SOSL search string to execute. Must include a FIND clause and optionally IN, RETURNING, and WITH clauses. ' schema: type: string example: FIND {Jane Smith} IN ALL FIELDS RETURNING Contact(Id, Name, Email), Account(Id, Name) responses: '200': description: Search results grouped by object type. content: application/json: schema: $ref: '#/components/schemas/SearchResult' examples: Executesearch200Example: summary: Default executeSearch 200 response x-microcks-default: true value: searchRecords: - attributes: {} Id: abc123 '400': description: Bad request. Invalid SOSL syntax or search validation failed. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Executesearch400Example: summary: Default executeSearch 400 response x-microcks-default: true value: message: example_value errorCode: example_value fields: - example_value '401': description: Unauthorized. Invalid or expired OAuth token. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Executesearch401Example: summary: Default executeSearch 401 response x-microcks-default: true value: message: example_value errorCode: example_value fields: - example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Parent: title: Parent required: - entityLabel - id - motif - mySubscription - name - type - url type: object properties: entityLabel: $ref: '#/components/schemas/EntityLabel' id: type: string example: abc123 motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title type: type: string example: example_value url: type: string example: https://www.example.com examples: - entityLabel: label: Account labelPlural: Accounts id: 001... motif: color: 5867E8 largeIconUrl: /img/icon/accounts64.png mediumIconUrl: /img/icon/accounts32.png smallIconUrl: /img/icon/accounts16.png svgIconUrl: null mySubscription: null name: Burlington Textiles Corp of America type: Account url: /services/data/v58.0/chatter/records/001... Edit: title: Edit required: - isEditRestricted - isEditableByMeUrl - lastEditedBy - lastEditedDate - latestRevision - relativeLastEditedDate type: object properties: isEditRestricted: type: boolean example: true isEditableByMeUrl: type: string example: https://www.example.com lastEditedBy: type: - string - 'null' example: example_value lastEditedDate: type: - string - 'null' example: example_value latestRevision: type: integer contentEncoding: int32 example: 10 relativeLastEditedDate: type: - string - 'null' example: example_value examples: - isEditRestricted: false isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me lastEditedBy: null lastEditedDate: null latestRevision: 1 relativeLastEditedDate: null Header: title: Header required: - isRichText - messageSegments - text type: object properties: isRichText: type: - string - 'null' example: example_value messageSegments: type: array items: $ref: '#/components/schemas/MessageSegment1' description: '' example: [] text: type: string example: example_value examples: - isRichText: null messageSegments: - motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null reference: id: 005... url: /services/data/v58.0/chatter/users/005... text: Name type: EntityLink text: Name Motif: title: Motif required: - color - largeIconUrl - mediumIconUrl - smallIconUrl - svgIconUrl type: object properties: color: type: string example: example_value largeIconUrl: type: string example: https://www.example.com mediumIconUrl: type: string example: https://www.example.com smallIconUrl: type: string example: https://www.example.com svgIconUrl: type: - string - 'null' example: https://www.example.com examples: - color: '939393' largeIconUrl: /img/content/content64.png mediumIconUrl: /img/content/content32.png smallIconUrl: /img/icon/files16.png svgIconUrl: null Actor: title: Actor required: - additionalLabel - communityNickname - companyName - displayName - firstName - id - isActive - isInThisCommunity - lastName - motif - mySubscription - name - outOfOffice - photo - reputation - title - type - url - userType type: object properties: additionalLabel: type: - string - 'null' example: example_value communityNickname: type: string example: example_value companyName: type: string example: example_value displayName: type: string example: example_value firstName: type: string example: example_value id: type: string example: abc123 isActive: type: boolean example: true isInThisCommunity: type: boolean example: true lastName: type: string example: example_value motif: $ref: '#/components/schemas/Motif' mySubscription: type: - string - 'null' example: example_value name: type: string example: Example Title outOfOffice: $ref: '#/components/schemas/OutOfOffice' photo: $ref: '#/components/schemas/Photo' reputation: type: - string - 'null' example: example_value title: type: - string - 'null' example: Example Title type: type: string example: example_value url: type: string example: https://www.example.com userType: type: string example: example_value examples: - additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal UpDownVote: title: UpDownVote required: - downVoteCount - myVote - upVoteCount type: object properties: downVoteCount: type: integer contentEncoding: int32 example: 42 myVote: type: string example: example_value upVoteCount: type: integer contentEncoding: int32 example: 42 examples: - downVoteCount: 0 myVote: None upVoteCount: 0 ReadBy: title: ReadBy required: - isReadByMe - lastReadDateByMe - page type: object properties: isReadByMe: type: boolean example: true lastReadDateByMe: type: string example: example_value page: $ref: '#/components/schemas/Page1' examples: - isReadByMe: true lastReadDateByMe: '2023-11-22T11:06:07.000Z' page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3 items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 SearchResult: type: object description: 'The result of a SOSL search, containing matching records grouped by SObject type. ' properties: searchRecords: type: array description: 'Array of records matching the SOSL search query. Each record includes the object type in its attributes. ' items: $ref: '#/components/schemas/SObjectRecord' example: [] Capabilities: title: Capabilities required: - associatedActions - bookmarks - chatterLikes - close - comments - edit - interactions - mute - readBy - status - topics - upDownVote type: object properties: associatedActions: $ref: '#/components/schemas/AssociatedActions' bookmarks: $ref: '#/components/schemas/Bookmarks' chatterLikes: $ref: '#/components/schemas/ChatterLikes' close: $ref: '#/components/schemas/Close' comments: $ref: '#/components/schemas/Comments' edit: $ref: '#/components/schemas/Edit' interactions: $ref: '#/components/schemas/Interactions' mute: $ref: '#/components/schemas/Mute' readBy: $ref: '#/components/schemas/ReadBy' status: $ref: '#/components/schemas/Status1' topics: $ref: '#/components/schemas/Topics2' upDownVote: $ref: '#/components/schemas/UpDownVote' examples: - associatedActions: platformActionGroups: [] bookmarks: isBookmarkedByCurrentUser: false chatterLikes: isLikedByCurrentUser: false likesMessage: null myLike: null page: currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 close: canContextUserUpdateIsClosed: true isClosed: false comments: page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 edit: isEditRestricted: false isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me lastEditedBy: null lastEditedDate: null latestRevision: 1 relativeLastEditedDate: null interactions: count: 0 mute: isMutedByMe: false readBy: isReadByMe: true lastReadDateByMe: '2023-11-22T11:06:07.000Z' page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3 items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 status: feedEntityStatus: Published isApprovableByMe: true topics: canAssignTopics: true items: [] upDownVote: downVoteCount: 0 myVote: None upVoteCount: 0 Photo: title: Photo required: - fullEmailPhotoUrl - largePhotoUrl - mediumPhotoUrl - photoVersionId - smallPhotoUrl - standardEmailPhotoUrl - url type: object properties: fullEmailPhotoUrl: type: string example: user@example.com largePhotoUrl: type: string example: https://www.example.com mediumPhotoUrl: type: string example: https://www.example.com photoVersionId: type: string example: '500123' smallPhotoUrl: type: string example: https://www.example.com standardEmailPhotoUrl: type: string example: user@example.com url: type: string example: https://www.example.com examples: - fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo Bookmarks: title: Bookmarks required: - isBookmarkedByCurrentUser type: object properties: isBookmarkedByCurrentUser: type: boolean example: true examples: - isBookmarkedByCurrentUser: false Topics2: title: Topics2 required: - canAssignTopics - items type: object properties: canAssignTopics: type: boolean example: true items: type: array items: type: string description: '' example: [] examples: - canAssignTopics: true items: [] ChatterLikes: title: ChatterLikes required: - isLikedByCurrentUser - likesMessage - myLike - page type: object properties: isLikedByCurrentUser: type: boolean example: true likesMessage: type: - string - 'null' example: example_value myLike: type: - string - 'null' example: example_value page: $ref: '#/components/schemas/Page' examples: - isLikedByCurrentUser: false likesMessage: null myLike: null page: currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 ClientInfo: title: ClientInfo required: - applicationName - applicationUrl type: object properties: applicationName: type: string example: example_value applicationUrl: type: - string - 'null' example: https://www.example.com examples: - applicationName: Postman Playground applicationUrl: null SuccessfulFeedElementsPostandSearch: title: SuccessfulFeedElementsPostandSearch required: - actor - body - capabilities - clientInfo - createdDate - event - feedElementType - hasVerifiedComment - header - id - isDeleteRestricted - isSharable - modifiedDate - originalFeedItem - originalFeedItemActor - parent - photoUrl - relativeCreatedDate - type - url - visibility type: object properties: actor: $ref: '#/components/schemas/Actor' body: $ref: '#/components/schemas/Body4' capabilities: $ref: '#/components/schemas/Capabilities' clientInfo: $ref: '#/components/schemas/ClientInfo' createdDate: type: string example: example_value event: type: boolean example: true feedElementType: type: string example: example_value hasVerifiedComment: type: boolean example: true header: $ref: '#/components/schemas/Header' id: type: string example: abc123 isDeleteRestricted: type: boolean example: true isSharable: type: boolean example: true modifiedDate: type: string example: example_value originalFeedItem: type: - string - 'null' example: example_value originalFeedItemActor: type: - string - 'null' example: example_value parent: $ref: '#/components/schemas/Parent' photoUrl: type: string example: https://www.example.com relativeCreatedDate: type: string example: example_value type: type: string example: example_value url: type: string example: https://www.example.com visibility: type: string example: example_value examples: - actor: additionalLabel: null communityNickname: User1696423780773910041 companyName: Salesforce displayName: Name firstName: Firstname id: 005... isActive: true isInThisCommunity: true lastName: Name motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null mySubscription: null name: Name outOfOffice: message: '' photo: fullEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1 largePhotoUrl: https:///profilephoto/729.../F mediumPhotoUrl: https:///profilephoto/729.../M photoVersionId: 729... smallPhotoUrl: https:///profilephoto/729.../T standardEmailPhotoUrl: https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1 url: /services/data/v58.0/connect/user-profiles/005.../photo reputation: null title: null type: User url: /services/data/v58.0/chatter/users/005... userType: Internal body: isRichText: false messageSegments: - text: New Feed Item type: Text text: New Feed Item capabilities: associatedActions: platformActionGroups: [] bookmarks: isBookmarkedByCurrentUser: false chatterLikes: isLikedByCurrentUser: false likesMessage: null myLike: null page: currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 close: canContextUserUpdateIsClosed: true isClosed: false comments: page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 edit: isEditRestricted: false isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me lastEditedBy: null lastEditedDate: null latestRevision: 1 relativeLastEditedDate: null interactions: count: 0 mute: isMutedByMe: false readBy: isReadByMe: true lastReadDateByMe: '2023-11-22T11:06:07.000Z' page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3 items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 status: feedEntityStatus: Published isApprovableByMe: true topics: canAssignTopics: true items: [] upDownVote: downVoteCount: 0 myVote: None upVoteCount: 0 clientInfo: applicationName: Postman Playground applicationUrl: null createdDate: '2023-11-22T11:06:07.000Z' event: false feedElementType: FeedItem hasVerifiedComment: false header: isRichText: null messageSegments: - motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null reference: id: 005... url: /services/data/v58.0/chatter/users/005... text: Name type: EntityLink text: Name id: 0D5... isDeleteRestricted: false isSharable: false modifiedDate: '2023-11-22T11:06:07.000Z' originalFeedItem: null originalFeedItemActor: null parent: entityLabel: label: Account labelPlural: Accounts id: 001... motif: color: 5867E8 largeIconUrl: /img/icon/accounts64.png mediumIconUrl: /img/icon/accounts32.png smallIconUrl: /img/icon/accounts16.png svgIconUrl: null mySubscription: null name: Burlington Textiles Corp of America type: Account url: /services/data/v58.0/chatter/records/001... photoUrl: https:///profilephoto/729.../T relativeCreatedDate: Just now type: TextPost url: /services/data/v58.0/chatter/feed-elements/0D5... visibility: InternalUsers AssociatedActions: title: AssociatedActions required: - platformActionGroups type: object properties: platformActionGroups: type: array items: type: string description: '' example: [] examples: - platformActionGroups: [] SObjectRecord: type: object description: 'A Salesforce SObject record. Contains an attributes object describing the record type and URL, plus any number of field name/value pairs depending on the object type. ' required: - attributes properties: attributes: type: object description: 'Metadata attributes for this SObject record, including its type and REST API URL. ' required: - type properties: type: type: string description: The API name of the SObject type (e.g., Account, Contact). url: type: string format: uri description: The REST API URL for this specific record. example: example_value Id: type: string description: The 18-character globally unique Salesforce record ID. minLength: 15 maxLength: 18 example: abc123 additionalProperties: true Close: title: Close required: - canContextUserUpdateIsClosed - isClosed type: object properties: canContextUserUpdateIsClosed: type: boolean example: true isClosed: type: boolean example: true examples: - canContextUserUpdateIsClosed: true isClosed: false Body4: title: Body4 required: - isRichText - messageSegments - text type: object properties: isRichText: type: boolean example: true messageSegments: type: array items: $ref: '#/components/schemas/MessageSegment' description: '' example: [] text: type: string example: example_value examples: - isRichText: false messageSegments: - text: New Feed Item type: Text text: New Feed Item Page: title: Page required: - currentPageToken - currentPageUrl - items - nextPageToken - nextPageUrl - previousPageToken - previousPageUrl - total type: object properties: currentPageToken: type: integer contentEncoding: int32 example: CAUQAA currentPageUrl: type: string example: https://www.example.com items: type: array items: type: string description: '' example: [] 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 total: type: integer contentEncoding: int32 example: 42 examples: - currentPageToken: 0 currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 Mute: title: Mute required: - isMutedByMe type: object properties: isMutedByMe: type: boolean example: true examples: - isMutedByMe: false OutOfOffice: title: OutOfOffice required: - message type: object properties: message: type: string example: example_value examples: - message: '' Reference: title: Reference required: - id - url type: object properties: id: type: string example: abc123 url: type: string example: https://www.example.com examples: - id: 005... url: /services/data/v58.0/chatter/users/005... ToolingSearch: title: ToolingSearch required: - searchRecords type: object properties: searchRecords: type: array items: $ref: '#/components/schemas/SearchRecord' description: '' example: [] examples: - searchRecords: - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA Name: LightningSelfRegisterController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA Name: LightningSelfRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA Name: SiteRegisterControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ Name: PrepareSandboxTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ Name: CommunitiesSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE Name: MicrobatchSelfRegControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4 Name: PrepareSandbox - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ Name: CommunitiesLandingControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ Name: MyProfilePageControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ Name: ForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA Name: SiteLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD Name: AccountTriggerHelperTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA Name: LightningForgotPasswordControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA Name: LightningLoginFormControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA Name: LightningLoginFormController - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ Name: CommunitiesSelfRegConfirmControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ Name: CommunitiesLoginControllerTest - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ Name: ChangePasswordControllerTest SearchRecord: title: SearchRecord required: - attributes - Name type: object properties: attributes: $ref: '#/components/schemas/Attributes4' Name: type: string example: Example Title examples: - attributes: type: ApexClass url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA Name: LightningSelfRegisterController Interactions: title: Interactions required: - count type: object properties: count: type: integer contentEncoding: int32 example: 42 examples: - count: 0 MessageSegment: title: MessageSegment required: - text - type type: object properties: text: type: string example: example_value type: type: string example: example_value examples: - text: New Feed Item type: Text EntityLabel: title: EntityLabel required: - label - labelPlural type: object properties: label: type: string example: Example Title labelPlural: type: string example: example_value examples: - label: Account labelPlural: Accounts Error: type: object description: 'An error response from the Salesforce REST API, describing the problem with the request. ' properties: message: type: string description: Human-readable description of the error. example: example_value errorCode: type: string description: 'Salesforce error code (e.g., MALFORMED_QUERY, INVALID_FIELD, REQUIRED_FIELD_MISSING). ' example: example_value fields: type: array description: 'List of field names related to the error, if applicable (e.g., for field validation errors). ' items: type: string example: [] MessageSegment1: title: MessageSegment1 required: - motif - reference - text - type type: object properties: motif: $ref: '#/components/schemas/Motif' reference: $ref: '#/components/schemas/Reference' text: type: string example: example_value type: type: string example: example_value examples: - motif: color: 1B96FF largeIconUrl: /img/icon/profile64.png mediumIconUrl: /img/icon/profile32.png smallIconUrl: /img/icon/profile16.png svgIconUrl: null reference: id: 005... url: /services/data/v58.0/chatter/users/005... text: Name type: EntityLink Comments: title: Comments required: - page type: object properties: page: $ref: '#/components/schemas/Page1' examples: - page: currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 Status1: title: Status1 required: - feedEntityStatus - isApprovableByMe type: object properties: feedEntityStatus: type: string example: example_value isApprovableByMe: type: boolean example: true examples: - feedEntityStatus: Published isApprovableByMe: true Page1: title: Page1 required: - currentPageToken - currentPageUrl - items - nextPageToken - nextPageUrl - previousPageToken - previousPageUrl - total type: object properties: currentPageToken: type: - string - 'null' example: CAUQAA currentPageUrl: type: string example: https://www.example.com items: type: array items: type: string description: '' example: [] 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 total: type: integer contentEncoding: int32 example: 42 examples: - currentPageToken: null currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items items: [] nextPageToken: null nextPageUrl: null previousPageToken: null previousPageUrl: null total: 0 Attributes4: title: Attributes4 required: - type - url type: object properties: type: type: string example: example_value url: type: string example: https://www.example.com examples: - type: Account url: /services/data/v58.0/sobjects/Account/001... securitySchemes: BearerAuth: type: http scheme: bearer description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}". '