naftiko: 1.0.0-alpha2 info: label: Coveo Source API — Sources description: 'Coveo Source API — Sources. 47 operations. Lead operation: Get a Subset of Sources for an Organization. Self-contained Naftiko capability covering one Coveo business surface.' tags: - Coveo - Source - Sources created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: COVEO_API_KEY: COVEO_API_KEY capability: consumes: - type: http namespace: source-sources baseUri: https://platform.cloud.coveo.com description: Coveo Source API — Sources business capability. Self-contained, no shared references. authentication: type: bearer token: '{{env.COVEO_API_KEY}}' resources: - name: rest-organizations-organizationId-sources path: /rest/organizations/{organizationId}/sources operations: - name: getsources method: GET description: Get a Subset of Sources for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: perPage in: query type: integer - name: filter in: query type: string description: Optional filter string. Must be at least 2 characters long to be applied. - name: sortingType in: query type: string - name: sortingOrder in: query type: string - name: writeAccessOnly in: query type: boolean - name: filterStatusType in: query type: string - name: filterLastOperationType in: query type: string - name: filterLastOperationResultType in: query type: string - name: filterHostType in: query type: string - name: stringFilterType in: query type: string - name: createsource method: POST description: Create a Source from Simple Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: updateSecurityProviders in: query type: boolean - name: rebuild in: query type: boolean - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-document-configuration-default path: /rest/organizations/{organizationId}/sources/document/configuration/default operations: - name: getdefaultdocumentconfiguration method: GET description: Get the Default Document Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: defaultDocumentConfigurationType in: query type: string - name: rest-organizations-organizationId-sources-fields path: /rest/organizations/{organizationId}/sources/fields operations: - name: getfields1 method: GET description: Get All Fields for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: query type: string - name: includeMappings in: query type: boolean - name: createfield method: POST description: Creates a Field for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-fields-batch-create path: /rest/organizations/{organizationId}/sources/fields/batch/create operations: - name: createfields method: POST description: Creates Fields for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-fields-batch-delete path: /rest/organizations/{organizationId}/sources/fields/batch/delete operations: - name: removefields method: DELETE description: Removes Fields from an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: fields in: query type: array required: true - name: rest-organizations-organizationId-sources-fields-batch-update path: /rest/organizations/{organizationId}/sources/fields/batch/update operations: - name: updatefields method: PUT description: Update a Field for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-fields-fieldId path: /rest/organizations/{organizationId}/sources/fields/{fieldId} operations: - name: getfield method: GET description: Get a Single Field for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: fieldId in: path type: string required: true - name: includeMappings in: query type: boolean - name: updatefield method: PUT description: Update a Field for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: fieldId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: removefield method: DELETE description: Removes a Specific Field from an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: fieldId in: path type: string required: true - name: rest-organizations-organizationId-sources-page-fields path: /rest/organizations/{organizationId}/sources/page/fields operations: - name: getfields2 method: GET description: Get a Page of Fields for an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: projectId in: query type: string - name: includeMappings in: query type: boolean - name: type in: query type: string - name: filter in: query type: string description: Optional filter string. Must be at least 2 characters long to be applied. - name: sortBy in: query type: string - name: order in: query type: string - name: page in: query type: integer - name: perPage in: query type: integer - name: origin in: query type: string - name: rest-organizations-organizationId-sources-pages path: /rest/organizations/{organizationId}/sources/pages operations: - name: getsourcesandpageinformations method: GET description: Get a Page Containing a Subset of Sources for an Organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: perPage in: query type: integer - name: filter in: query type: string description: Optional filter string. Must be at least 2 characters long to be applied. - name: sortingType in: query type: string - name: sortingOrder in: query type: string - name: writeAccessOnly in: query type: boolean - name: filterStatusType in: query type: string - name: filterLastOperationType in: query type: string - name: filterLastOperationResultType in: query type: string - name: filterHostType in: query type: string - name: stringFilterType in: query type: string - name: rest-organizations-organizationId-sources-pages-ids path: /rest/organizations/{organizationId}/sources/pages/ids operations: - name: getsourcesandpageinformationsbyids method: POST description: Get a Page Containing a Subset of Sources by Ids for an Organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: perPage in: query type: integer - name: filter in: query type: string description: Optional filter string. Must be at least 2 characters long to be applied. - name: sortingType in: query type: string - name: sortingOrder in: query type: string - name: writeAccessOnly in: query type: boolean - name: filterStatusType in: query type: string - name: filterLastOperationType in: query type: string - name: filterLastOperationResultType in: query type: string - name: filterHostType in: query type: string - name: stringFilterType in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-pages-project path: /rest/organizations/{organizationId}/sources/pages/project operations: - name: getsourcesandpageinformationsprojectid method: GET description: Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: perPage in: query type: integer - name: filter in: query type: string description: Optional filter string. Must be at least 2 characters long to be applied. - name: projectId in: query type: string - name: sortingType in: query type: string - name: sortingOrder in: query type: string - name: writeAccessOnly in: query type: boolean - name: filterStatusType in: query type: string - name: filterLastOperationType in: query type: string - name: filterLastOperationResultType in: query type: string - name: filterHostType in: query type: string - name: stringFilterType in: query type: string - name: rest-organizations-organizationId-sources-raw path: /rest/organizations/{organizationId}/sources/raw operations: - name: createrawsource method: POST description: Create a Source from Raw Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: updateSecurityProviders in: query type: boolean - name: rebuild in: query type: boolean - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-raw-all path: /rest/organizations/{organizationId}/sources/raw/all operations: - name: getallrawsources method: GET description: Get the Raw Configuration of All Sources outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: pageSize in: query type: integer - name: includeMappings in: query type: boolean - name: rest-organizations-organizationId-sources-sourceId path: /rest/organizations/{organizationId}/sources/{sourceId} operations: - name: getsource method: GET description: Get a Single Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: updatesource method: PUT description: Update a Source from Simple Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: updateSecurityProviders in: query type: boolean - name: rebuild in: query type: boolean - name: body in: body type: object description: Request body (JSON). required: true - name: deletesource method: DELETE description: Delete a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-applyChanges path: /rest/organizations/{organizationId}/sources/{sourceId}/applyChanges operations: - name: applychanges method: POST description: Apply Pending Changes on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-evic path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/evict operations: - name: evictschemaforsource method: POST description: Evict the Salesforce Schema of a Source. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName} operations: - name: getsalesforceobjectforsource method: GET description: Get an Object Fields for a Given Source. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: objectName in: path type: string required: true - name: relationships in: query type: string - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/fields operations: - name: getsalesforcefieldsforsource method: GET description: Get an Object Fields for a Given Source. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: objectName in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/{relationshipName} operations: - name: getsalesforcerelationshipsforsource method: GET description: Get a Relationship for a Given Source and Object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: objectName in: path type: string required: true - name: relationshipName in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-configuration-snapshot path: /rest/organizations/{organizationId}/sources/{sourceId}/configuration/snapshot operations: - name: getsourcesnapshot method: GET description: Get the Snapshot of the Source Configuration at the Provided Activity. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3` required: true - name: sourceId in: path type: string description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y` required: true - name: activityId in: query type: string required: true - name: rest-organizations-organizationId-sources-sourceId-disable path: /rest/organizations/{organizationId}/sources/{sourceId}/disable operations: - name: disable method: POST description: Disable Schedules on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-duplicate path: /rest/organizations/{organizationId}/sources/{sourceId}/duplicate operations: - name: duplicatesource method: POST description: Duplicate a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: newSourceName in: query type: string required: true - name: logicalIndexId in: query type: string - name: rest-organizations-organizationId-sources-sourceId-enable path: /rest/organizations/{organizationId}/sources/{sourceId}/enable operations: - name: enable method: POST description: Enable Schedules on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-fullRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/fullRefresh operations: - name: fullrefresh method: POST description: Apply a Full Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-incrementalRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/incrementalRefresh operations: - name: incrementalrefresh method: POST description: Apply an Incremental Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-light path: /rest/organizations/{organizationId}/sources/{sourceId}/light operations: - name: getlightsource method: GET description: Get a Single Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-pauseRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/pauseRefresh operations: - name: pauserefresh method: POST description: Pause the Current Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-permissions-update path: /rest/organizations/{organizationId}/sources/{sourceId}/permissions/update operations: - name: updatesourcepermissions method: PUT description: Update Source Permissions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-sourceId-pushRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/pushRefresh operations: - name: setpushrefreshstatus method: POST description: Sets the Refreshing State of a Push Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: activityOperation in: query type: string required: true - name: rest-organizations-organizationId-sources-sourceId-raw path: /rest/organizations/{organizationId}/sources/{sourceId}/raw operations: - name: getrawsource method: GET description: Get the Raw Configuration of a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: includeMappings in: query type: boolean - name: updaterawsource method: PUT description: Update a Source from Raw Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: updateSecurityProviders in: query type: boolean - name: rebuild in: query type: boolean - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-sourceId-rebuild path: /rest/organizations/{organizationId}/sources/{sourceId}/rebuild operations: - name: rebuild method: POST description: Apply a Rebuild Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-resumeRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/resumeRefresh operations: - name: resumerefresh method: POST description: Resume the Current Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-schedules path: /rest/organizations/{organizationId}/sources/{sourceId}/schedules operations: - name: getsourceschedules method: GET description: Get All Source Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: createsourceschedule method: POST description: Create a New Schedule for the Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-sources-sourceId-schedules-scheduleId path: /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId} operations: - name: getsourceschedule method: GET description: Get a Source Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: scheduleId in: path type: string required: true - name: updatesourceschedule method: PUT description: Update a Source Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: scheduleId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deletesourceschedule method: DELETE description: Delete a Source Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: scheduleId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-startRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/startRefresh operations: - name: startrefresh method: POST description: Start a Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-stopRefresh path: /rest/organizations/{organizationId}/sources/{sourceId}/stopRefresh operations: - name: stoprefresh method: POST description: Stop the Current Refresh Operation on a Source outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: rest-organizations-organizationId-sources-sourceId-tasks-abort path: /rest/organizations/{organizationId}/sources/{sourceId}/tasks/abort operations: - name: aborttaskforactivity method: POST description: Abort a Source Task Related to a Given Activity. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: sourceId in: path type: string required: true - name: activityId in: query type: string required: true exposes: - type: rest namespace: source-sources-rest port: 8080 description: REST adapter for Coveo Source API — Sources. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/organizations/{organizationid}/sources name: rest-organizations-organizationid-sources description: REST surface for rest-organizations-organizationId-sources. operations: - method: GET name: getsources description: Get a Subset of Sources for an Organization call: source-sources.getsources with: organizationId: rest.organizationId page: rest.page perPage: rest.perPage filter: rest.filter sortingType: rest.sortingType sortingOrder: rest.sortingOrder writeAccessOnly: rest.writeAccessOnly filterStatusType: rest.filterStatusType filterLastOperationType: rest.filterLastOperationType filterLastOperationResultType: rest.filterLastOperationResultType filterHostType: rest.filterHostType stringFilterType: rest.stringFilterType outputParameters: - type: object mapping: $. - method: POST name: createsource description: Create a Source from Simple Configuration call: source-sources.createsource with: organizationId: rest.organizationId updateSecurityProviders: rest.updateSecurityProviders rebuild: rest.rebuild body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/document/configuration/default name: rest-organizations-organizationid-sources-document-configuration-default description: REST surface for rest-organizations-organizationId-sources-document-configuration-default. operations: - method: GET name: getdefaultdocumentconfiguration description: Get the Default Document Configuration call: source-sources.getdefaultdocumentconfiguration with: organizationId: rest.organizationId defaultDocumentConfigurationType: rest.defaultDocumentConfigurationType outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/fields name: rest-organizations-organizationid-sources-fields description: REST surface for rest-organizations-organizationId-sources-fields. operations: - method: GET name: getfields1 description: Get All Fields for an Organization call: source-sources.getfields1 with: organizationId: rest.organizationId sourceId: rest.sourceId includeMappings: rest.includeMappings outputParameters: - type: object mapping: $. - method: POST name: createfield description: Creates a Field for an Organization call: source-sources.createfield with: organizationId: rest.organizationId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/fields/batch/create name: rest-organizations-organizationid-sources-fields-batch-create description: REST surface for rest-organizations-organizationId-sources-fields-batch-create. operations: - method: POST name: createfields description: Creates Fields for an Organization call: source-sources.createfields with: organizationId: rest.organizationId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/fields/batch/delete name: rest-organizations-organizationid-sources-fields-batch-delete description: REST surface for rest-organizations-organizationId-sources-fields-batch-delete. operations: - method: DELETE name: removefields description: Removes Fields from an Organization call: source-sources.removefields with: organizationId: rest.organizationId fields: rest.fields outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/fields/batch/update name: rest-organizations-organizationid-sources-fields-batch-update description: REST surface for rest-organizations-organizationId-sources-fields-batch-update. operations: - method: PUT name: updatefields description: Update a Field for an Organization call: source-sources.updatefields with: organizationId: rest.organizationId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/fields/{fieldid} name: rest-organizations-organizationid-sources-fields-fieldid description: REST surface for rest-organizations-organizationId-sources-fields-fieldId. operations: - method: GET name: getfield description: Get a Single Field for an Organization call: source-sources.getfield with: organizationId: rest.organizationId fieldId: rest.fieldId includeMappings: rest.includeMappings outputParameters: - type: object mapping: $. - method: PUT name: updatefield description: Update a Field for an Organization call: source-sources.updatefield with: organizationId: rest.organizationId fieldId: rest.fieldId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removefield description: Removes a Specific Field from an Organization call: source-sources.removefield with: organizationId: rest.organizationId fieldId: rest.fieldId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/page/fields name: rest-organizations-organizationid-sources-page-fields description: REST surface for rest-organizations-organizationId-sources-page-fields. operations: - method: GET name: getfields2 description: Get a Page of Fields for an Organization call: source-sources.getfields2 with: organizationId: rest.organizationId projectId: rest.projectId includeMappings: rest.includeMappings type: rest.type filter: rest.filter sortBy: rest.sortBy order: rest.order page: rest.page perPage: rest.perPage origin: rest.origin outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/pages name: rest-organizations-organizationid-sources-pages description: REST surface for rest-organizations-organizationId-sources-pages. operations: - method: GET name: getsourcesandpageinformations description: Get a Page Containing a Subset of Sources for an Organization. call: source-sources.getsourcesandpageinformations with: organizationId: rest.organizationId page: rest.page perPage: rest.perPage filter: rest.filter sortingType: rest.sortingType sortingOrder: rest.sortingOrder writeAccessOnly: rest.writeAccessOnly filterStatusType: rest.filterStatusType filterLastOperationType: rest.filterLastOperationType filterLastOperationResultType: rest.filterLastOperationResultType filterHostType: rest.filterHostType stringFilterType: rest.stringFilterType outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/pages/ids name: rest-organizations-organizationid-sources-pages-ids description: REST surface for rest-organizations-organizationId-sources-pages-ids. operations: - method: POST name: getsourcesandpageinformationsbyids description: Get a Page Containing a Subset of Sources by Ids for an Organization. call: source-sources.getsourcesandpageinformationsbyids with: organizationId: rest.organizationId page: rest.page perPage: rest.perPage filter: rest.filter sortingType: rest.sortingType sortingOrder: rest.sortingOrder writeAccessOnly: rest.writeAccessOnly filterStatusType: rest.filterStatusType filterLastOperationType: rest.filterLastOperationType filterLastOperationResultType: rest.filterLastOperationResultType filterHostType: rest.filterHostType stringFilterType: rest.stringFilterType body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/pages/project name: rest-organizations-organizationid-sources-pages-project description: REST surface for rest-organizations-organizationId-sources-pages-project. operations: - method: GET name: getsourcesandpageinformationsprojectid description: Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages call: source-sources.getsourcesandpageinformationsprojectid with: organizationId: rest.organizationId page: rest.page perPage: rest.perPage filter: rest.filter projectId: rest.projectId sortingType: rest.sortingType sortingOrder: rest.sortingOrder writeAccessOnly: rest.writeAccessOnly filterStatusType: rest.filterStatusType filterLastOperationType: rest.filterLastOperationType filterLastOperationResultType: rest.filterLastOperationResultType filterHostType: rest.filterHostType stringFilterType: rest.stringFilterType outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/raw name: rest-organizations-organizationid-sources-raw description: REST surface for rest-organizations-organizationId-sources-raw. operations: - method: POST name: createrawsource description: Create a Source from Raw Configuration call: source-sources.createrawsource with: organizationId: rest.organizationId updateSecurityProviders: rest.updateSecurityProviders rebuild: rest.rebuild body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/raw/all name: rest-organizations-organizationid-sources-raw-all description: REST surface for rest-organizations-organizationId-sources-raw-all. operations: - method: GET name: getallrawsources description: Get the Raw Configuration of All Sources call: source-sources.getallrawsources with: organizationId: rest.organizationId page: rest.page pageSize: rest.pageSize includeMappings: rest.includeMappings outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid} name: rest-organizations-organizationid-sources-sourceid description: REST surface for rest-organizations-organizationId-sources-sourceId. operations: - method: GET name: getsource description: Get a Single Source call: source-sources.getsource with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - method: PUT name: updatesource description: Update a Source from Simple Configuration call: source-sources.updatesource with: organizationId: rest.organizationId sourceId: rest.sourceId updateSecurityProviders: rest.updateSecurityProviders rebuild: rest.rebuild body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesource description: Delete a Source call: source-sources.deletesource with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/applychanges name: rest-organizations-organizationid-sources-sourceid-applychanges description: REST surface for rest-organizations-organizationId-sources-sourceId-applyChanges. operations: - method: POST name: applychanges description: Apply Pending Changes on a Source call: source-sources.applychanges with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/configuration/salesforce/evict name: rest-organizations-organizationid-sources-sourceid-configuration-salesforce-evic description: REST surface for rest-organizations-organizationId-sources-sourceId-configuration-salesforce-evic. operations: - method: POST name: evictschemaforsource description: Evict the Salesforce Schema of a Source. call: source-sources.evictschemaforsource with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/configuration/salesforce/objects/{objectname} name: rest-organizations-organizationid-sources-sourceid-configuration-salesforce-obje description: REST surface for rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje. operations: - method: GET name: getsalesforceobjectforsource description: Get an Object Fields for a Given Source. call: source-sources.getsalesforceobjectforsource with: organizationId: rest.organizationId sourceId: rest.sourceId objectName: rest.objectName relationships: rest.relationships outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/configuration/salesforce/objects/{objectname}/fields name: rest-organizations-organizationid-sources-sourceid-configuration-salesforce-obje description: REST surface for rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje. operations: - method: GET name: getsalesforcefieldsforsource description: Get an Object Fields for a Given Source. call: source-sources.getsalesforcefieldsforsource with: organizationId: rest.organizationId sourceId: rest.sourceId objectName: rest.objectName outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/configuration/salesforce/objects/{objectname}/{relationshipname} name: rest-organizations-organizationid-sources-sourceid-configuration-salesforce-obje description: REST surface for rest-organizations-organizationId-sources-sourceId-configuration-salesforce-obje. operations: - method: GET name: getsalesforcerelationshipsforsource description: Get a Relationship for a Given Source and Object. call: source-sources.getsalesforcerelationshipsforsource with: organizationId: rest.organizationId sourceId: rest.sourceId objectName: rest.objectName relationshipName: rest.relationshipName outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/configuration/snapshot name: rest-organizations-organizationid-sources-sourceid-configuration-snapshot description: REST surface for rest-organizations-organizationId-sources-sourceId-configuration-snapshot. operations: - method: GET name: getsourcesnapshot description: Get the Snapshot of the Source Configuration at the Provided Activity. call: source-sources.getsourcesnapshot with: organizationId: rest.organizationId sourceId: rest.sourceId activityId: rest.activityId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/disable name: rest-organizations-organizationid-sources-sourceid-disable description: REST surface for rest-organizations-organizationId-sources-sourceId-disable. operations: - method: POST name: disable description: Disable Schedules on a Source call: source-sources.disable with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/duplicate name: rest-organizations-organizationid-sources-sourceid-duplicate description: REST surface for rest-organizations-organizationId-sources-sourceId-duplicate. operations: - method: POST name: duplicatesource description: Duplicate a Source call: source-sources.duplicatesource with: organizationId: rest.organizationId sourceId: rest.sourceId newSourceName: rest.newSourceName logicalIndexId: rest.logicalIndexId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/enable name: rest-organizations-organizationid-sources-sourceid-enable description: REST surface for rest-organizations-organizationId-sources-sourceId-enable. operations: - method: POST name: enable description: Enable Schedules on a Source call: source-sources.enable with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/fullrefresh name: rest-organizations-organizationid-sources-sourceid-fullrefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-fullRefresh. operations: - method: POST name: fullrefresh description: Apply a Full Refresh Operation on a Source call: source-sources.fullrefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/incrementalrefresh name: rest-organizations-organizationid-sources-sourceid-incrementalrefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-incrementalRefresh. operations: - method: POST name: incrementalrefresh description: Apply an Incremental Refresh Operation on a Source call: source-sources.incrementalrefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/light name: rest-organizations-organizationid-sources-sourceid-light description: REST surface for rest-organizations-organizationId-sources-sourceId-light. operations: - method: GET name: getlightsource description: Get a Single Source call: source-sources.getlightsource with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/pauserefresh name: rest-organizations-organizationid-sources-sourceid-pauserefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-pauseRefresh. operations: - method: POST name: pauserefresh description: Pause the Current Refresh Operation on a Source call: source-sources.pauserefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/permissions/update name: rest-organizations-organizationid-sources-sourceid-permissions-update description: REST surface for rest-organizations-organizationId-sources-sourceId-permissions-update. operations: - method: PUT name: updatesourcepermissions description: Update Source Permissions call: source-sources.updatesourcepermissions with: organizationId: rest.organizationId sourceId: rest.sourceId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/pushrefresh name: rest-organizations-organizationid-sources-sourceid-pushrefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-pushRefresh. operations: - method: POST name: setpushrefreshstatus description: Sets the Refreshing State of a Push Source call: source-sources.setpushrefreshstatus with: organizationId: rest.organizationId sourceId: rest.sourceId activityOperation: rest.activityOperation outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/raw name: rest-organizations-organizationid-sources-sourceid-raw description: REST surface for rest-organizations-organizationId-sources-sourceId-raw. operations: - method: GET name: getrawsource description: Get the Raw Configuration of a Source call: source-sources.getrawsource with: organizationId: rest.organizationId sourceId: rest.sourceId includeMappings: rest.includeMappings outputParameters: - type: object mapping: $. - method: PUT name: updaterawsource description: Update a Source from Raw Configuration call: source-sources.updaterawsource with: organizationId: rest.organizationId sourceId: rest.sourceId updateSecurityProviders: rest.updateSecurityProviders rebuild: rest.rebuild body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/rebuild name: rest-organizations-organizationid-sources-sourceid-rebuild description: REST surface for rest-organizations-organizationId-sources-sourceId-rebuild. operations: - method: POST name: rebuild description: Apply a Rebuild Operation on a Source call: source-sources.rebuild with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/resumerefresh name: rest-organizations-organizationid-sources-sourceid-resumerefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-resumeRefresh. operations: - method: POST name: resumerefresh description: Resume the Current Refresh Operation on a Source call: source-sources.resumerefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/schedules name: rest-organizations-organizationid-sources-sourceid-schedules description: REST surface for rest-organizations-organizationId-sources-sourceId-schedules. operations: - method: GET name: getsourceschedules description: Get All Source Schedules call: source-sources.getsourceschedules with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - method: POST name: createsourceschedule description: Create a New Schedule for the Source call: source-sources.createsourceschedule with: organizationId: rest.organizationId sourceId: rest.sourceId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/schedules/{scheduleid} name: rest-organizations-organizationid-sources-sourceid-schedules-scheduleid description: REST surface for rest-organizations-organizationId-sources-sourceId-schedules-scheduleId. operations: - method: GET name: getsourceschedule description: Get a Source Schedule call: source-sources.getsourceschedule with: organizationId: rest.organizationId sourceId: rest.sourceId scheduleId: rest.scheduleId outputParameters: - type: object mapping: $. - method: PUT name: updatesourceschedule description: Update a Source Schedule call: source-sources.updatesourceschedule with: organizationId: rest.organizationId sourceId: rest.sourceId scheduleId: rest.scheduleId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesourceschedule description: Delete a Source Schedule call: source-sources.deletesourceschedule with: organizationId: rest.organizationId sourceId: rest.sourceId scheduleId: rest.scheduleId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/startrefresh name: rest-organizations-organizationid-sources-sourceid-startrefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-startRefresh. operations: - method: POST name: startrefresh description: Start a Refresh Operation on a Source call: source-sources.startrefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/stoprefresh name: rest-organizations-organizationid-sources-sourceid-stoprefresh description: REST surface for rest-organizations-organizationId-sources-sourceId-stopRefresh. operations: - method: POST name: stoprefresh description: Stop the Current Refresh Operation on a Source call: source-sources.stoprefresh with: organizationId: rest.organizationId sourceId: rest.sourceId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/sources/{sourceid}/tasks/abort name: rest-organizations-organizationid-sources-sourceid-tasks-abort description: REST surface for rest-organizations-organizationId-sources-sourceId-tasks-abort. operations: - method: POST name: aborttaskforactivity description: Abort a Source Task Related to a Given Activity. call: source-sources.aborttaskforactivity with: organizationId: rest.organizationId sourceId: rest.sourceId activityId: rest.activityId outputParameters: - type: object mapping: $. - type: mcp namespace: source-sources-mcp port: 9090 transport: http description: MCP adapter for Coveo Source API — Sources. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-subset-sources-organization description: Get a Subset of Sources for an Organization hints: readOnly: true destructive: false idempotent: true call: source-sources.getsources with: organizationId: tools.organizationId page: tools.page perPage: tools.perPage filter: tools.filter sortingType: tools.sortingType sortingOrder: tools.sortingOrder writeAccessOnly: tools.writeAccessOnly filterStatusType: tools.filterStatusType filterLastOperationType: tools.filterLastOperationType filterLastOperationResultType: tools.filterLastOperationResultType filterHostType: tools.filterHostType stringFilterType: tools.stringFilterType outputParameters: - type: object mapping: $. - name: create-source-simple-configuration description: Create a Source from Simple Configuration hints: readOnly: false destructive: false idempotent: false call: source-sources.createsource with: organizationId: tools.organizationId updateSecurityProviders: tools.updateSecurityProviders rebuild: tools.rebuild body: tools.body outputParameters: - type: object mapping: $. - name: get-default-document-configuration description: Get the Default Document Configuration hints: readOnly: true destructive: false idempotent: true call: source-sources.getdefaultdocumentconfiguration with: organizationId: tools.organizationId defaultDocumentConfigurationType: tools.defaultDocumentConfigurationType outputParameters: - type: object mapping: $. - name: get-all-fields-organization description: Get All Fields for an Organization hints: readOnly: true destructive: false idempotent: true call: source-sources.getfields1 with: organizationId: tools.organizationId sourceId: tools.sourceId includeMappings: tools.includeMappings outputParameters: - type: object mapping: $. - name: creates-field-organization description: Creates a Field for an Organization hints: readOnly: false destructive: false idempotent: false call: source-sources.createfield with: organizationId: tools.organizationId body: tools.body outputParameters: - type: object mapping: $. - name: creates-fields-organization description: Creates Fields for an Organization hints: readOnly: false destructive: false idempotent: false call: source-sources.createfields with: organizationId: tools.organizationId body: tools.body outputParameters: - type: object mapping: $. - name: removes-fields-organization description: Removes Fields from an Organization hints: readOnly: false destructive: true idempotent: true call: source-sources.removefields with: organizationId: tools.organizationId fields: tools.fields outputParameters: - type: object mapping: $. - name: update-field-organization description: Update a Field for an Organization hints: readOnly: false destructive: false idempotent: true call: source-sources.updatefields with: organizationId: tools.organizationId body: tools.body outputParameters: - type: object mapping: $. - name: get-single-field-organization description: Get a Single Field for an Organization hints: readOnly: true destructive: false idempotent: true call: source-sources.getfield with: organizationId: tools.organizationId fieldId: tools.fieldId includeMappings: tools.includeMappings outputParameters: - type: object mapping: $. - name: update-field-organization-2 description: Update a Field for an Organization hints: readOnly: false destructive: false idempotent: true call: source-sources.updatefield with: organizationId: tools.organizationId fieldId: tools.fieldId body: tools.body outputParameters: - type: object mapping: $. - name: removes-specific-field-organization description: Removes a Specific Field from an Organization hints: readOnly: false destructive: true idempotent: true call: source-sources.removefield with: organizationId: tools.organizationId fieldId: tools.fieldId outputParameters: - type: object mapping: $. - name: get-page-fields-organization description: Get a Page of Fields for an Organization hints: readOnly: true destructive: false idempotent: true call: source-sources.getfields2 with: organizationId: tools.organizationId projectId: tools.projectId includeMappings: tools.includeMappings type: tools.type filter: tools.filter sortBy: tools.sortBy order: tools.order page: tools.page perPage: tools.perPage origin: tools.origin outputParameters: - type: object mapping: $. - name: get-page-containing-subset-sources description: Get a Page Containing a Subset of Sources for an Organization. hints: readOnly: true destructive: false idempotent: true call: source-sources.getsourcesandpageinformations with: organizationId: tools.organizationId page: tools.page perPage: tools.perPage filter: tools.filter sortingType: tools.sortingType sortingOrder: tools.sortingOrder writeAccessOnly: tools.writeAccessOnly filterStatusType: tools.filterStatusType filterLastOperationType: tools.filterLastOperationType filterLastOperationResultType: tools.filterLastOperationResultType filterHostType: tools.filterHostType stringFilterType: tools.stringFilterType outputParameters: - type: object mapping: $. - name: get-page-containing-subset-sources-2 description: Get a Page Containing a Subset of Sources by Ids for an Organization. hints: readOnly: true destructive: false idempotent: false call: source-sources.getsourcesandpageinformationsbyids with: organizationId: tools.organizationId page: tools.page perPage: tools.perPage filter: tools.filter sortingType: tools.sortingType sortingOrder: tools.sortingOrder writeAccessOnly: tools.writeAccessOnly filterStatusType: tools.filterStatusType filterLastOperationType: tools.filterLastOperationType filterLastOperationResultType: tools.filterLastOperationResultType filterHostType: tools.filterHostType stringFilterType: tools.stringFilterType body: tools.body outputParameters: - type: object mapping: $. - name: get-page-containing-subset-sources-3 description: Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages hints: readOnly: true destructive: false idempotent: true call: source-sources.getsourcesandpageinformationsprojectid with: organizationId: tools.organizationId page: tools.page perPage: tools.perPage filter: tools.filter projectId: tools.projectId sortingType: tools.sortingType sortingOrder: tools.sortingOrder writeAccessOnly: tools.writeAccessOnly filterStatusType: tools.filterStatusType filterLastOperationType: tools.filterLastOperationType filterLastOperationResultType: tools.filterLastOperationResultType filterHostType: tools.filterHostType stringFilterType: tools.stringFilterType outputParameters: - type: object mapping: $. - name: create-source-raw-configuration description: Create a Source from Raw Configuration hints: readOnly: false destructive: false idempotent: false call: source-sources.createrawsource with: organizationId: tools.organizationId updateSecurityProviders: tools.updateSecurityProviders rebuild: tools.rebuild body: tools.body outputParameters: - type: object mapping: $. - name: get-raw-configuration-all-sources description: Get the Raw Configuration of All Sources hints: readOnly: true destructive: false idempotent: true call: source-sources.getallrawsources with: organizationId: tools.organizationId page: tools.page pageSize: tools.pageSize includeMappings: tools.includeMappings outputParameters: - type: object mapping: $. - name: get-single-source description: Get a Single Source hints: readOnly: true destructive: false idempotent: true call: source-sources.getsource with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: update-source-simple-configuration description: Update a Source from Simple Configuration hints: readOnly: false destructive: false idempotent: true call: source-sources.updatesource with: organizationId: tools.organizationId sourceId: tools.sourceId updateSecurityProviders: tools.updateSecurityProviders rebuild: tools.rebuild body: tools.body outputParameters: - type: object mapping: $. - name: delete-source description: Delete a Source hints: readOnly: false destructive: true idempotent: true call: source-sources.deletesource with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: apply-pending-changes-source description: Apply Pending Changes on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.applychanges with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: evict-salesforce-schema-source description: Evict the Salesforce Schema of a Source. hints: readOnly: false destructive: false idempotent: false call: source-sources.evictschemaforsource with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: get-object-fields-given-source description: Get an Object Fields for a Given Source. hints: readOnly: true destructive: false idempotent: true call: source-sources.getsalesforceobjectforsource with: organizationId: tools.organizationId sourceId: tools.sourceId objectName: tools.objectName relationships: tools.relationships outputParameters: - type: object mapping: $. - name: get-object-fields-given-source-2 description: Get an Object Fields for a Given Source. hints: readOnly: true destructive: false idempotent: true call: source-sources.getsalesforcefieldsforsource with: organizationId: tools.organizationId sourceId: tools.sourceId objectName: tools.objectName outputParameters: - type: object mapping: $. - name: get-relationship-given-source-and description: Get a Relationship for a Given Source and Object. hints: readOnly: true destructive: false idempotent: true call: source-sources.getsalesforcerelationshipsforsource with: organizationId: tools.organizationId sourceId: tools.sourceId objectName: tools.objectName relationshipName: tools.relationshipName outputParameters: - type: object mapping: $. - name: get-snapshot-source-configuration-provided description: Get the Snapshot of the Source Configuration at the Provided Activity. hints: readOnly: true destructive: false idempotent: true call: source-sources.getsourcesnapshot with: organizationId: tools.organizationId sourceId: tools.sourceId activityId: tools.activityId outputParameters: - type: object mapping: $. - name: disable-schedules-source description: Disable Schedules on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.disable with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: duplicate-source description: Duplicate a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.duplicatesource with: organizationId: tools.organizationId sourceId: tools.sourceId newSourceName: tools.newSourceName logicalIndexId: tools.logicalIndexId outputParameters: - type: object mapping: $. - name: enable-schedules-source description: Enable Schedules on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.enable with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: apply-full-refresh-operation-source description: Apply a Full Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.fullrefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: apply-incremental-refresh-operation-source description: Apply an Incremental Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.incrementalrefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: get-single-source-2 description: Get a Single Source hints: readOnly: true destructive: false idempotent: true call: source-sources.getlightsource with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: pause-current-refresh-operation-source description: Pause the Current Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.pauserefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: update-source-permissions description: Update Source Permissions hints: readOnly: false destructive: false idempotent: true call: source-sources.updatesourcepermissions with: organizationId: tools.organizationId sourceId: tools.sourceId body: tools.body outputParameters: - type: object mapping: $. - name: sets-refreshing-state-push-source description: Sets the Refreshing State of a Push Source hints: readOnly: false destructive: false idempotent: false call: source-sources.setpushrefreshstatus with: organizationId: tools.organizationId sourceId: tools.sourceId activityOperation: tools.activityOperation outputParameters: - type: object mapping: $. - name: get-raw-configuration-source description: Get the Raw Configuration of a Source hints: readOnly: true destructive: false idempotent: true call: source-sources.getrawsource with: organizationId: tools.organizationId sourceId: tools.sourceId includeMappings: tools.includeMappings outputParameters: - type: object mapping: $. - name: update-source-raw-configuration description: Update a Source from Raw Configuration hints: readOnly: false destructive: false idempotent: true call: source-sources.updaterawsource with: organizationId: tools.organizationId sourceId: tools.sourceId updateSecurityProviders: tools.updateSecurityProviders rebuild: tools.rebuild body: tools.body outputParameters: - type: object mapping: $. - name: apply-rebuild-operation-source description: Apply a Rebuild Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.rebuild with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: resume-current-refresh-operation-source description: Resume the Current Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.resumerefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: get-all-source-schedules description: Get All Source Schedules hints: readOnly: true destructive: false idempotent: true call: source-sources.getsourceschedules with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: create-new-schedule-source description: Create a New Schedule for the Source hints: readOnly: false destructive: false idempotent: false call: source-sources.createsourceschedule with: organizationId: tools.organizationId sourceId: tools.sourceId body: tools.body outputParameters: - type: object mapping: $. - name: get-source-schedule description: Get a Source Schedule hints: readOnly: true destructive: false idempotent: true call: source-sources.getsourceschedule with: organizationId: tools.organizationId sourceId: tools.sourceId scheduleId: tools.scheduleId outputParameters: - type: object mapping: $. - name: update-source-schedule description: Update a Source Schedule hints: readOnly: false destructive: false idempotent: true call: source-sources.updatesourceschedule with: organizationId: tools.organizationId sourceId: tools.sourceId scheduleId: tools.scheduleId body: tools.body outputParameters: - type: object mapping: $. - name: delete-source-schedule description: Delete a Source Schedule hints: readOnly: false destructive: true idempotent: true call: source-sources.deletesourceschedule with: organizationId: tools.organizationId sourceId: tools.sourceId scheduleId: tools.scheduleId outputParameters: - type: object mapping: $. - name: start-refresh-operation-source description: Start a Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.startrefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: stop-current-refresh-operation-source description: Stop the Current Refresh Operation on a Source hints: readOnly: false destructive: false idempotent: false call: source-sources.stoprefresh with: organizationId: tools.organizationId sourceId: tools.sourceId outputParameters: - type: object mapping: $. - name: abort-source-task-related-given description: Abort a Source Task Related to a Given Activity. hints: readOnly: false destructive: false idempotent: false call: source-sources.aborttaskforactivity with: organizationId: tools.organizationId sourceId: tools.sourceId activityId: tools.activityId outputParameters: - type: object mapping: $.