{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Projects 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": "Projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              }
            ]
          },
          "docs": "Gets a project for a given organization.</br>**Required privilege:**` Projects - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a project for a given organization.</br>**Required privilege:**` Projects - Edit`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              }
            ]
          },
          "docs": "Deletes a project for a given organization.</br>**Required privilege:**` Projects - Edit`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Add a Single Resource to a Project.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId/resources/:resourceType/:resourceId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "path",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a [resource](https://docs.coveo.com/2820)."
              }
            ]
          },
          "docs": "Add a single resource to a project.</br>**Required privileges:**` Projects - Edit` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Remove a Specific Resource from a Project.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId/resources/:resourceType/:resourceId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "path",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a [resource](https://docs.coveo.com/2820)."
              }
            ]
          },
          "docs": "Remove a specific resource from a project.</br>**Required privileges:**` Projects - Edit` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The text to filter projects by (applied to the project id, name, and pointsOfContact properties).<br/>**Example:** `Project123`"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The property to sort the results by.<br/>**Example:** `NAME`"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sorting order of the results.<br/>**Default:** `DESC`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the results page to fetch.<br/>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to fetch per page.<br/>**Default:** `50`"
              }
            ]
          },
          "docs": "Gets projects for a given organization.</br>**Required privilege:**` Projects - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a project for a given organization.</br>**Required privilege:**` Projects - Create`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Set the Project Ids Associated with Provided Resource of Type.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/resources/:resourceId/projectids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "query",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a [resource](https://docs.coveo.com/2820)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the project ids associated with provided resource of type. Body must be an array, use an empty array to clear projectIds.</br>**Required privileges:**` Projects - Edit` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Resources of Specified Type Within a Project.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/resources/ids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "query",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/)."
              }
            ]
          },
          "docs": "Get resources of specified type within a project.</br>**Required privileges:**` Projects - View` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Project Ids Associated with Provided Resource Ids and Type.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/resources/ids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "query",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get project ids associated with provided resource ids and type.</br>**Required privileges:**` Projects - View` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Resource Ids Grouped by Resource Status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId/resources",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              }
            ]
          },
          "docs": "Gets resource ids grouped by resource status for a given project.</br>**Required privileges:**` Projects - View` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Resource Details by Type.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId/resources/:resourceType",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "path",
                "description": "The type of the [resource](https://docs.coveo.com/2820).<br/>**Example:** `SOURCE`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The text to filter resources by (applied to the resource id and name properties).<br/>**Example:** `My Web source`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the results page to fetch.<br/>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to fetch per page.<br/>**Default:** `50`"
              }
            ]
          },
          "docs": "Gets resource details by resource type for a given project.</br>**Required privileges:**` Projects - View` and `{resourceType} - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get All Resource Ids of Specified Type Within a Project.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/:projectId/resources/:resourceType/ids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/).<br/>**Example:** `uwthtvihpqjbzktjdfexk3covi`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "path",
                "description": "The type of the [resource](https://docs.coveo.com/2820).<br/>**Example:** `SOURCE`"
              }
            ]
          },
          "docs": "Get all resource ids of specified type within a project.</br>**Required privileges:**` Projects - View` and `{resourceType} - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Paginated Resources of Specified Type Within a Project.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/projects/resources/ids/page",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [Coveo organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`"
              },
              {
                "name": "resourceType",
                "value": "",
                "type": "query",
                "description": "The type of the [resource](https://docs.coveo.com/2820)."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the [project](https://docs.coveo.com/n7ed6189/)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the results page to fetch.<br/>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to fetch per page.<br/>**Default:** `50`"
              }
            ]
          },
          "docs": "Get paginated resources of specified type within a project.</br>**Required privileges:**` Projects - View` and `Resource types - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"PROJECTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}