Coveo · Capability

Coveo Source API — Mappings

Coveo Source API — Mappings. 22 operations. Lead operation: Show Mapping Configuration. Self-contained Naftiko capability covering one Coveo business surface.

Run with Naftiko CoveoSourceMappings

What You Can Do

GET
Getmappingsconfiguration — Show Mapping Configuration
/v1/organizations/{organizationid}/sources/{sourceid}/mappings
PUT
Updatemappingsconfiguration — Update Mapping Configuration
/v1/organizations/{organizationid}/sources/{sourceid}/mappings
POST
Addmappingtypesbatch — Create Mapping Rules in Batch
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/create
POST
Deletemappingtypesbatch — Delete Mapping Rules in Batch
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/delete
POST
Updatemappingtypesbatch — Update Mapping Rules in Batch
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/batch/update
GET
Getcommonmappingsettings — List Common Mappings
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common
PUT
Updatecommonmappingsettings — Update Common Mappings
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common
GET
Getcommonmappingsettingsrules — List Common Mapping Rules
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules
POST
Addcommonmappingsettingsrule — Create Common Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules
GET
Getcommonmappingsettingsrule — Show Common Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules/{ruleid}
PUT
Updatecommonmappingsettingsrule — Update Common Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules/{ruleid}
DELETE
Deletecommonmappingsettingsrule — Delete Common Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/common/rules/{ruleid}
GET
Getmappingtypes — List Specific Mappings
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types
POST
Addmappingtypes — Create Specific Mapping
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types
GET
Getmappingtypesettings — List Specific Mappings of Given Type
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}
PUT
Updatemappingtypesettings — Update Specific Mappings of Given Type
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}
DELETE
Deletemappingtype — Delete Specific Mappings of Given Type
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}
GET
Getmappingtypesettingrules — List Specific Mapping Rules of Given Type
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules
POST
Addmappingtypesettingrule — Create Specific Mapping Rule of Given Type
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules
GET
Getmappingtypesettingsrule — Show Specific Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules/{ruleid}
PUT
Updatemappingtypesettingsrule — Update Specific Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules/{ruleid}
DELETE
Deletemappingtypesettingsrule — Delete Specific Mapping Rule
/v1/organizations/{organizationid}/sources/{sourceid}/mappings/types/{typeid}/rules/{ruleid}

MCP Tools

show-mapping-configuration

Show Mapping Configuration

read-only idempotent
update-mapping-configuration

Update Mapping Configuration

idempotent
create-mapping-rules-batch

Create Mapping Rules in Batch

delete-mapping-rules-batch

Delete Mapping Rules in Batch

update-mapping-rules-batch

Update Mapping Rules in Batch

list-common-mappings

List Common Mappings

read-only idempotent
update-common-mappings

Update Common Mappings

idempotent
list-common-mapping-rules

List Common Mapping Rules

read-only idempotent
create-common-mapping-rule

Create Common Mapping Rule

show-common-mapping-rule

Show Common Mapping Rule

read-only idempotent
update-common-mapping-rule

Update Common Mapping Rule

idempotent
delete-common-mapping-rule

Delete Common Mapping Rule

idempotent
list-specific-mappings

List Specific Mappings

read-only idempotent
create-specific-mapping

Create Specific Mapping

list-specific-mappings-given-type

List Specific Mappings of Given Type

read-only idempotent
update-specific-mappings-given-type

Update Specific Mappings of Given Type

idempotent
delete-specific-mappings-given-type

Delete Specific Mappings of Given Type

idempotent
list-specific-mapping-rules-given

List Specific Mapping Rules of Given Type

read-only idempotent
create-specific-mapping-rule-given

Create Specific Mapping Rule of Given Type

show-specific-mapping-rule

Show Specific Mapping Rule

read-only idempotent
update-specific-mapping-rule

Update Specific Mapping Rule

idempotent
delete-specific-mapping-rule

Delete Specific Mapping Rule

idempotent

Capability Spec

source-mappings.yaml Raw ↑
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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: ruleId
          in: path
          type: string
          description: The unique identifier of the mapping rule to show.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: ruleId
          in: path
          type: string
          description: The unique identifier of the mapping rule to update.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: ruleId
          in: path
          type: string
          description: The unique identifier of the mapping rule to delete.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: typeId
          in: path
          type: string
          description: The specific [mapping](https://docs.coveo.com/en/217/) type to show.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: typeId
          in: path
          type: string
          description: The specific [mapping](https://docs.coveo.com/en/217/) type to update.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**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.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: typeId
          in: path
          type: string
          description: The target specific [mapping](https://docs.coveo.com/en/217/) type.<br />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: typeId
          in: path
          type: string
          description: The target specific [mapping](https://docs.coveo.com/en/217/) type.<br />**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.<br
            />**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.<br />**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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
          required: true
        - name: typeId
          in: path
          type: string
          description: The target specific [mapping](https://docs.coveo.com/en/217/) type.<br />**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.<br
            />**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.<br />**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

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-mappings.yaml