Jira Reader programmer's reference
Jira Reader properties
Property | Type | Default value | Notes |
---|---|---|---|
API Token | Password | An API token that enables access to the Atlassian platform. Only used with the API token authentication mode. | |
Authentication mode | Select list
|
| Used to connect to a Jira account. |
Client ID | String | Client ID of an app created in the Atlassian developer console. Only used with the OAuth authentication mode. | |
Client secret | Password | The client secret for the app specified by the Client ID. Only used with the OAuth authentication mode. | |
Connection pool size | Integer | 20 | Specifies the number of connections in use. |
Endpoint URL | String | The endpoint URL used to access the Atlassian platform | |
Excluded tables | String |
| A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. |
Incremental load marker | String | Value of the | The incremental load marker is a unique incremental column in each object used for incremental load. |
Migrate schema | Boolean | False | Only available in Initial Load mode. Set to |
Mode | Select list
| Controls the basic behavior of the adapter. Use the default value of Set the value to | |
Polling interval | String | 5m | Specifies an interval as an integer followed by a unit. Supported units are days ( |
Refresh Token | Password | A refresh token that generates new refresh tokens and access tokens. Only used with the OAuth authentication mode. | |
Start position | String | %=-1 | Value of the incremental load marker that defines the initial reading position. |
Tables | String | A semicolon-delimited ( | |
Thread pool count | Integer | 10 | |
Username | String | The user name of an account with access to the Atlassian platform. Only used with the API token authentication mode. |
The Jira reader supports the following tables.
Attachments
Boards
Comments
Issues
IssueTypes
ProjectComponents
ProjectRoleActors
Projects
ProjectVersions
RoleActors
Roles
Sprints
User
Worklogs
The Sprints table requires the read:sprint:jira-software
scope. The RoleActors and Roles tables require either the manage:jira-configuration
scope or the following set of scopes.
read:user:jira
read:group:jira
read:project-role:jira
read:project:jira
read:avatar:jira
read:project-category:jira
All other tables require the read:jira-user
and read:jira-work
scopes.