{"components":{"schemas":{"ConfigExportPathRequest":{"properties":{"path":{"type":"string"}},"type":"object"},"ConfigExportScheduleRequest":{"properties":{"days":{"items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"type":"array"},"fromDate":{"type":"string"},"repeatIntervalInWeeks":{"type":"string"},"schemaVersion":{"type":"string"},"time":{"type":"string"},"zoneId":{"type":"string"}},"type":"object"},"ConfigExportScheduleResponse":{"properties":{"days":{"items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"type":"array"},"fromDate":{"type":"string"},"nextRunTime":{"type":"string"},"repeatIntervalInWeeks":{"format":"int32","type":"integer"},"schema":{"$ref":"#/components/schemas/SchemaResponse"},"time":{"type":"string"},"zoneId":{"type":"string"}},"type":"object"},"DiagnosticDescription":{"properties":{"key":{"type":"string"},"message":{"type":"string"}},"type":"object"},"ErrorStatusResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DiagnosticDescription"},"type":"array"},"message":{"type":"string"},"statusCode":{"format":"int32","type":"integer"},"timestamp":{"type":"string"}},"type":"object"},"OptOutConfigurationResponse":{"properties":{"entitiesNotFound":{"items":{"$ref":"#/components/schemas/OptOutEntityResponse"},"type":"array"},"entitiesProcessed":{"items":{"$ref":"#/components/schemas/OptOutEntityResponse"},"type":"array"}},"type":"object"},"OptOutEntityResponse":{"properties":{"displayName":{"type":"string"},"identifier":{"type":"string"},"key":{"type":"string"},"type":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"OptOutSummaryResponse":{"properties":{"optedOutEntities":{"items":{"$ref":"#/components/schemas/OptOutEntityResponse"},"type":"array"}},"type":"object"},"ProcessStatusConfigResponse":{"properties":{"empty":{"type":"boolean"},"exportFrom":{"type":"string"},"forcedExport":{"type":"boolean"}},"type":"object"},"ProcessStatusResponse":{"properties":{"cancelledTime":{"type":"string"},"completedTime":{"type":"string"},"config":{"$ref":"#/components/schemas/ProcessStatusConfigResponse"},"errors":{"items":{"$ref":"#/components/schemas/DiagnosticDescription"},"type":"array"},"jobId":{"format":"int32","type":"integer"},"nodeId":{"type":"string"},"optedOutEntities":{"items":{"$ref":"#/components/schemas/RestOptedOutEntitiesByType"},"type":"array"},"rootExportPath":{"type":"string"},"schema":{"$ref":"#/components/schemas/SchemaResponse"},"startTime":{"type":"string"},"statistics":{"$ref":"#/components/schemas/ProcessStatusStatisticsResponse"},"status":{"enum":["CANCELLATION_REQUESTED","CANCELLED","COMPLETED","FAILED","STARTED"],"type":"string"},"warnings":{"items":{"$ref":"#/components/schemas/DiagnosticDescription"},"type":"array"}},"type":"object"},"ProcessStatusStatisticsResponse":{"properties":{"empty":{"type":"boolean"},"exportedEntities":{"format":"int32","type":"integer"},"writtenRows":{"format":"int32","type":"integer"}},"type":"object"},"RestOptedOutEntitiesByType":{"properties":{"identifiers":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"SchemaResponse":{"properties":{"status":{"enum":["ACTIVE","DEPRECATED","REMOVED"],"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"}}},"info":{"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","title":"Data Pipeline Export Resource","version":"0.0.0"},"openapi":"3.0.1","paths":{"/export":{"post":{"operationId":"triggerFullExport","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. ","parameters":[{"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.","example":"2019-12-30T22:01+01:00 or 2019-12-30T23:01Z.","in":"query","name":"fromDate","schema":{"format":"date-time","type":"string"}},{"description":"Ignore inconsistent index warning, and force export even if data is not up to date.","in":"query","name":"forceExport","schema":{"default":false,"type":"boolean"}},{"description":"Schema version to use for the export. Overrides the default schema version number.","in":"query","name":"schemaVersion","schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessStatusResponse"}}},"description":"Returned if the export was successfully triggered."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if a bad request was made."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned when the request is unauthorized. You need system administrator permissions."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessStatusResponse"}}},"description":"Returned if the export can't be triggered because another export is currently in progress."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessStatusResponse"}}},"description":"Returned when the export can't be triggered because data is inconsistent."}},"summary":"Trigger an export","tags":["data pipeline"]},"get":{"operationId":"getFullExportStatus","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. ","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessStatusResponse"}}},"description":"Returns the status of the current or most recent export."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the request is forbidden"}},"summary":"Get export status","tags":["data pipeline"]},"delete":{"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.","operationId":"cancelFullExport","parameters":[{"description":"Request cancellation of a specific job. If blank the latest job will be cancelled.","in":"query","name":"jobId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessStatusResponse"}}},"description":"Returns a confirmation that the cancellation has been requested if an export process was running."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Cancel an export","tags":["data pipeline"]}},"/config/export-path":{"delete":{"operationId":"deleteExportPath","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. ","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigExportPathRequest"}}},"description":"Returns the updated export path."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Forbidden"}},"summary":"Revert to default export path","tags":["data pipeline"]},"get":{"operationId":"getExportPath","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.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigExportPathRequest"}}},"description":"Returns the current export path."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Get current export path","tags":["data pipeline"]},"put":{"operationId":"updateExportPath","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.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigExportPathRequest"}}},"description":"Returns details of the updated export path."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if a bad request is made."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Change export path","tags":["data pipeline"]}},"/config/schedule":{"delete":{"operationId":"deleteExportSchedule","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.","responses":{"200":{"description":"Returns confirmation that the schedule was succesfully deleted, if a schedule exists."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Delete export schedule","tags":["data pipeline"]},"get":{"operationId":"getExportSchedule","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. ","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigExportScheduleResponse"}}},"description":"Returns details of the current export schedule if a schedule exists. Returns an empty response if a schedule does not exist."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Get current export schedule","tags":["data pipeline"]},"put":{"operationId":"updateExportSchedule","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.","responses":{"202":{"description":"Returns confirmation that the request to create schedule has been received."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if a bad request is made."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Create or update export schedule","tags":["data pipeline"]}},"/config/schema":{"get":{"operationId":"getSupportedSchemaVersions","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.","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SchemaResponse"},"type":"array"}}},"description":"Returns a list of supported schema versions in descending order."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"empty":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Get schema versions","tags":["data pipeline"]}},"/config/optout":{"get":{"operationId":"getOptOutEntities","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptOutSummaryResponse"}}},"description":"Returns all the entities (projects and spaces) currently in the opt-out list."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Get opt-out list","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. ","tags":["data pipeline"]},"post":{"operationId":"addOptOutEntities","parameters":[{"description":"Continue to add entities to the list if one or more are not found.","in":"query","name":"continueIfNotFound","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptOutConfigurationResponse"}}},"description":"Returns the entities (projects or spaces) that have been added to the opt-out list."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if a bad request is made."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Add entities to opt-out list","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. ","tags":["data pipeline"]},"delete":{"operationId":"removeOptOutEntities","parameters":[{"description":"Continue to delete entities from the list if one or more are not found.","in":"query","name":"continueIfNotFound","schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptOutConfigurationResponse"}}},"description":"Returns the entities (projects or spaces) that have been removed from the opt-out list."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if a bad request is made."},"401":{"content":{"application/json":{"schema":{"items":{"properties":{"allowedMethods":{"items":{"type":"string"},"type":"array","uniqueItems":true},"cookies":{"additionalProperties":{"properties":{"comment":{"type":"string"},"domain":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"httpOnly":{"type":"boolean"},"maxAge":{"format":"int32","type":"integer"},"name":{"type":"string"},"path":{"type":"string"},"secure":{"type":"boolean"},"value":{"type":"string"},"version":{"format":"int32","type":"integer"}},"type":"object"},"type":"object"},"date":{"format":"date-time","type":"string"},"entity":{"type":"object"},"entityTag":{"properties":{"value":{"type":"string"},"weak":{"type":"boolean"}},"type":"object"},"headers":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"language":{"properties":{"country":{"type":"string"},"displayCountry":{"type":"string"},"displayLanguage":{"type":"string"},"displayName":{"type":"string"},"displayScript":{"type":"string"},"displayVariant":{"type":"string"},"extensionKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"iso3Country":{"type":"string"},"iso3Language":{"type":"string"},"language":{"type":"string"},"script":{"type":"string"},"unicodeLocaleAttributes":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unicodeLocaleKeys":{"items":{"type":"string"},"type":"array","uniqueItems":true},"variant":{"type":"string"}},"type":"object"},"lastModified":{"format":"date-time","type":"string"},"length":{"format":"int32","type":"integer"},"links":{"items":{"properties":{"params":{"additionalProperties":{"type":"string"},"type":"object"},"rel":{"type":"string"},"rels":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"},"uri":{"format":"uri","type":"string"},"uriBuilder":{"type":"object"}},"type":"object"},"type":"array","uniqueItems":true},"location":{"format":"uri","type":"string"},"mediaType":{"properties":{"parameters":{"additionalProperties":{"type":"string"},"type":"object"},"subtype":{"type":"string"},"type":{"type":"string"},"wildcardSubtype":{"type":"boolean"},"wildcardType":{"type":"boolean"}},"type":"object"},"metadata":{"additionalProperties":{"items":{"type":"object"},"type":"array"},"type":"object"},"status":{"format":"int32","type":"integer"},"statusInfo":{"properties":{"family":{"enum":["INFORMATIONAL","SUCCESSFUL","REDIRECTION","CLIENT_ERROR","SERVER_ERROR","OTHER"],"type":"string"},"reasonPhrase":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"stringHeaders":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}},"type":"object"},"type":"array"}}},"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorStatusResponse"}}},"description":"Returned if the user does not have the necessary permission."}},"summary":"Remove entities from opt-out list","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. ","tags":["data pipeline"]}}},"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"The data pipeline provides an easy way to export data from your Data Center application (Jira, Confluence, or Bitbucket), and feed it into your existing data platform (like Tableau or PowerBI). Exports can be scheduled through the UI, or via REST. \n\nThere are some performance and security considerations to be aware of, so to learn more about the data pipeline, see:\n* [Data pipeline for Jira Data Center](https://confluence.atlassian.com/display/adminjiraserver/data+pipeline/)\n* [Data pipeline for Confluence Data Center](https://confluence.atlassian.com/display/doc/data+pipeline/)\n* [Data pipeline for Bitbucket Data Center](https://confluence.atlassian.com/display/bitbucketserver/data+pipeline/)"},{"title":"Authentication","anchor":"auth","body":"While you can use basic authentication (username and password), we strongly recommend using personal access tokens for authentication. \n\nSee [Using personal access tokens](https://confluence.atlassian.com/display/ENTERPRISE/Using+Personal+Access+Tokens) for more details."},{"title":"Using the REST API","anchor":"using","body":"The REST API is common to Jira, Bitbucket, and Confluence.\n\n**Requirements**\n\nTo use the data pipeline, you’ll need:\n\n- A Data Center license\n- System admin global permissions for the application\n\n**Special headers**\n\n`X-Atlassian-Token: no-check` request header must be specified for methods\nthat are protected from Cross Site Request Forgery (XSRF/CSRF) attacks. Required for Confluence and Bitbucket.\n\n**Context path**\n\nIf your application is configured to use a context path, such as `/jira` or `/confluence` remember to include this in the request URL. \n\n**Example request**\n\nHere is an example request, using cURL and a personal access token for authentication:\n```\ncurl -H \"Authorization:Bearer ABCD1234\" \n-H \"X-Atlassian-Token: no-check\" \n-X POST https://myexamplesite.com/rest/datapipeline/latest/export?fromDate=2020-10-22T01:30:11Z\n```\n\n**Note:** the examples in the API reference use `https://your-domain.atlassian.net` for the URL. The URL to use for Data Center is `https://myexamplesite.com/rest/datapipeline/latest/` where `myexamplesite` is your domain. "}]}}