{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Dynamic Navigation Experience Configuration 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": "Dynamic Navigation Experience Configuration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Show DNE Model Resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/model/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`"
              }
            ]
          },
          "docs": "Shows resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update DNE Model Resources",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/model/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the configuration of the resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete DNE Model Resources",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/model/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`"
              }
            ]
          },
          "docs": "Deletes resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Parse a Document Extraction Query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/parsedocumentextractionquerymodel",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Parses the query that determines the documents to extract.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create DNE Model Resources",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/model",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Document Extraction Query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/documentextractionquery",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Shows the query that determines the documents to extract.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Parse a Document Extraction Query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/documentextractionquerymodel",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "query",
                "value": "(@filetype OR @category) AND @source==(\"My source\")",
                "type": "query",
                "description": "The query that determines the documents to extract. Use the `POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery` endpoint to generate the proper query.<br />**Example:** `(@filetype OR @category) AND @source==(\"My source\")`"
              }
            ]
          },
          "docs": "Parses the query that determines the documents to extract.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Document Extraction Preview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/documentextractionpreview",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "fields",
                "value": "filetype,category",
                "type": "query",
                "description": "The names of the fields to consider for the document extraction preview. Documents for which at least one of these fields is defined will be included in the preview.<br />**Example:** `filetype,category`"
              },
              {
                "name": "maximumNumberOfSources",
                "value": "",
                "type": "query",
                "description": "The maximum number of sources to return.<br />**Example:** `10`"
              },
              {
                "name": "viewAllContent",
                "value": "",
                "type": "query",
                "description": "Whether to allow the preview to include secured documents."
              }
            ]
          },
          "docs": "Shows information about the documents to be extracted.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nAND\n{\"owner\":\"SEARCH_API\",\"targetDomain\":\"VIEW_ALL_CONTENT\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/configuration/dne/autoselectionfieldcandidates",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A substring that must appear in the `name` property of a [field](https://docs.coveo.com/en/200/) in order for this field to be included in the results.<br />**Example:** `author`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of results to list.<br />Minimum: `0`<br />**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to include per page.<br />**Must be in range:** `[1, 1000]`<br />**Default:** `100`"
              }
            ]
          },
          "docs": "Retrieves a filtered and paginated list of [fields](https://docs.coveo.com/en/200/) from the [index](https://docs.coveo.com/en/204/) of the target Coveo Cloud [organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Fields - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}