{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Mappings API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Mappings", "type": "folder" }, "items": [ { "info": { "name": "Show Mapping Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "docs": "Shows the [mapping](https://docs.coveo.com/en/217/) configuration of a [source](https://docs.coveo.com/en/246/).
See [Managing the Mapping Configuration of a Source](https://docs.coveo.com/en/29/).
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Mapping Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the [mapping](https://docs.coveo.com/en/217/) configuration of a [source](https://docs.coveo.com/en/246/).
See [Managing the Mapping Configuration of a Source](https://docs.coveo.com/en/29/).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "List Specific Mappings of Given Type", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The specific [mapping](https://docs.coveo.com/en/217/) type to show.
**Example:** `Video`" } ] }, "docs": "Lists the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Specific Mappings of Given Type", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The specific [mapping](https://docs.coveo.com/en/217/) type to update.
**Example:** `Video`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Delete Specific Mappings of Given Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The specific [mapping](https://docs.coveo.com/en/217/) item type to delete.
**Example:** `Video`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ] }, "docs": "Deletes the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Show Specific Mapping Rule", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to show.
**Example:** `wb74lavk6rmbjol3wqhamdspbi`" } ] }, "docs": "Shows the [mapping](https://docs.coveo.com/en/217/) rules of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Specific Mapping Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to update.
**Example:** `wb74lavk6rmbjol3wqhamdspbi`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Delete Specific Mapping Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The target specific [mapping](https://docs.coveo.com/en/217/) type.
**Example:** `Video`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the specific [mapping](https://docs.coveo.com/en/217/) rule to delete.
**Example:** `wb74lavk6rmbjol3wqhamdspbi`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ] }, "docs": "Deletes a [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "List Common Mappings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "docs": "Lists the common [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/) (i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Common Mappings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the common [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/), (i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Show Common Mapping Rule", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the mapping rule to show.
**Example:** `teghteb76mvjttvufmxecasmzy`" } ] }, "docs": "Shows a common [mapping](https://docs.coveo.com/en/217/) rule (i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Common Mapping Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the mapping rule to update.
**Example:** `teghteb76mvjttvufmxecasmzy`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a common [mapping](https://docs.coveo.com/en/217/) rule (i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Delete Common Mapping Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the mapping rule to delete.
**Example:** `teghteb76mvjttvufmxecasmzy`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ] }, "docs": "Deletes a common [mapping](https://docs.coveo.com/en/217/) rule in a [source](https://docs.coveo.com/en/246/), (i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types.)
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "List Specific Mappings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "docs": "Lists the specific [mappings](https://docs.coveo.com/en/217/) of a [source](https://docs.coveo.com/en/246/) (i.e., the mappings that apply to specific [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Create Specific Mapping", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new specific [mapping](https://docs.coveo.com/en/217/) (i.e., a mapping that applies to a specific [item](https://docs.coveo.com/en/210/) type).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "List Specific Mapping Rules of Given Type", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "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`" } ] }, "docs": "Lists the [mapping](https://docs.coveo.com/en/217/) rules of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Create Specific Mapping Rule of Given Type", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/types/:typeId/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "typeId", "value": "", "type": "path", "description": "The type of specific [mapping](https://docs.coveo.com/en/217/) rule to create.
**Example:** `Video`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new [mapping](https://docs.coveo.com/en/217/) rule of a specific [item](https://docs.coveo.com/en/210/) type.
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "List Common Mapping Rules", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" } ] }, "docs": "Lists the common [mapping](https://docs.coveo.com/en/217/) rules of a [source](https://docs.coveo.com/en/246/) (i.e., the mapping rules that apply to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Create Common Mapping Rule", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/common/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new [source](https://docs.coveo.com/en/246/) common [mapping](https://docs.coveo.com/en/217/) rule (i.e., a mapping rule that applies to all [item](https://docs.coveo.com/en/210/) types).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Update Mapping Rules in Batch", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/batch/update", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Delete Mapping Rules in Batch", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/batch/delete", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" }, { "info": { "name": "Create Mapping Rules in Batch", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/mappings/batch/create", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`" }, { "name": "rebuild", "value": "", "type": "query", "description": "Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.
**Default:** `false`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new [mappings](https://docs.coveo.com/en/217/) in batch for a specific [source](https://docs.coveo.com/en/246/).
**Required privilege:** Sources - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n
" } ] } ], "bundled": true }