{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Item 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": "Item",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add or Update an Item",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/sources/:sourceId/documents",
            "params": [
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)).  \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)).  \n**Example:** `file://folder/my-file.html`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "compressionType",
                "value": "",
                "type": "query",
                "description": "The algorithm that was used to compress the item data.  \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)).  \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`.  \n**Example:** `ZLib`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Adds or updates an individual item in a Push source."
        },
        {
          "info": {
            "name": "Delete an Item and Optionally Its Children",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/sources/:sourceId/documents",
            "params": [
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              },
              {
                "name": "deleteChildren",
                "value": "",
                "type": "query",
                "description": "Whether to also delete the children of the item."
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)).  \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)).  \n**Example:** `file://folder/my-file.html`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Deletes a specific item from a Push source. Optionally, the items of that item can also be deleted."
        },
        {
          "info": {
            "name": "Add, Update, and/or Delete a Batch of Items",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/sources/:sourceId/documents/batch",
            "params": [
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)).  \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)).  \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Manages a batch of items in a Push source."
        },
        {
          "info": {
            "name": "Delete Old Items",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/sources/:sourceId/documents/olderthan",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)).  \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source.  \n**Example:** `1506700606240`"
              },
              {
                "name": "queueDelay",
                "value": "",
                "type": "query",
                "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes.  \n**Example:** `5`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "In a specific Push source, deletes all items whose last update was made by a Push API operation whose `orderingId` is strictly lower than a specified value."
        }
      ]
    }
  ],
  "bundled": true
}