{
  "info": {
    "_postman_id": "0cca6fe7-0a7a-4c70-a06b-09f7e51e50c8",
    "name": "Data Pipeline Export Resource",
    "description": "Experimental Data Pipeline API. Report the current status of Data Pipeline processes on the host Data Center application. The root path is /rest/datapipeline/latest",
    "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
  },
  "item": [
    {
      "name": "Export",
      "item": [
        {
          "name": "Get export status",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}export",
              "query": [],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Returns the status of the export in progress, or most recent export if there is no export in progress.\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Trigger an export",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}export",
              "query": [
                {
                  "key": "fromDate",
                  "value": "{{fromDate}}",
                  "disabled": true,
                  "description": "The start date and time in ISO 8601 format `yyyy-MM-ddTHH:mmTZD`. For example, `2020-12-30T23:01Z` or `2020-12-30T22:01+01:00` (for this format you will need to use URL encoding in your request, for example `2020-12-30T22%3A03%2B01%3A00`). Data from before this date will not be included in the export."
                },
                {
                  "key": "forceExport",
                  "value": "{{forceExport}}",
                  "disabled": true,
                  "description": "Ignore inconsistent index warning, and force export even if data is not up to date."
                },
                {
                  "key": "schemaVersion",
                  "value": "{{schemaVersion}}",
                  "disabled": true,
                  "description": "Schema version to use for the export. Overrides the default schema version number."
                }
              ],
              "variable": []
            },
            "method": "POST",
            "header": [],
            "description": "Exports the full data set from your Data Center application. \n\nThe export will start immediately, and includes data for the timeframe specified, or from the last 365 days if a `fromDate` is not specified.  \n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Cancel an export",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}export",
              "query": [
                {
                  "key": "jobId",
                  "value": "{{jobId}}",
                  "disabled": true,
                  "description": "Request cancellation of a specific job. If blank the latest job will be cancelled."
                }
              ],
              "variable": []
            },
            "method": "DELETE",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Cancels the current export. If the export process was killed due to a crash, you will need to manually cancel it before you can trigger a new export.\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Config",
      "item": [
        {
          "name": "Get current export path",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/export-path",
              "query": [],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Return the current export path. This is the directory that the data pipeline will write files to. \n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        },
        {
          "name": "Change export path",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/export-path",
              "query": [],
              "variable": []
            },
            "method": "PUT",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Create or update a custom export path. This is the directory that the data pipeline will write files to.\n\nIn the body of the request pass the absolute path to your preferred directory, for example:\n\n```\n{\n  \"path\": \"/tmp/new/path\"\n}\n```\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        },
        {
          "name": "Revert to default export path",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/export-path",
              "query": [],
              "variable": []
            },
            "method": "DELETE",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Delete the custom export path and revert to the default path. This is the path that the data pipeline will export files to.\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Get current export schedule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/schedule",
              "query": [],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Administrators can schedule regular exports. Get the details of the current export schedule, if a schedule exists.\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Create or update export schedule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/schedule",
              "query": [],
              "variable": []
            },
            "method": "PUT",
            "header": [],
            "description": "Administrators can schedule regular exports. Create a new export schedule or update the current export schedule.\n\nIn the body of the request pass the date and time intervals and export parameters, as follows:\n\n```\n{\n \"days\": [\"sun\", \"tue\"],\n \"time\": \"00:00:00\",\n \"repeatIntervalInWeeks\": 3,\n \"fromDate\": \"2020-07-26T11:14:00Z\",\n \"schemaVersion\": 2\n}\n```\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        },
        {
          "name": "Delete export schedule",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/schedule",
              "query": [],
              "variable": []
            },
            "method": "DELETE",
            "header": [],
            "description": "Turn off scheduled exports, and delete the current export schedule. \n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        },
        {
          "name": "Get schema versions",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/schema",
              "query": [],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Get a list of all supported schema versions.\n\nThe export schema defines the structure of the export. We only introduce new schema versions for breaking changes, \nsuch as removing a field, or if the way the data is structured changes. New fields are simply added to the latest schema version. \nOlder schema versions will be marked as `deprecated`, and may be removed in future versions. You can still export \nusing these versions, just be aware we won’t update them with any new fields.\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured."
          },
          "response": []
        },
        {
          "name": "Get opt-out list",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/optout",
              "query": [],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Return the list of entities (projects or spaces) that will be excluded from the export.\n\nAdministrators can choose to exclude particular Jira projects, Confluence spaces, and Bitbucket projects \nfrom the export by adding these spaces to the opt-out list. \n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Add entities to opt-out list",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/optout",
              "query": [
                {
                  "key": "continueIfNotFound",
                  "value": "{{continueIfNotFound}}",
                  "disabled": true,
                  "description": "Continue to add entities to the list if one or more are not found."
                }
              ],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Exclude specific entities (projects or spaces) from the export by adding them to the opt-out list.\n\nIn the body of the request pass the project keys (Jira and Bitbucket) or space keys (Confluence) to exclude, for example:\n\n```\n{\n  \"type\": \"PROJECT\",\n  \"keys\": [\"IT\",\"BUGS\",\"TEST\"]\n}\n```\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        },
        {
          "name": "Remove entities from opt-out list",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}config/optout",
              "query": [
                {
                  "key": "continueIfNotFound",
                  "value": "{{continueIfNotFound}}",
                  "disabled": true,
                  "description": "Continue to delete entities from the list if one or more are not found."
                }
              ],
              "variable": []
            },
            "method": "DELETE",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Remove specific entities (projects or spaces) from the opt-out list. Once removed from the list, these \nentities will be included in the next export.\n\nIn the body of the request pass the `PROJECT` keys (Jira and Bitbucket) or `SPACE` keys (Confluence) to remove, for example:\n\n```\n{\n  \"type\": \"SPACE\",\n  \"keys\": [\"DESIGN\",\"HR\"]\n}\n```\n\nIn the examples below, substitute `https://your-domain.atlassian.net/` with the Data Center URL \n`https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. \nRemember to include your context path if you have one configured. "
          },
          "response": []
        }
      ]
    }
  ],
  "variable": [
    {
      "key": "protocol",
      "name": "Protocol",
      "description": "The HTTP Protocol that should be used for this REST API.",
      "type": "string",
      "value": "https"
    },
    {
      "key": "host",
      "name": "Host",
      "description": "The HTTP host that should be used for this REST API.",
      "type": "string",
      "value": "api.atlassian.com"
    },
    {
      "key": "basePath",
      "name": "Base Path",
      "description": "The path, after the host, of the base of the REST API.",
      "type": "string",
      "value": ""
    }
  ]
}