naftiko: 1.0.0-alpha2
info:
label: Coveo Source API — Mappings
description: 'Coveo Source API — Mappings. 22 operations. Lead operation: Show Mapping Configuration. Self-contained Naftiko
capability covering one Coveo business surface.'
tags:
- Coveo
- Source
- Mappings
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
COVEO_API_KEY: COVEO_API_KEY
capability:
consumes:
- type: http
namespace: source-mappings
baseUri: https://platform.cloud.coveo.com
description: Coveo Source API — Mappings business capability. Self-contained, no shared references.
authentication:
type: bearer
token: '{{env.COVEO_API_KEY}}'
resources:
- name: rest-organizations-organizationId-sources-sourceId-mappings
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings
operations:
- name: getmappingsconfiguration
method: GET
description: Show Mapping Configuration
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: updatemappingsconfiguration
method: PUT
description: Update Mapping Configuration
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-batch-create
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/create
operations:
- name: addmappingtypesbatch
method: POST
description: Create Mapping Rules in Batch
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-batch-delete
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/delete
operations:
- name: deletemappingtypesbatch
method: POST
description: Delete Mapping Rules in Batch
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-batch-update
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/update
operations:
- name: updatemappingtypesbatch
method: POST
description: Update Mapping Rules in Batch
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-common
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/common
operations:
- name: getcommonmappingsettings
method: GET
description: List Common Mappings
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: updatecommonmappingsettings
method: PUT
description: Update Common Mappings
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-common-rules
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules
operations:
- name: getcommonmappingsettingsrules
method: GET
description: List Common Mapping Rules
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: addcommonmappingsettingsrule
method: POST
description: Create Common Mapping Rule
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-common-rules-ruleId
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules/{ruleId}
operations:
- name: getcommonmappingsettingsrule
method: GET
description: Show Common Mapping Rule
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: ruleId
in: path
type: string
description: The unique identifier of the mapping rule to show.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
- name: updatecommonmappingsettingsrule
method: PUT
description: Update Common Mapping Rule
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: ruleId
in: path
type: string
description: The unique identifier of the mapping rule to update.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletecommonmappingsettingsrule
method: DELETE
description: Delete Common Mapping Rule
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: ruleId
in: path
type: string
description: The unique identifier of the mapping rule to delete.
**Example:** `teghteb76mvjttvufmxecasmzy`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: rest-organizations-organizationId-sources-sourceId-mappings-types
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/types
operations:
- name: getmappingtypes
method: GET
description: List Specific Mappings
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: addmappingtypes
method: POST
description: Create Specific Mapping
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: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-types-typeId
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}
operations:
- name: getmappingtypesettings
method: GET
description: List Specific Mappings of Given Type
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: typeId
in: path
type: string
description: The specific [mapping](https://docs.coveo.com/en/217/) type to show.
**Example:** `Video`
required: true
- name: updatemappingtypesettings
method: PUT
description: Update Specific Mappings of Given Type
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: typeId
in: path
type: string
description: The specific [mapping](https://docs.coveo.com/en/217/) type to update.
**Example:** `Video`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletemappingtype
method: DELETE
description: Delete Specific Mappings of Given Type
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: typeId
in: path
type: string
description: The specific [mapping](https://docs.coveo.com/en/217/) item type to delete.
**Example:** `Video`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: rest-organizations-organizationId-sources-sourceId-mappings-types-typeId-rules
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules
operations:
- name: getmappingtypesettingrules
method: GET
description: List Specific Mapping Rules of Given Type
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: typeId
in: path
type: string
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) [item](https://docs.coveo.com/en/210/)
type to show.
**Example:** `Video`
required: true
- name: addmappingtypesettingrule
method: POST
description: Create Specific Mapping Rule of Given Type
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: typeId
in: path
type: string
description: The type of specific [mapping](https://docs.coveo.com/en/217/) rule to create.
**Example:** `Video`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: rest-organizations-organizationId-sources-sourceId-mappings-types-typeId-rules-r
path: /rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules/{ruleId}
operations:
- name: getmappingtypesettingsrule
method: GET
description: Show Specific Mapping Rule
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: typeId
in: path
type: string
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
- name: ruleId
in: path
type: string
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to show.
**Example:**
`wb74lavk6rmbjol3wqhamdspbi`
required: true
- name: updatemappingtypesettingsrule
method: PUT
description: Update Specific Mapping Rule
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: typeId
in: path
type: string
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
- name: ruleId
in: path
type: string
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to update.
**Example:** `wb74lavk6rmbjol3wqhamdspbi`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deletemappingtypesettingsrule
method: DELETE
description: Delete Specific Mapping Rule
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: typeId
in: path
type: string
description: The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`
required: true
- name: ruleId
in: path
type: string
description: The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to delete.
**Example:** `wb74lavk6rmbjol3wqhamdspbi`
required: true
- name: rebuild
in: query
type: boolean
description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:**
`false`
exposes:
- type: rest
namespace: source-mappings-rest
port: 8080
description: REST adapter for Coveo Source API — Mappings. One Spectral-compliant resource per consumed operation, prefixed
with /v1.
resources:
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings
name: rest-organizations-organizationid-sources-sourceid-mappings
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings.
operations:
- method: GET
name: getmappingsconfiguration
description: Show Mapping Configuration
call: source-mappings.getmappingsconfiguration
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatemappingsconfiguration
description: Update Mapping Configuration
call: source-mappings.updatemappingsconfiguration
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/create
name: rest-organizations-organizationid-sources-sourceid-mappings-batch-create
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-batch-create.
operations:
- method: POST
name: addmappingtypesbatch
description: Create Mapping Rules in Batch
call: source-mappings.addmappingtypesbatch
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/delete
name: rest-organizations-organizationid-sources-sourceid-mappings-batch-delete
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-batch-delete.
operations:
- method: POST
name: deletemappingtypesbatch
description: Delete Mapping Rules in Batch
call: source-mappings.deletemappingtypesbatch
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/update
name: rest-organizations-organizationid-sources-sourceid-mappings-batch-update
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-batch-update.
operations:
- method: POST
name: updatemappingtypesbatch
description: Update Mapping Rules in Batch
call: source-mappings.updatemappingtypesbatch
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/common
name: rest-organizations-organizationid-sources-sourceid-mappings-common
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-common.
operations:
- method: GET
name: getcommonmappingsettings
description: List Common Mappings
call: source-mappings.getcommonmappingsettings
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatecommonmappingsettings
description: Update Common Mappings
call: source-mappings.updatecommonmappingsettings
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules
name: rest-organizations-organizationid-sources-sourceid-mappings-common-rules
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-common-rules.
operations:
- method: GET
name: getcommonmappingsettingsrules
description: List Common Mapping Rules
call: source-mappings.getcommonmappingsettingsrules
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
outputParameters:
- type: object
mapping: $.
- method: POST
name: addcommonmappingsettingsrule
description: Create Common Mapping Rule
call: source-mappings.addcommonmappingsettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules/{ruleid}
name: rest-organizations-organizationid-sources-sourceid-mappings-common-rules-ruleid
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-common-rules-ruleId.
operations:
- method: GET
name: getcommonmappingsettingsrule
description: Show Common Mapping Rule
call: source-mappings.getcommonmappingsettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
ruleId: rest.ruleId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatecommonmappingsettingsrule
description: Update Common Mapping Rule
call: source-mappings.updatecommonmappingsettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
ruleId: rest.ruleId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletecommonmappingsettingsrule
description: Delete Common Mapping Rule
call: source-mappings.deletecommonmappingsettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
ruleId: rest.ruleId
rebuild: rest.rebuild
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/types
name: rest-organizations-organizationid-sources-sourceid-mappings-types
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-types.
operations:
- method: GET
name: getmappingtypes
description: List Specific Mappings
call: source-mappings.getmappingtypes
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
outputParameters:
- type: object
mapping: $.
- method: POST
name: addmappingtypes
description: Create Specific Mapping
call: source-mappings.addmappingtypes
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}
name: rest-organizations-organizationid-sources-sourceid-mappings-types-typeid
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-types-typeId.
operations:
- method: GET
name: getmappingtypesettings
description: List Specific Mappings of Given Type
call: source-mappings.getmappingtypesettings
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatemappingtypesettings
description: Update Specific Mappings of Given Type
call: source-mappings.updatemappingtypesettings
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletemappingtype
description: Delete Specific Mappings of Given Type
call: source-mappings.deletemappingtype
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
rebuild: rest.rebuild
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules
name: rest-organizations-organizationid-sources-sourceid-mappings-types-typeid-rules
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-types-typeId-rules.
operations:
- method: GET
name: getmappingtypesettingrules
description: List Specific Mapping Rules of Given Type
call: source-mappings.getmappingtypesettingrules
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
outputParameters:
- type: object
mapping: $.
- method: POST
name: addmappingtypesettingrule
description: Create Specific Mapping Rule of Given Type
call: source-mappings.addmappingtypesettingrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules/{ruleid}
name: rest-organizations-organizationid-sources-sourceid-mappings-types-typeid-rules-r
description: REST surface for rest-organizations-organizationId-sources-sourceId-mappings-types-typeId-rules-r.
operations:
- method: GET
name: getmappingtypesettingsrule
description: Show Specific Mapping Rule
call: source-mappings.getmappingtypesettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
ruleId: rest.ruleId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updatemappingtypesettingsrule
description: Update Specific Mapping Rule
call: source-mappings.updatemappingtypesettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
ruleId: rest.ruleId
rebuild: rest.rebuild
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deletemappingtypesettingsrule
description: Delete Specific Mapping Rule
call: source-mappings.deletemappingtypesettingsrule
with:
organizationId: rest.organizationId
sourceId: rest.sourceId
typeId: rest.typeId
ruleId: rest.ruleId
rebuild: rest.rebuild
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: source-mappings-mcp
port: 9090
transport: http
description: MCP adapter for Coveo Source API — Mappings. One tool per consumed operation, routed inline through this
capability's consumes block.
tools:
- name: show-mapping-configuration
description: Show Mapping Configuration
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getmappingsconfiguration
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
outputParameters:
- type: object
mapping: $.
- name: update-mapping-configuration
description: Update Mapping Configuration
hints:
readOnly: false
destructive: false
idempotent: true
call: source-mappings.updatemappingsconfiguration
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: create-mapping-rules-batch
description: Create Mapping Rules in Batch
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.addmappingtypesbatch
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: delete-mapping-rules-batch
description: Delete Mapping Rules in Batch
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.deletemappingtypesbatch
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: update-mapping-rules-batch
description: Update Mapping Rules in Batch
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.updatemappingtypesbatch
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: list-common-mappings
description: List Common Mappings
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getcommonmappingsettings
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
outputParameters:
- type: object
mapping: $.
- name: update-common-mappings
description: Update Common Mappings
hints:
readOnly: false
destructive: false
idempotent: true
call: source-mappings.updatecommonmappingsettings
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: list-common-mapping-rules
description: List Common Mapping Rules
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getcommonmappingsettingsrules
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
outputParameters:
- type: object
mapping: $.
- name: create-common-mapping-rule
description: Create Common Mapping Rule
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.addcommonmappingsettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: show-common-mapping-rule
description: Show Common Mapping Rule
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getcommonmappingsettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
ruleId: tools.ruleId
outputParameters:
- type: object
mapping: $.
- name: update-common-mapping-rule
description: Update Common Mapping Rule
hints:
readOnly: false
destructive: false
idempotent: true
call: source-mappings.updatecommonmappingsettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
ruleId: tools.ruleId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: delete-common-mapping-rule
description: Delete Common Mapping Rule
hints:
readOnly: false
destructive: true
idempotent: true
call: source-mappings.deletecommonmappingsettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
ruleId: tools.ruleId
rebuild: tools.rebuild
outputParameters:
- type: object
mapping: $.
- name: list-specific-mappings
description: List Specific Mappings
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getmappingtypes
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
outputParameters:
- type: object
mapping: $.
- name: create-specific-mapping
description: Create Specific Mapping
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.addmappingtypes
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: list-specific-mappings-given-type
description: List Specific Mappings of Given Type
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getmappingtypesettings
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
outputParameters:
- type: object
mapping: $.
- name: update-specific-mappings-given-type
description: Update Specific Mappings of Given Type
hints:
readOnly: false
destructive: false
idempotent: true
call: source-mappings.updatemappingtypesettings
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: delete-specific-mappings-given-type
description: Delete Specific Mappings of Given Type
hints:
readOnly: false
destructive: true
idempotent: true
call: source-mappings.deletemappingtype
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
rebuild: tools.rebuild
outputParameters:
- type: object
mapping: $.
- name: list-specific-mapping-rules-given
description: List Specific Mapping Rules of Given Type
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getmappingtypesettingrules
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
outputParameters:
- type: object
mapping: $.
- name: create-specific-mapping-rule-given
description: Create Specific Mapping Rule of Given Type
hints:
readOnly: false
destructive: false
idempotent: false
call: source-mappings.addmappingtypesettingrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: show-specific-mapping-rule
description: Show Specific Mapping Rule
hints:
readOnly: true
destructive: false
idempotent: true
call: source-mappings.getmappingtypesettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
ruleId: tools.ruleId
outputParameters:
- type: object
mapping: $.
- name: update-specific-mapping-rule
description: Update Specific Mapping Rule
hints:
readOnly: false
destructive: false
idempotent: true
call: source-mappings.updatemappingtypesettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
ruleId: tools.ruleId
rebuild: tools.rebuild
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: delete-specific-mapping-rule
description: Delete Specific Mapping Rule
hints:
readOnly: false
destructive: true
idempotent: true
call: source-mappings.deletemappingtypesettingsrule
with:
organizationId: tools.organizationId
sourceId: tools.sourceId
typeId: tools.typeId
ruleId: tools.ruleId
rebuild: tools.rebuild
outputParameters:
- type: object
mapping: $.