{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Snapshot Synchronization 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": "Snapshot Synchronization",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Show Synchronization Plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/synchronization/:synchronizationPlanId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`"
              },
              {
                "name": "snapshotId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`"
              },
              {
                "name": "synchronizationPlanId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`"
              }
            ]
          },
          "docs": "Shows a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - View`<br/> - `Link - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"LINK\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Synchronization Plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/synchronization/:synchronizationPlanId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`"
              },
              {
                "name": "snapshotId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`"
              },
              {
                "name": "synchronizationPlanId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> - `Link - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Synchronization Plan Children",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/synchronization/:synchronizationPlanId/children",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`"
              },
              {
                "name": "snapshotId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`"
              },
              {
                "name": "synchronizationPlanId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`"
              },
              {
                "name": "parentResourceType",
                "value": "",
                "type": "query",
                "description": "The `resourceType` of the parent resource.<br/>**Example:** `QUERY_PIPELINE`"
              },
              {
                "name": "snapshotParentResourceName",
                "value": "",
                "type": "query",
                "description": "The `resourceName` of the parent resource.<br/>**Example:** `my_pipeline_aAePCD`"
              },
              {
                "name": "targetParentId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the parent resource in the target organization.<br/>**Example:** `destinationorganizationg7dg3gd-qvml6dkyvouchhehsjhxxbkgqq`"
              }
            ]
          },
          "docs": "Updates child resource associations in a synchronization plan given a target parent association.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> - `Link - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"LINK\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Apply Synchronization Plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/synchronization/:synchronizationPlanId/apply",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`"
              },
              {
                "name": "snapshotId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`"
              },
              {
                "name": "synchronizationPlanId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`"
              },
              {
                "name": "overrideExistingLinks",
                "value": "",
                "type": "query",
                "description": "Whether to use the links in the target synchronization plan to override the ones already existing in the organization if conflicts arise, rather than throwing an error.<br/>**Default:** `false`"
              }
            ]
          },
          "docs": "Applies a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> - `Link - Edit`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"LINK\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Synchronization Plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/synchronization",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`"
              },
              {
                "name": "snapshotId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`"
              }
            ]
          },
          "docs": "Creates a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> - `Link - View`<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"LINK\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}