openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Events 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: Events paths: /data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}: parameters: [] get: tags: - Events summary: Salesforce Get Event Channel operationId: Geteventchannel parameters: - name: PLATFORM_EVENT_CHANNEL_ID in: path description: '' required: true schema: type: string examples: - 0YL4H0000004C93WAE example: '500123' responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 03 Jul 2023 13:15:59 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=7/15000 Last-Modified: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 11 Jan 2021 19:33:54 GMT 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/Geteventchannel' - examples: - attributes: type: PlatformEventChannel url: /services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE Id: 0YL4H0000004C93WAE IsDeleted: false DeveloperName: HREvents Language: en_US MasterLabel: Custom Channel for the HR App NamespacePrefix: null ManageableState: unmanaged CreatedDate: 2021-01-11T19:33:54.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2021-01-11T19:33:54.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2021-01-11T19:33:54.000+0000 ChannelType: data FullName: HREvents__chn Metadata: channelType: data label: Custom Channel for the HR App urls: null contentMediaType: application/json;charset=UTF-8 example: attributes: type: PlatformEventChannel url: /services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE Id: 0YL4H0000004C93WAE IsDeleted: false DeveloperName: HREvents Language: en_US MasterLabel: Custom Channel for the HR App NamespacePrefix: null ManageableState: unmanaged CreatedDate: 2021-01-11T19:33:54.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2021-01-11T19:33:54.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2021-01-11T19:33:54.000+0000 ChannelType: data FullName: HREvents__chn Metadata: channelType: data label: Custom Channel for the HR App urls: null deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Events summary: Salesforce Delete Event Channel operationId: Deleteeventchannel parameters: - name: PLATFORM_EVENT_CHANNEL_ID in: path description: '' required: true schema: type: string example: '500123' responses: '204': description: No Content headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Wed, 06 Dec 2023 16:56:00 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 Content-Security-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: upgrade-insecure-requests 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=303/15000 content: {} 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/sobjects/PlatformEventChannel/describe: parameters: [] get: tags: - Events summary: Salesforce Describe Event Channel operationId: Describeeventchannel parameters: [] responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 03 Jul 2023 13:16:20 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=7/15000 ETag: content: text/plain: schema: type: string contentMediaType: text/plain example: '"2aa989f9--gzip"' Last-Modified: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 03 Jul 2023 13:05:05 GMT 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: $ref: '#/components/schemas/Describeeventchannel' examples: Describeeventchannel200Example: summary: Default Describeeventchannel 200 response x-microcks-default: true value: actionOverrides: - example_value activateable: true associateEntityType: example_value associateParentEntity: example_value childRelationships: - example_value compactLayoutable: true createable: true custom: true customSetting: true deepCloneable: true defaultImplementation: example_value deletable: true deprecatedAndHidden: true extendedBy: example_value extendsInterfaces: example_value feedEnabled: true fields: - aggregatable: true aiPredictionField: true autoNumber: true byteLength: 10 calculated: true calculatedFormula: example_value cascadeDelete: true caseSensitive: true compoundFieldName: example_value controllerName: example_value createable: true custom: true defaultValue: example_value defaultValueFormula: example_value defaultedOnCreate: true dependentPicklist: true deprecatedAndHidden: true digits: 10 displayLocationInDecimal: true encrypted: true externalId: '500123' extraTypeInfo: example_value filterable: true filteredLookupInfo: example_value formulaTreatNullNumberAsZero: true groupable: true highScaleNumber: true htmlFormatted: true idLookup: true inlineHelpText: example_value label: Example Title length: 10 mask: example_value maskType: example_value name: Example Title nameField: true namePointing: true nillable: true permissionable: true picklistValues: {} polymorphicForeignKey: true precision: 10 queryByDistance: true referenceTargetField: example_value referenceTo: {} relationshipName: example_value relationshipOrder: example_value restrictedDelete: true restrictedPicklist: true scale: 10 searchPrefilterable: true soapType: example_value sortable: true type: example_value unique: true updateable: true writeRequiresMasterRead: true hasSubtypes: true implementedBy: example_value implementsInterfaces: example_value isInterface: true isSubtype: true keyPrefix: example_value label: Example Title labelPlural: example_value layoutable: true listviewable: example_value lookupLayoutable: example_value mergeable: true mruEnabled: true name: Example Title namedLayoutInfos: - example_value networkScopeFieldName: example_value queryable: true recordTypeInfos: - example_value replicateable: true retrieveable: true searchLayoutable: true searchable: true sobjectDescribeOption: example_value supportedScopes: - label: Example Title name: Example Title triggerable: true undeletable: true updateable: true urls: rowTemplate: example_value describe: example_value sobject: example_value 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/sobjects/{EventApiName}: parameters: [] post: tags: - Events summary: Salesforce Publish Single Event operationId: Publishsingleevent parameters: - name: EventApiName in: path description: '' required: true schema: type: string examples: - Carbon_Comparison__e example: example_value requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/PublishsingleeventRequest' - examples: - Annual_Mileage__c: 12000 Current_Vehicle__c: Fast car Model_Year__c: 2019 contentMediaType: application/json example: Annual_Mileage__c: 12000 Current_Vehicle__c: Fast car Model_Year__c: 2019 required: true responses: '201': description: Created headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 03 Jul 2023 13:18:20 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=16/15000 Location: content: text/plain: schema: type: string contentMediaType: text/plain example: /services/data/v58.0/sobjects/Sample__e/e00xx0000000001AAA 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/Publishsingleevent' - examples: - id: e00xx0000000001AAA success: true errors: - statusCode: OPERATION_ENQUEUED message: 234995b6-53b6-4887-93fc-ecd0fac8b36c fields: [] contentMediaType: application/json;charset=UTF-8 example: id: e00xx0000000001AAA success: true errors: - statusCode: OPERATION_ENQUEUED message: 234995b6-53b6-4887-93fc-ecd0fac8b36c fields: [] deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /Soap/u/64.0: parameters: [] post: tags: - Events summary: Salesforce Publish Multiple Events With Soap Call operationId: PublishmultipleeventswithSOAPcall parameters: - name: Content-Type in: header description: '' required: true schema: const: text/xml type: string examples: - text/xml example: example_value - name: charset in: header description: '' required: true schema: type: string examples: - UTF-8 example: example_value - name: SOAPAction in: header description: '' required: true schema: type: string examples: - create example: example_value - name: Accept in: header description: '' required: true schema: type: string examples: - text/xml example: example_value requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/Envelope' - xml: name: Envelope attribute: false wrapped: false examples: - "\n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n Carbon_Comparison__e\n\n 12000\n\n Fast car 1\n\n 2019\n\n \n\n \n\n Carbon_Comparison__e\n\n 12000\n\n Fast car 2\n\n 2019\n\n \n\n \n\n \n\n" contentMediaType: application/xml example: "\n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n Carbon_Comparison__e\n\n 12000\n\n Fast car 1\n\n 2019\n\n \n\n \n\n Carbon_Comparison__e\n\n 12000\n\n Fast car 2\n\n 2019\n\n \n\n \n\n \n\n" required: true 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/sobjects/EventRelayConfig/describe: parameters: [] get: tags: - Events summary: Salesforce Describe Event Relay operationId: Describeeventrelay parameters: [] 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/sobjects/EventRelayConfig: parameters: [] post: tags: - Events summary: Salesforce Create Event Relay operationId: Createeventrelay parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateeventrelayRequest' - examples: - FullName: MyEventRelay Metadata: eventChannel: Carbon_Comparison_Channel__chn destinationResourceName: callout:MyNamedCredential label: My Event Relay relayOption: '{"ReplayRecovery":"LATEST"}' contentMediaType: application/json example: FullName: MyEventRelay Metadata: eventChannel: Carbon_Comparison_Channel__chn destinationResourceName: callout:MyNamedCredential label: My Event Relay relayOption: '{"ReplayRecovery":"LATEST"}' required: true 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/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}: parameters: [] delete: tags: - Events summary: Salesforce Delete Event Relay operationId: Deleteeventrelay parameters: - name: EVENT_RELAY_CONFIG_ID in: path description: '' required: true schema: type: string examples: - 'null' example: '500123' 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 get: tags: - Events summary: Salesforce Get Event Relay operationId: Geteventrelay parameters: - name: EVENT_RELAY_CONFIG_ID in: path description: '' required: true schema: type: string examples: - 7k2RM000000008ZYAQ example: '500123' 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 patch: tags: - Events summary: Salesforce Change Event Relay State operationId: Changeeventrelaystate parameters: - name: EVENT_RELAY_CONFIG_ID in: path description: '' required: true schema: type: string example: '500123' - name: SOAPAction in: header description: '' required: true schema: type: string examples: - '""' example: example_value - name: Authorization in: header description: '' required: true schema: type: string examples: - 'Bearer ' example: example_value requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ChangeeventrelaystateRequest' - examples: - Metadata: state: RUN contentMediaType: application/json example: Metadata: state: RUN required: true responses: '200': description: '' headers: {} deprecated: false security: [] servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /data/v64.0/query: parameters: [] get: tags: - Events summary: Salesforce List Event Relay Feedback Items operationId: Listeventrelayfeedbackitems parameters: - name: q in: query description: '' required: true style: form explode: true schema: type: string examples: - SELECT FIELDS(ALL) FROM EventRelayFeedback LIMIT 200 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/sobjects/EventRelayFeedback/{EVENT_RELAY_FEEDBACK_ID}: parameters: [] get: tags: - Events summary: Salesforce Get Event Relay Feedback operationId: Geteventrelayfeedback parameters: - name: EVENT_RELAY_FEEDBACK_ID in: path description: '' required: true schema: type: string examples: - 7k4RM000000008AYAQ example: '500123' 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/sobjects/EventRelayFeedback/describe: parameters: [] get: tags: - Events summary: Salesforce Describe Event Felay Feedback operationId: Describeeventfelayfeedback parameters: [] 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/event/eventSchema/{SCHEMA_ID}: parameters: [] get: tags: - Events summary: Salesforce Platform Event Schema by Schema Id description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later. operationId: PlatformEventSchemabySchemaID parameters: - name: SCHEMA_ID in: path description: '' required: true schema: type: string example: '500123' - 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/sobjects/{EVENT_NAME}/eventSchema: parameters: [] get: tags: - Events summary: Salesforce Platform Event Schema by Event Name description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later. operationId: PlatformEventSchemabyEventName parameters: - name: EVENT_NAME in: path description: API Name of the event required: 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, 03 Jul 2023 13:06:08 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=2/15000 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: $ref: '#/components/schemas/PlatformEventSchemabyEventName' examples: Platformeventschemabyeventname200Example: summary: Default PlatformEventSchemabyEventName 200 response x-microcks-default: true value: name: Example Title namespace: example_value type: example_value fields: - name: Example Title type: example_value 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/sobjects/ManagedEventSubscription: parameters: [] post: tags: - Events summary: Salesforce Create Managed Event Subscription operationId: Createmanagedeventsubscription parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreatemanagedeventsubscriptionRequest' - examples: - FullName: Managed_Sub_OpportunityChangeEvent Metadata: label: Managed Sub OpportunityChangeEvent topicName: /data/OpportunityChangeEvent defaultReplay: LATEST state: RUN errorRecoveryReplay: LATEST contentMediaType: application/json example: FullName: Managed_Sub_OpportunityChangeEvent Metadata: label: Managed Sub OpportunityChangeEvent topicName: /data/OpportunityChangeEvent defaultReplay: LATEST state: RUN errorRecoveryReplay: LATEST required: true 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/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}: parameters: [] get: tags: - Events summary: Salesforce Get Managed Event Subscription by Id operationId: GetmanagedeventsubscriptionbyID parameters: - name: managedEventSubscriptionId in: path description: '' required: true schema: type: string example: '500123' 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 patch: tags: - Events summary: Salesforce Update Managed Event Subscription operationId: Updatemanagedeventsubscription parameters: - name: managedEventSubscriptionId in: path description: '' required: true schema: type: string example: '500123' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdatemanagedeventsubscriptionRequest' - examples: - FullName: Managed_Sub_OpportunityChangeEvent Metadata: state: STOP contentMediaType: application/json example: FullName: Managed_Sub_OpportunityChangeEvent Metadata: state: STOP required: true 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 delete: tags: - Events summary: Salesforce Delete Managed Event Subscription operationId: Deletemanagedeventsubscription parameters: - name: managedEventSubscriptionId in: path description: '' required: true schema: type: string example: '500123' 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/sobjects/ManagedEventSubscription/describe: parameters: [] get: tags: - Events summary: Salesforce Describe Managed Event Subscription operationId: Describemanagedeventsubscription parameters: [] 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/sobjects/EventLogFile/{id}/LogFile: parameters: [] get: tags: - Events summary: Salesforce Get Event Log File operationId: Geteventlogfile parameters: - name: id in: path description: Log event Id required: true schema: type: string examples: - 'null' example: abc123 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 components: schemas: Type: title: Type type: object properties: type: type: string example: example_value name: type: string example: Example Title namespace: type: string example: example_value fields: type: array items: $ref: '#/components/schemas/Field3' description: '' example: [] Field3: title: Field3 required: - name - type type: object properties: name: type: string example: Example Title type: oneOf: - $ref: '#/components/schemas/Type1' - $ref: '#/components/schemas/Type11' example: example_value Field2: title: Field2 required: - name - type type: object properties: name: type: string example: Example Title type: oneOf: - $ref: '#/components/schemas/Type' - type: string example: example_value Body16: title: Body16 required: - create type: object properties: create: allOf: - $ref: '#/components/schemas/create' - xml: name: create namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false example: example_value xml: name: Body namespace: http://schemas.xmlsoap.org/soap/envelope/ prefix: SOAP-ENV attribute: false wrapped: false Envelope: title: Envelope required: - Header - Body type: object properties: Header: allOf: - $ref: '#/components/schemas/Header4' - xml: name: Header namespace: http://schemas.xmlsoap.org/soap/envelope/ prefix: SOAP-ENV attribute: false wrapped: false example: example_value Body: allOf: - $ref: '#/components/schemas/Body16' - xml: name: Body namespace: http://schemas.xmlsoap.org/soap/envelope/ prefix: SOAP-ENV attribute: false wrapped: false example: example_value xml: name: Envelope namespace: http://schemas.xmlsoap.org/soap/envelope/ prefix: SOAP-ENV attribute: false wrapped: false Publishsingleevent: title: Publishsingleevent required: - id - success - errors type: object properties: id: type: string example: abc123 success: type: boolean example: true errors: type: array items: $ref: '#/components/schemas/Errors7' description: '' example: [] examples: - id: e00xx0000000001AAA success: true errors: - statusCode: OPERATION_ENQUEUED message: 234995b6-53b6-4887-93fc-ecd0fac8b36c fields: [] ChangeeventrelaystateRequest: title: ChangeeventrelaystateRequest required: - Metadata type: object properties: Metadata: $ref: '#/components/schemas/Metadata13' examples: - Metadata: state: RUN PublishsingleeventRequest: title: PublishsingleeventRequest required: - Annual_Mileage__c - Current_Vehicle__c - Model_Year__c type: object properties: Annual_Mileage__c: type: integer contentEncoding: int32 example: 10 Current_Vehicle__c: type: string example: example_value Model_Year__c: type: integer contentEncoding: int32 example: 10 examples: - Annual_Mileage__c: 12000 Current_Vehicle__c: Fast car Model_Year__c: 2019 Errors7: title: Errors7 required: - statusCode - message - fields type: object properties: statusCode: type: string example: example_value message: type: string example: example_value fields: type: array items: type: string description: '' example: [] examples: - statusCode: OPERATION_ENQUEUED message: 234995b6-53b6-4887-93fc-ecd0fac8b36c fields: [] Urls2: title: Urls2 required: - rowTemplate - describe - sobject type: object properties: rowTemplate: type: string example: example_value describe: type: string example: example_value sobject: type: string example: example_value examples: - rowTemplate: /services/data/v58.0/tooling/sobjects/PlatformEventChannel/{ID} describe: /services/data/v58.0/tooling/sobjects/PlatformEventChannel/describe sobject: /services/data/v58.0/tooling/sobjects/PlatformEventChannel SupportedScope: title: SupportedScope required: - label - name type: object properties: label: type: string example: Example Title name: type: string example: Example Title examples: - label: All platform event channels name: everything UpdatemanagedeventsubscriptionRequest: title: UpdatemanagedeventsubscriptionRequest required: - FullName - Metadata type: object properties: FullName: type: string example: example_value Metadata: $ref: '#/components/schemas/Metadata13' examples: - FullName: Managed_Sub_OpportunityChangeEvent Metadata: state: STOP Field5: title: Field5 required: - name - type type: object properties: name: type: string example: Example Title type: oneOf: - type: array items: type: string - type: array items: type: string example: example_value doc: type: string example: example_value default: type: - string - 'null' example: example_value Metadata1: title: Metadata1 required: - channelType - label - urls type: object properties: channelType: type: string example: example_value label: type: string example: Example Title urls: type: - string - 'null' example: https://www.example.com examples: - channelType: data label: Account Channel 2 urls: null Metadata15: title: Metadata15 required: - label - topicName - defaultReplay - state - errorRecoveryReplay type: object properties: label: type: string example: Example Title topicName: type: string example: example_value defaultReplay: type: string example: example_value state: type: string example: example_value errorRecoveryReplay: type: string example: example_value examples: - label: Managed Sub OpportunityChangeEvent topicName: /data/OpportunityChangeEvent defaultReplay: LATEST state: RUN errorRecoveryReplay: LATEST Header4: title: Header4 required: - SessionHeader type: object properties: SessionHeader: allOf: - $ref: '#/components/schemas/SessionHeader' - xml: name: SessionHeader namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false example: example_value xml: name: Header namespace: http://schemas.xmlsoap.org/soap/envelope/ prefix: SOAP-ENV attribute: false wrapped: false Metadata12: title: Metadata12 required: - eventChannel - destinationResourceName - label - relayOption type: object properties: eventChannel: type: string example: example_value destinationResourceName: type: string example: example_value label: type: string example: Example Title relayOption: type: string example: example_value examples: - eventChannel: Carbon_Comparison_Channel__chn destinationResourceName: callout:MyNamedCredential label: My Event Relay relayOption: '{"ReplayRecovery":"LATEST"}' Field1: title: Field1 required: - aggregatable - aiPredictionField - autoNumber - byteLength - calculated - calculatedFormula - cascadeDelete - caseSensitive - compoundFieldName - controllerName - createable - custom - defaultValue - defaultValueFormula - defaultedOnCreate - dependentPicklist - deprecatedAndHidden - digits - displayLocationInDecimal - encrypted - externalId - extraTypeInfo - filterable - filteredLookupInfo - formulaTreatNullNumberAsZero - groupable - highScaleNumber - htmlFormatted - idLookup - inlineHelpText - label - length - mask - maskType - name - nameField - namePointing - nillable - permissionable - picklistValues - polymorphicForeignKey - precision - queryByDistance - referenceTargetField - referenceTo - relationshipName - relationshipOrder - restrictedDelete - restrictedPicklist - scale - searchPrefilterable - soapType - sortable - type - unique - updateable - writeRequiresMasterRead type: object properties: aggregatable: type: boolean example: true aiPredictionField: type: boolean example: true autoNumber: type: boolean example: true byteLength: type: integer contentEncoding: int32 example: 10 calculated: type: boolean example: true calculatedFormula: type: - string - 'null' example: example_value cascadeDelete: type: boolean example: true caseSensitive: type: boolean example: true compoundFieldName: type: - string - 'null' example: example_value controllerName: type: - string - 'null' example: example_value createable: type: boolean example: true custom: type: boolean example: true defaultValue: oneOf: - type: - string - 'null' - type: boolean - {} example: example_value defaultValueFormula: type: - string - 'null' example: example_value defaultedOnCreate: type: boolean example: true dependentPicklist: type: boolean example: true deprecatedAndHidden: type: boolean example: true digits: type: integer contentEncoding: int32 example: 10 displayLocationInDecimal: type: boolean example: true encrypted: type: boolean example: true externalId: type: boolean example: '500123' extraTypeInfo: type: - string - 'null' example: example_value filterable: type: boolean example: true filteredLookupInfo: type: - string - 'null' example: example_value formulaTreatNullNumberAsZero: type: boolean example: true groupable: type: boolean example: true highScaleNumber: type: boolean example: true htmlFormatted: type: boolean example: true idLookup: type: boolean example: true inlineHelpText: type: - string - 'null' example: example_value label: type: string example: Example Title length: type: integer contentEncoding: int32 example: 10 mask: type: - string - 'null' example: example_value maskType: type: - string - 'null' example: example_value name: type: string example: Example Title nameField: type: boolean example: true namePointing: type: boolean example: true nillable: type: boolean example: true permissionable: type: boolean example: true picklistValues: type: array items: oneOf: - $ref: '#/components/schemas/PicklistValue' - allOf: - $ref: '#/components/schemas/PicklistValue1' - examples: - active: true defaultValue: false label: English validFor: null value: en_US description: '' example: [] polymorphicForeignKey: type: boolean example: true precision: type: integer contentEncoding: int32 example: 10 queryByDistance: type: boolean example: true referenceTargetField: type: - string - 'null' example: example_value referenceTo: type: array items: type: string description: '' example: [] relationshipName: type: - string - 'null' example: example_value relationshipOrder: type: - string - 'null' example: example_value restrictedDelete: type: boolean example: true restrictedPicklist: type: boolean example: true scale: type: integer contentEncoding: int32 example: 10 searchPrefilterable: type: boolean example: true soapType: type: string example: example_value sortable: type: boolean example: true type: type: string example: example_value unique: type: boolean example: true updateable: type: boolean example: true writeRequiresMasterRead: type: boolean example: true sObjects: title: sObjects required: - type - Annual_Mileage__c - Current_Vehicle__c - Model_Year__c type: object properties: type: type: string xml: name: type namespace: urn:sobject.partner.soap.sforce.com prefix: ns1 attribute: false wrapped: false example: example_value Annual_Mileage__c: type: integer contentEncoding: int32 xml: name: Annual_Mileage__c namespace: '' attribute: false wrapped: false example: 10 Current_Vehicle__c: type: string xml: name: Current_Vehicle__c namespace: '' attribute: false wrapped: false example: example_value Model_Year__c: type: integer contentEncoding: int32 xml: name: Model_Year__c namespace: '' attribute: false wrapped: false example: 10 xml: name: sObjects namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false Type11: title: Type11 required: - type - name - doc - fields type: object properties: type: type: string example: example_value name: type: string example: Example Title doc: type: string example: example_value fields: type: array items: $ref: '#/components/schemas/Field5' description: '' example: [] PicklistValue: title: PicklistValue type: object properties: active: type: boolean example: true defaultValue: type: boolean example: true label: type: string example: Example Title validFor: type: - string - 'null' example: example_value value: type: string example: example_value Describeeventchannel: title: Describeeventchannel required: - actionOverrides - activateable - associateEntityType - associateParentEntity - childRelationships - compactLayoutable - createable - custom - customSetting - deepCloneable - defaultImplementation - deletable - deprecatedAndHidden - extendedBy - extendsInterfaces - feedEnabled - fields - hasSubtypes - implementedBy - implementsInterfaces - isInterface - isSubtype - keyPrefix - label - labelPlural - layoutable - listviewable - lookupLayoutable - mergeable - mruEnabled - name - namedLayoutInfos - networkScopeFieldName - queryable - recordTypeInfos - replicateable - retrieveable - searchLayoutable - searchable - sobjectDescribeOption - supportedScopes - triggerable - undeletable - updateable - urls type: object properties: actionOverrides: type: array items: type: string description: '' example: [] activateable: type: boolean example: true associateEntityType: type: - string - 'null' example: example_value associateParentEntity: type: - string - 'null' example: example_value childRelationships: type: array items: type: string description: '' example: [] compactLayoutable: type: boolean example: true createable: type: boolean example: true custom: type: boolean example: true customSetting: type: boolean example: true deepCloneable: type: boolean example: true defaultImplementation: type: - string - 'null' example: example_value deletable: type: boolean example: true deprecatedAndHidden: type: boolean example: true extendedBy: type: - string - 'null' example: example_value extendsInterfaces: type: - string - 'null' example: example_value feedEnabled: type: boolean example: true fields: type: array items: $ref: '#/components/schemas/Field1' description: '' example: [] hasSubtypes: type: boolean example: true implementedBy: type: - string - 'null' example: example_value implementsInterfaces: type: - string - 'null' example: example_value isInterface: type: boolean example: true isSubtype: type: boolean example: true keyPrefix: type: string example: example_value label: type: string example: Example Title labelPlural: type: string example: example_value layoutable: type: boolean example: true listviewable: type: - string - 'null' example: example_value lookupLayoutable: type: - string - 'null' example: example_value mergeable: type: boolean example: true mruEnabled: type: boolean example: true name: type: string example: Example Title namedLayoutInfos: type: array items: type: string description: '' example: [] networkScopeFieldName: type: - string - 'null' example: example_value queryable: type: boolean example: true recordTypeInfos: type: array items: type: string description: '' example: [] replicateable: type: boolean example: true retrieveable: type: boolean example: true searchLayoutable: type: boolean example: true searchable: type: boolean example: true sobjectDescribeOption: type: string example: example_value supportedScopes: type: array items: $ref: '#/components/schemas/SupportedScope' description: '' example: [] triggerable: type: boolean example: true undeletable: type: boolean example: true updateable: type: boolean example: true urls: $ref: '#/components/schemas/Urls2' Metadata13: title: Metadata13 required: - state type: object properties: state: type: string example: example_value examples: - state: RUN SessionHeader: title: SessionHeader required: - sessionId type: object properties: sessionId: type: string xml: name: sessionId namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false example: '500123' xml: name: SessionHeader namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false Type1: title: Type1 type: object properties: type: type: string example: example_value name: type: string example: Example Title doc: type: string example: example_value fields: type: array items: $ref: '#/components/schemas/Field4' description: '' example: [] PlatformEventSchemabyEventName: title: PlatformEventSchemabyEventName required: - name - namespace - type - fields type: object properties: name: type: string example: Example Title namespace: type: string example: example_value type: type: string example: example_value fields: type: array items: $ref: '#/components/schemas/Field2' description: '' example: [] create: title: create required: - sObjects type: object properties: sObjects: type: array items: $ref: '#/components/schemas/sObjects' description: '' xml: namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false example: [] xml: name: create namespace: urn:partner.soap.sforce.com prefix: ns2 attribute: false wrapped: false PicklistValue1: title: PicklistValue1 required: - active - defaultValue - label - validFor - value type: object properties: active: type: boolean example: true defaultValue: type: boolean example: true label: type: - string - 'null' example: Example Title validFor: type: - string - 'null' example: example_value value: type: string example: example_value examples: - active: true defaultValue: false label: English validFor: null value: en_US Field4: title: Field4 required: - name - type - doc type: object properties: name: type: string example: Example Title type: oneOf: - type: array items: type: string - type: array items: type: string example: example_value doc: type: string example: example_value default: type: - string - 'null' example: example_value Geteventchannel: title: Geteventchannel required: - attributes - Id - IsDeleted - DeveloperName - Language - MasterLabel - NamespacePrefix - ManageableState - CreatedDate - CreatedById - LastModifiedDate - LastModifiedById - SystemModstamp - ChannelType - FullName - Metadata type: object properties: attributes: $ref: '#/components/schemas/Attributes4' Id: type: string example: abc123 IsDeleted: type: boolean example: true DeveloperName: type: string example: example_value Language: type: string example: example_value MasterLabel: type: string example: example_value NamespacePrefix: type: - string - 'null' example: example_value ManageableState: type: string example: example_value CreatedDate: type: string example: example_value CreatedById: type: string example: '500123' LastModifiedDate: type: string example: example_value LastModifiedById: type: string example: '500123' SystemModstamp: type: string example: example_value ChannelType: type: string example: example_value FullName: type: string example: example_value Metadata: $ref: '#/components/schemas/Metadata1' examples: - attributes: type: PlatformEventChannel url: /services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE Id: 0YL4H0000004C93WAE IsDeleted: false DeveloperName: HREvents Language: en_US MasterLabel: Custom Channel for the HR App NamespacePrefix: null ManageableState: unmanaged CreatedDate: 2021-01-11T19:33:54.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2021-01-11T19:33:54.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2021-01-11T19:33:54.000+0000 ChannelType: data FullName: HREvents__chn Metadata: channelType: data label: Custom Channel for the HR App urls: null CreateeventrelayRequest: title: CreateeventrelayRequest required: - FullName - Metadata type: object properties: FullName: type: string example: example_value Metadata: $ref: '#/components/schemas/Metadata12' examples: - FullName: MyEventRelay Metadata: eventChannel: Carbon_Comparison_Channel__chn destinationResourceName: callout:MyNamedCredential label: My Event Relay relayOption: '{"ReplayRecovery":"LATEST"}' CreatemanagedeventsubscriptionRequest: title: CreatemanagedeventsubscriptionRequest required: - FullName - Metadata type: object properties: FullName: type: string example: example_value Metadata: $ref: '#/components/schemas/Metadata15' examples: - FullName: Managed_Sub_OpportunityChangeEvent Metadata: label: Managed Sub OpportunityChangeEvent topicName: /data/OpportunityChangeEvent defaultReplay: LATEST state: RUN errorRecoveryReplay: LATEST 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}". '