{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities View Definitions 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": "View Definitions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get View Definitions for a Catalog",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/view-definitions",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "catalogId",
"value": "",
"type": "path",
"description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/)."
}
]
},
"docs": "Retrieves the view definitions for a specific catalog. **Required privilege:** Catalogs - View
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update View Definitions for a Catalog",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/view-definitions",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "catalogId",
"value": "",
"type": "path",
"description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the view definitions for a specific catalog. This replaces all existing view definitions.**Required privilege:** Catalogs - Edit
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
}
]
}
],
"bundled": true
}