{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Statement groups 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": "Statement groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Statement Groups of a Pipeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of results to get."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include per page."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)"
              },
              {
                "name": "isOrderAscending",
                "value": "",
                "type": "query",
                "description": "Whether to sort the results in ascending order."
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "The type name of the statement group."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the statement group."
              }
            ],
            "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": "List statement groups of a pipeline\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a New Statement Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Create a new statement group\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Dissociate Pipeline Rules Associated to Groups",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Statement Groups of a Pipeline",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of results to get."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include per page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "List statement groups of a pipeline\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Validate a Single Statement Group Operation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Validate that a specific operation would be accepted by our API and executed.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Validate a Batch of Statement Groups Operations.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "\nValidate that a list of operations would be accepted by our API and executed.\nA maximum of 15 can be processed per request.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Returns the List of All Pipeline Features and Whether They're Active or Not.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/admin/pipelines/featureActiveState",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization."
              }
            ],
            "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": "<details>\n<summary>Privilege(s) required</summary>\n\n```json\n\n```\n</details>"
        },
        {
          "info": {
            "name": "Get a Statement Group of a Pipeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the statement group."
              }
            ],
            "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": "Get a statement group of a pipeline\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Statement Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the statement group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Update a statement group\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Toggle a Permanent Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the statement group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "Toggle a permanent group\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete a Statement Group of a Pipeline",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the statement group."
              }
            ],
            "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": "Delete a statement group of a pipeline\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update the Rules Associated with a Statement Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "query",
                "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the statement group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "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": "There are two operations which can update the rules associated with a statement group:\n\n- **Addition** uses the `toAdd` parameter\n- **Deletion** uses the `toRemove` parameter\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}