{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Catalogs 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": "Catalogs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Show Catalog",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/:catalogId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "catalogId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to show.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`"
              }
            ]
          },
          "docs": "Shows a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Catalog",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/:catalogId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "catalogId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to update.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Catalog",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/:catalogId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "catalogId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to delete.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`"
              }
            ]
          },
          "docs": "Deletes a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Catalogs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter that will be matched against the catalog id, name, description and its configuration name..<br />**Example:** `catalogName`"
              },
              {
                "name": "catalogIds",
                "value": "",
                "type": "query",
                "description": "List of the unique identifiers of the [catalog](https://docs.coveo.com/en/3143/) to show.<br />**Example:** `[644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b]`"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query",
                "description": "List of the unique identifiers of the sources"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of catalogs to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of catalogs to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              },
              {
                "name": "enrichWithFields",
                "value": "",
                "type": "query",
                "description": "If true, catalog will be enriched with field suggestions. This requires a call to SearchAPI"
              },
              {
                "name": "catalogSortingType",
                "value": "",
                "type": "query",
                "description": "The field to sort the returned catalogs by.</br>**Default:** `name`"
              },
              {
                "name": "sortingDirection",
                "value": "",
                "type": "query",
                "description": "The `sortingType` order to list the catalogs in.</br>**Default:** `ASC`"
              }
            ]
          },
          "docs": "Lists the [catalogs](https://docs.coveo.com/en/3143/) of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Catalog",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Catalogs Using Catalog Ids as a Body for Filtering.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/ids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter that will be matched against the catalog id, name, description and its configuration name..<br />**Example:** `catalogName`"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query",
                "description": "List of the unique identifiers of the sources"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of catalogs to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of catalogs to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists the [catalogs](https://docs.coveo.com/en/3143/) of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Suggest Fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/fieldsSuggestions",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Shows suggested fields and sample values for mapping in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Execute Query<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Field Stats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/:catalogId/fieldStats",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "catalogId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [catalog](https://docs.coveo.com/en/3143/)."
              },
              {
                "name": "forceRefresh",
                "value": "",
                "type": "query",
                "description": "If true, the database cache will be refreshed and the most up-to-date fields data returned."
              }
            ]
          },
          "docs": "Retrieve statistics about the usage of fields by objects in the catalog's source.</br></br>**Required privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Catalogs Within Specified Project and According to the Specified Filter.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/catalogs/project",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter that will be matched against the catalog id, name, description and its configuration name..<br />**Example:** `catalogName`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "Id of the project for which we want to retrieve the catalogs"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query",
                "description": "List of the unique identifiers of the sources"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of catalogs to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of catalogs to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              },
              {
                "name": "enrichWithFields",
                "value": "",
                "type": "query",
                "description": "If true, catalog will be enriched with field suggestions. This requires a call to SearchAPI"
              },
              {
                "name": "catalogSortingType",
                "value": "",
                "type": "query",
                "description": "The field to sort the returned catalogs by.</br>**Default:** `name`"
              },
              {
                "name": "sortingDirection",
                "value": "",
                "type": "query",
                "description": "The `sortingType` order to list the catalogs in.</br>**Default:** `ASC`"
              }
            ]
          },
          "docs": "Lists the [catalogs](https://docs.coveo.com/en/3143/) of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}