/jira
, such as
https://<organization>.atlassian.net
.
https://<organization>.atlassian.net/rest/api/latest/project/<project-key>
,
replacing <organization>
with yours, and replacing <project-key>
with the target project’s key. In the
response, look for the URL https://<organization>.atlassian.net/rest/api/3/project/<project-id>
, where <project-id>
is the target project’s ID.
https://<organization>.atlassian.net/rest/agile/1.0/board?projectKeyOrId=<project-key-or-id>
,
replacing <organization>
with yours, and <project-key-or-id>
with the associated project’s key or ID. In the
response, look for the URL https://<organization>.atlassian.net/rest/agile/1.0/board/<board-id>
, where <board-id>
is the board’s ID.
JIRA_URL
- The site URL for your Jira Data Center installation or Jira Cloud account, represented by --url
(CLI) or url
(Python).
JIRA_USERNAME
- The name or email address of the target user, represented by --username
(CLI) or username
(Python).JIRA_PASSWORD_OR_API_TOKEN
- The user’s password (for password authentication) or API token (for API token authentication), represented by --password
(CLI) or password
(Python).JIRA_PERSONAL_ACCESS_TOKEN
- The user’s personal access token (PAT), represented by --token
(CLI) or token
(Python).--projects
with a comma-delimited list of target project IDs (CLI) or project
with an array of target project IDs (Python).--boards
with a comma-delmited list of target board IDs (CLI) or boards
with an array of target board IDs (Python).--issues
with a comma-delimited list of target issue IDs (CLI) or issues
with an array of target issue IDs (Python).--status-filter
with a comma-delimited list of statuses to filter Jira issues by (CLI) or status_filter
with an array of statuses to filter Jira issues by (Python).--download-attachments
(CLI) or download_attachments=True
(Python) to download attachments from Jira issues.--no-download-attachments
(CLI) or download_attachments=False
(Python) to not download attachments from Jira issues. This is the default behavior.--cloud
(CLI) or cloud=True
(Python) to specify using Jira Cloud. The default is to use Jira Data Center.--no-cloud
(CLI) or cloud=False
(Python) to specify using Jira Data Center. This is the default behavior.--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
--partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_by_api=False
(Python).
Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
--partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.https://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.If you do not have an API key, get one now.If the Unstructured API is self-hosted, the process
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
For details, contact Unstructured Sales at
sales@unstructured.io.