Backlog Connector for CData Sync

Build 23.0.8839
  • Backlog
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • IssueAttachments
        • IssueComments
        • IssueLinkedSharedFiles
        • Issues
        • ProjectAdministrators
        • ProjectCategories
        • ProjectCustomFieldItems
        • ProjectCustomFields
        • ProjectIssueTypes
        • Projects
        • ProjectStatuses
        • ProjectTeams
        • ProjectUsers
        • ProjectVersionMilestones
        • PullRequestAttachments
        • PullRequestComments
        • PullRequests
        • Watchings
        • WikiPageAttachments
        • WikiPages
      • Views
        • IssueCategories
        • IssueCommentChangeLog
        • IssueCommentNotifications
        • IssueCommentStars
        • IssueMilestones
        • IssueParticipants
        • IssueVersions
        • Licenses
        • Notifications
        • Priorities
        • ProjectRecentUpdates
        • ProjectSharedFiles
        • ProjectTeamMembers
        • PullRequestCommentChangeLog
        • PullRequestCommentNotifications
        • PullRequestCommentStars
        • Repositories
        • Resolutions
        • Space
        • SpaceDiskUsage
        • SpaceDiskUsageDetails
        • SpaceNotifications
        • SpaceUpdates
        • TeamMembers
        • Teams
        • UserReceivedStars
        • UserRecentlyViewedIssues
        • UserRecentlyViewedProjects
        • UserRecentlyViewedWikiPages
        • UserRecentUpdates
        • Users
        • WikiPageHistory
        • WikiPageLinkedSharedFiles
        • WikiPageStars
        • WikiPageTags
    • Connection String Options
      • Authentication
        • URL
        • AuthScheme
        • ApiKey
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • MaxThreads
        • Other
        • Pagesize
        • ProjectId
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Backlog Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Backlog data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Backlog connector can be used from the CData Sync application to pull data from Backlog and move it to any of the supported destinations.

Backlog Version Support

The Sync App leverages the Backlog API to enable bidirectional access to Backlog.

Backlog Connector for CData Sync

Establishing a Connection

Adding a Connection to Backlog

To add a connection to Backlog:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Backlog icon is not available, click the Add More icon to download and install the Backlog connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Authenticating to Backlog

Authentication methods available include APIKey and OAuth.

API Key

Set AuthScheme to APIToken.

To obtain the ApiKey:

  1. Open the personal information page on Backlog.
  2. Click API Section, set the API Key description, and then click Submit. This generates the token.
  3. Specify the API key in ApiKey.
  4. For the URL connection property, use your backlog tenant URL.

OAuth

You must set AuthScheme to OAuth in all user account flows.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the Sync App on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Create the Authorization URL by setting the following properties:
    • InitiateOAuth: Set to OFF.
    • OAuthClientId: Set to the client Id assigned when you registered your application.
    • OAuthClientSecret: Set to the client secret assigned when you registered your application.
    Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
  2. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthClientId: (custom applications only) Set this to the Client Id in your custom OAuth application settings.
  • OAuthClientSecret: Set this to the Client Secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

After you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Backlog Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Backlog Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Backlog and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Backlog Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Backlog Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Backlog Connector for CData Sync

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Backlog APIs.

Key Features

  • The Sync App models Backlog entities like documents, folders, and groups as relational views, allowing you to write SQL to query Backlog data.
  • Stored procedures allow you to execute operations to Backlog
  • Live connectivity to these objects means any changes to your Backlog account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model Teams, Users, TeamMembers, etc.

Tables

Tables describes the available tables. Tables are statically defined to model Projects, Issues, WikiPages, etc.

Stored Procedures

Stored Procedures are function-like interfaces to Backlog. Stored procedures allow you to execute operations to Backlog, including downloading documents and moving envelopes.

Backlog Connector for CData Sync

Tables

The Sync App models the data in Backlog as a list of tables in a relational database that can be queried using standard SQL statements.

Backlog Connector for CData Sync Tables

Name Description
IssueAttachments Returns data from issue attachments table.
IssueComments Returns data from issue comments table.
IssueLinkedSharedFiles Returns data from issue linked shared files table.
Issues Returns data from issues table.
ProjectAdministrators Returns data from project administrators table.
ProjectCategories Returns data from project categories table.
ProjectCustomFieldItems Returns data from project custom field items table.
ProjectCustomFields Returns data from project custom fields table.
ProjectIssueTypes Returns data from project issue types table.
Projects Returns data from projects table.
ProjectStatuses Returns data from project statuses table.
ProjectTeams Returns data from project teams table.
ProjectUsers Returns data from project users table.
ProjectVersionMilestones Returns data from project version milestones table.
PullRequestAttachments Returns data from pull request attachments table.
PullRequestComments Returns data from pull request comments table.
PullRequests Returns data from project pull requests table.
Watchings Returns data from watchings table.
WikiPageAttachments Gets list of files attached to Wiki.
WikiPages Returns data from wiki pages table.

Backlog Connector for CData Sync

IssueAttachments

Returns data from issue attachments table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports the '='.

For example, the following query is processed server side:

SELECT * FROM IssueAttachments WHERE IssueId = 6840954

INSERT

INSERT is not supported for this table.

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by providing the IssueId AND ID.

DELETE FROM IssueAttachments WHERE IssueId = 6840954 AND Id = 3470553

Columns

Name Type ReadOnly Description
IssueId [KEY] Int False

Id [KEY] Int False

Name String False

Size Int False

Created Datetime False

CreatedById Int False

CreatedByUserId String False

CreatedByName String False

CreatedByKeyword String False

CreatedByRoleType Int False

CreatedByLanguage String False

CreatedByMailAddress String False

CreatedByNulabAccountName String False

CreatedByNulabId String False

CreatedByNulabAccountUniqueId String False

Backlog Connector for CData Sync

IssueComments

Returns data from issue comments table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • Id supports '='.
  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueComments WHERE IssueId = 6840954
SELECT * FROM IssueComments WHERE IssueId = 6840954 AND Id = 39040604

Insert

Insert can be executed by specifying the IssueId and Content.

INSERT INTO IssueComments (IssueId, Content) VALUES ('6840954', 'Sample Comment')

Update


UPDATE IssueComments SET Content = 'Third' WHERE IssueId = 6840954 AND Id = 39042035"

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM IssueComments WHERE IssueId = 6840954 AND Id = 39042338

Columns

Name Type ReadOnly Description
IssueId [KEY] Int False

Id [KEY] Int False

Content String False

Created Datetime False

Updated Datetime False

CreatedById Int False

CreatedByUserId String False

CreatedByName String False

CreatedByRoleType Int False

CreatedByLanguage String False

CreatedByMailAddress String False

CreatedByNulabAccountName String False

CreatedByNulabId String False

CreatedByNulabAccountUniqueId String False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
NotifiedUserId String

AttachmentId String

Backlog Connector for CData Sync

IssueLinkedSharedFiles

Returns data from issue linked shared files table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueLinkedSharedFiles WHERE IssueId = 6840954

Insert

Insert can be executed by specifying the IssueId and Id.

INSERT INTO IssueLinkedSharedFiles (IssueId, Id) VALUES ('6840954', '5597286')

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM IssueLinkedSharedFiles WHERE IssueId = 6840954 AND Id = 5597286

Columns

Name Type ReadOnly Description
IssueId [KEY] Int False

Id [KEY] Int False

Name String True

Size Int True

Type String True

Dir String True

Created Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByKeyword String True

CreatedByRoleType Int True

CreatedByLanguage String True

CreatedByMailAddress String True

CreatedByNulabAccountName String True

CreatedByNulabId String True

CreatedByNulabAccountUniqueId String True

Updated Datetime True

UpdatedById Int True

UpdatedByUserId String True

UpdatedByName String True

UpdatedByKeyword String True

UpdatedByRoleType Int True

UpdatedByLanguage String True

UpdatedByMailAddress String True

UpdatedByNulabAccountName String True

UpdatedByNulabId String True

UpdatedByNulabAccountUniqueId String True

Backlog Connector for CData Sync

Issues

Returns data from issues table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports '=, IN'.
  • ProjectId supports '=, IN'.
  • StatusId supports '=, IN'.
  • ResolutionId supports '=, IN'.

For example, the following query is processed server side:

SELECT * FROM Issues WHERE ID = 6840954
SELECT * FROM Issues WHERE ID IN (6840954, 6840954)
SELECT * FROM Issues WHERE ProjectId = 112873
SELECT * FROM Issues WHERE ProjectId IN (112873, 6840954)
SELECT * FROM Issues WHERE StatusId = 1
SELECT * FROM Issues WHERE StatusId IN (112873, 6840954)
SELECT * FROM Issues WHERE ResolutionId = 0
SELECT * FROM Issues WHERE ResolutionId IN (0, 3)

Insert

Insert can be executed by specifying the ProjectId, Summary, PriorityId and IssueTypeId.

INSERT INTO Issues (ProjectId, Summary, PriorityId, IssueTypeId) VALUES (114706, 'Summary', 3, 530959)

Update


UPDATE Issues SET Summary = 'UPDATED_KEY23', ParentIssueId = '6700745', Comment = 'test' WHERE Id = 6700474

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM Issues WHERE IssueId = 6840954 AND Id = 3470553

Columns

Name Type ReadOnly Description
Id [KEY] Int False

ProjectId Int False

IssueKey String False

KeyId Int False

ParentIssueId Int False

Summary String False

Description String False

CustomAttributes String False

StartDate Date False

DueDate Date False

ActualHours Decimal False

EstimatedHours Decimal False

Created Datetime False

CreatedByUserName String False

CreatedByUserId String False

Updated Datetime False

UpdatedByUserName String False

UpdatedByUserId String False

ResolutionId Int False

ResolutionName String False

PriorityId Int False

PriorityName String False

IssueTypeId Int False

IssueTypeName String False

IssueTypeProjectId Int False

IssueTypeColor String False

IssueTypeDisplayOrder Int False

StatusId Int False

StatusProjectId Int False

StatusName String False

StatusColor String False

StatusDisplayOrder Int False

AssigneeId Int False

AssigneeName String False

AssigneeRoleType Int False

AssigneeLanguage String False

AssigneeMailAddress String False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Category String

Version String

Milestone String

ParentChild Int

The allowed values are 0, 1, 2, 3, 4.

Attachment Boolean

SharedFile Boolean

CreatedSince String

CreatedUntil String

UpdatedSince String

UpdatedUntil String

StartDateSince String

StartDateUntil String

DueDateSince String

DueDateUntil String

Keyword String

Comment String

Backlog Connector for CData Sync

ProjectAdministrators

Returns data from project administrators table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectAdministrators WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId and UserId.

INSERT INTO ProjectAdministrators (ProjectId, UserId) VALUES ('114706', '280728')

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the ProjectId AND UserId.

DELETE FROM ProjectAdministrators WHERE ProjectId = 114706 AND UserId = 280728

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

UserId [KEY] Int False

UserCode String False

Name String False

Keyword String False

NulabAccountName String False

NulabId String False

NulabAccountUniqueId String False

RoleType Int False

Language String False

MailAddress String False

Backlog Connector for CData Sync

ProjectCategories

Returns data from project categories table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectCategories WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId and Name.

INSERT INTO ProjectCategories (ProjectId, Name) VALUES ('114706', 'cat4')

Update


UPDATE ProjectCategories SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 205625

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM ProjectCategories WHERE ProjectId = 114706 AND Id = 205622

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

Id [KEY] Int False

Name String False

DisplayOrder Int False

Backlog Connector for CData Sync

ProjectCustomFieldItems

Returns data from project custom field items table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectCustomFieldItems WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId, CustomFieldId and Name.

INSERT INTO ProjectCustomFieldItems (ProjectId, CustomFieldId, Name) VALUES ('114706', '44072', 'Fourth')

Update


UPDATE ProjectCustomFieldItems SET Name = 'Fourth4' WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 4

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM ProjectCustomFieldItems WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 5

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

Id [KEY] Int False

DisplayOrder String True

Name String False

ItemId [KEY] Int False

ItemName String False

ItemDisplayOrder String True

Backlog Connector for CData Sync

ProjectCustomFields

Returns data from project custom fields table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectCustomFields WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId, typeId and Name.

INSERT INTO ProjectCustomFields (ProjectId, Name, typeId) VALUES ('114706', 'Milestone4', 1)

Update


UPDATE ProjectCustomFields SET Name = 'Third' WHERE ProjectId = 114706 AND Id = 44203

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM ProjectCustomFields WHERE ProjectId = 114706 AND Id = 44204

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

Id [KEY] Int False

TypeId String False

Name String False

Description String False

Required Booelan False

AllowAddItem Booelan False

UseIssueType Booelan False

ApplicableIssueTypes String False

DisplayOrder String False

Backlog Connector for CData Sync

ProjectIssueTypes

Returns data from project issue types table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectIssueTypes WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId, Color and Name.

INSERT INTO ProjectIssueTypes (ProjectId, Name, Color) VALUES ('114706', 'Sample', '#ff9200')

Update


UPDATE ProjectIssueTypes SET Name = 'ytryet43' WHERE ProjectId = 114706 AND Id = 532089

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

Id [KEY] Int False

Name String False

Color String False

DisplayOrder Int True

TemplateSummary String False

TemplateDescription String False

Backlog Connector for CData Sync

Projects

Returns data from projects table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports '='.
  • ProjectKey supports '='.
  • All supports '='.
  • Archived supports '='.

For example, the following query is processed server side:

SELECT * FROM Projects WHERE Id = 114706
SELECT * FROM Projects WHERE ProjectKey = 'SAMPLE_KEY'
SELECT * FROM Projects WHERE All = true
SELECT * FROM Projects WHERE Archived = false

Insert

Insert can be executed by specifying the Name, ProjectKey, chartEnabled, projectLeaderCanEditProjectLeader, subtaskingEnabled, textFormattingRule, ProjectLeaderCanEditProjectLeader, UseDevAttributes and UseWikiTreeView.

INSERT INTO Projects (Name, ProjectKey, chartEnabled, projectLeaderCanEditProjectLeader, subtaskingEnabled, textFormattingRule, ProjectLeaderCanEditProjectLeader, UseDevAttributes, UseWikiTreeView) VALUES ('InsertedName', 'INSERTED_KEY_3', false, true, true, markdown, true, false, false)

Update


UPDATE Projects SET ProjectKey = 'UPDATED_KEY2', Name = 'UpdatedName2' WHERE Id = 112873

Delete

Delete can be executed by specifying ID.

DELETE FROM Projects WHERE Id = 113332

Columns

Name Type ReadOnly Description
Id [KEY] Int False

ProjectKey String False

Name String False

DisplayOrder Int False

ChartEnabled Boolean False

SubtaskingEnabled Boolean False

ProjectLeaderCanEditProjectLeader Boolean False

UseDevAttributes Boolean False

UseWikiTreeView Boolean False

TextFormattingRule String False

Archived Boolean False

useResolvedForChart Boolean False

useWiki Boolean False

useFileSharing Boolean False

useOriginalImageSizeAtWiki Boolean False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
All Boolean

Backlog Connector for CData Sync

ProjectStatuses

Returns data from project statuses table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectStatuses WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId, Name and Color.
Possible values for Color column are #ea2c00 ,#e87758 ,#e07b9a ,#868cb7 ,#3b9dbd ,#4caf93 ,#b0be3c ,#eda62a ,#f42858, #393939.

INSERT INTO ProjectStatuses (ProjectId, Name, Color) VALUES ('117182', 'Sample', '#3b9dbd')

Update


UPDATE ProjectStatuses SET Name = 'Sample', color = '#ea2c00' WHERE ProjectId = 114706 AND Id = 18504

Columns

Name Type ReadOnly Description
Id [KEY] Int False

ProjectId [KEY] Int False

Name String False

Color String False

DisplayOrder Int True

Backlog Connector for CData Sync

ProjectTeams

Returns data from project teams table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectTeams WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId and TeamId.

INSERT INTO ProjectTeams (ProjectId, TeamId) VALUES ('114706', '55083')

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM ProjectTeams WHERE ProjectId = 114706 AND TeamId = 55082

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

TeamId [KEY] Int False

Name String True

DisplayOrder Int True

Created Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByRoleType Int True

CreatedByLang String True

CreatedByMailAddress String True

Updated Datetime True

UpdatedById Int True

UpdatedByUserId String True

UpdatedByName String True

UpdatedByRoleType Int True

UpdatedByLang String True

UpdatedByMailAddress String True

Backlog Connector for CData Sync

ProjectUsers

Returns data from project users table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectUsers WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId and UserId.

INSERT INTO ProjectUsers (ProjectId, UserId) VALUES ('114706', '280728')

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the ProjectId AND UserId.

DELETE FROM ProjectUsers WHERE ProjectId = 114706 AND UserId = 280728

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

UserId [KEY] Int False

UserCode String False

Name String False

Keyword String False

NulabAccountName String False

NulabId String False

NulabAccountUniqueId String False

RoleType Int False

Language String False

MailAddress String False

Backlog Connector for CData Sync

ProjectVersionMilestones

Returns data from project version milestones table.

projectversionmilestones

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectVersionMilestones WHERE ProjectId = 114706

Insert

Insert can be executed by specifying the ProjectId and Name.

INSERT INTO ProjectVersionMilestones (ProjectId, Name) VALUES ('114706', 'Milestone4')

Update


UPDATE ProjectVersionMilestones SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 138889

Delete

Delete can be executed by specifying the ProjectId AND ID.

DELETE FROM ProjectVersionMilestones WHERE ProjectId = 114706 AND Id = 138890

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

Id [KEY] Int False

Name String False

Description String False

DisplayOrder Int True

StartDate Date False

ReleaseDueDate Date False

Archived Boolean True

Backlog Connector for CData Sync

PullRequestAttachments

Returns data from pull request attachments table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId, RepositoryId and PullRequestNumber are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • PullRequestNumber supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequestAttachments WHERE ProjectId = '94706' AND RepositoryId = 21949 AND PullRequestNumber = 2

INSERT

INSERT is not supported for this table.

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the ProjectId, RepositoryId, PullRequestNumber AND ID.

DELETE FROM PullRequestAttachments WHERE ProjectId = 39470 AND RepositoryId = 21949 AND PullRequestNumber = 2 AND ID = 3

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int True

RepositoryId [KEY] Int True

PullRequestNumber [KEY] Int True

Id [KEY] Int True

Name String True

Size Int True

Created Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByKeyword String True

CreatedByRoleType Int True

CreatedByLanguage String True

CreatedByMailAddress String True

CreatedByNulabAccountName String True

CreatedByNulabId String True

CreatedByNulabAccountUniqueId String True

Backlog Connector for CData Sync

PullRequestComments

Returns data from pull request comments table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId, RepositoryId and PullRequestNumber are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • PullRequestNumber supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequestComments WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2

Insert

Insert can be executed by specifying the ProjectId, RepositoryId, PullRequestNumber and Content.

INSERT INTO PullRequestComments (ProjectId, RepositoryId, PullRequestNumber, Content) VALUES ('114706', '22462', '2', 'FirstComment')

Update


UPDATE PullRequestComments SET Content = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2 AND ID = 3

Delete

Delete is not supported for this table.

Columns

Name Type ReadOnly Description
ProjectId Int False

RepositoryId Int False

PullRequestNumber Int False

Id [KEY] Int False

Content String False

Created Datetime True

Updated Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByRoleType Int True

CreatedByLanguage String True

CreatedByMailAddress String True

CreatedByNulabAccountName String True

CreatedByNulabId String True

CreatedByNulabAccountUniqueId String True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
NotifiedUserId String

Backlog Connector for CData Sync

PullRequests

Returns data from project pull requests table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId and RepositoryId are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • Number supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462"
SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462 AND Number = 2

Insert

Insert can be executed by specifying the ProjectId, RepositoryId, Summary, description, base and branch.

INSERT INTO PullRequests (ProjectId, RepositoryId, Summary, description, base, branch) VALUES ('114706', '22462', 'First', 'FirstPullReq', 'main', 'sample')

Update


UPDATE PullRequests SET Summary = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND Number = 44203

Delete

Delete is not supported for this table.

Columns

Name Type ReadOnly Description
ProjectId [KEY] Int False

RepositoryId [KEY] Int False

Id [KEY] Int False

Number Int False

Summary String False

Description String False

Base String False

Branch String False

BaseCommit String True

BranchCommit String True

CloseAt Datetime True

MergeAt Datetime True

StatusId Int True

StatusName String True

IssueId Int False

AssigneeId Int False

AssigneeName String True

AssigneeRoleType Int True

AssigneeLanguage String True

AssigneeMailAddress String True

Created Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByKeyword String True

CreatedByRoleType Int True

CreatedByLanguage String True

CreatedByMailAddress String True

CreatedByNulabAccountName String True

CreatedByNulabId String True

CreatedByNulabAccountUniqueId String True

Updated Datetime True

UpdatedById Int True

UpdatedByUserId String True

UpdatedByName String True

UpdatedByKeyword String True

UpdatedByRoleType Int True

UpdatedByLanguage String True

UpdatedByMailAddress String True

UpdatedByNulabAccountName String True

UpdatedByNulabId String True

UpdatedByNulabAccountUniqueId String True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
NotifiedUserId String

AttachmentId String

Backlog Connector for CData Sync

Watchings

Returns data from watchings table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The UserId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • UserId supports '='.
  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM Watchings WHERE UserId = '280688'
SELECT * FROM Watchings WHERE Id = '145169'

Insert

Insert can be executed by specifying the IssueId and Note.

INSERT INTO Watchings (IssueId, Note) VALUES ('6868643', 'Sample')

Update


UPDATE Watchings SET Note = 'Third' WHERE Id = 145171

Delete

Delete can be executed by specifying ID.

DELETE FROM Watchings WHERE Id = 145170

Columns

Name Type ReadOnly Description
UserId Int False

Id [KEY] Int False

Note String False

Type String True

IssueId String True

ResourceAlreadyRead Boolean True

LastContentUpdated Datetime True

Created Datetime True

Updated Datetime True

Backlog Connector for CData Sync

WikiPageAttachments

Gets list of files attached to Wiki.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The WikiPageId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • WikiPageId supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPageAttachments WHERE WikiPageId = '639459'

INSERT

INSERT is not supported for this table.

Update

UPDATE is not supported for this table.

Delete

Delete can be executed by specifying the IssueId AND ID.

DELETE FROM WikiPageAttachments WHERE WikiPageId = 639459 AND Id = 188522

Columns

Name Type ReadOnly Description
WikiPageId [KEY] Int False

Id [KEY] Int False

Name String False

Size Int False

Created Datetime False

CreatedById Int False

CreatedByUserId String False

CreatedByName String False

CreatedByKeyword String False

CreatedByRoleType Int False

CreatedByLanguage String False

CreatedByMailAddress String False

CreatedByNulabAccountName String False

CreatedByNulabId String False

CreatedByNulabAccountUniqueId String False

Backlog Connector for CData Sync

WikiPages

Returns data from wiki pages table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPages WHERE ProjectId = '114706'
SELECT * FROM WikiPages WHERE Id = 639460

Insert

Insert can be executed by specifying the ProjectId, Content and Name.

INSERT INTO WikiPages (ProjectId, Name, Content) VALUES ('114706', 'FirstWiki3', 'Sample Comment')

Update


UPDATE WikiPages SET Name = 'UPDATED', Content = 'UPDATED' WHERE Id = 639460

Delete

Delete can be executed by specifying ID.

DELETE FROM WikiPages WHERE Id = 639461

Columns

Name Type ReadOnly Description
ProjectId Int False

Id [KEY] Int False

Name String False

Content String False

Created Datetime True

CreatedById Int True

CreatedByUserId String True

CreatedByName String True

CreatedByKeyword String True

CreatedByRoleType Int True

CreatedByLanguage String True

CreatedByMailAddress String True

CreatedByNulabAccountName String True

CreatedByNulabId String True

CreatedByNulabAccountUniqueId String True

Updated Datetime True

UpdatedById Int True

UpdatedByUserId String True

UpdatedByName String True

UpdatedByKeyword String True

UpdatedByRoleType Int True

UpdatedByLanguage String True

UpdatedByMailAddress String True

UpdatedByNulabAccountName String True

UpdatedByNulabId String True

UpdatedByNulabAccountUniqueId String True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
MailNotify Boolean

Backlog Connector for CData Sync

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Backlog Connector for CData Sync Views

Name Description
IssueCategories Returns data from issue categories table.
IssueCommentChangeLog Returns data from issue comment change log table.
IssueCommentNotifications Returns data from issue comment notifications table.
IssueCommentStars Returns data from issue comment starts table.
IssueMilestones Returns data from issue milestones table.
IssueParticipants Returns list of participants of an issue.
IssueVersions Returns data from issue versions table.
Licenses Returns licence.
Notifications Returns own notifications.
Priorities Returns data from priorities table.
ProjectRecentUpdates Returns recent update in the project.
ProjectSharedFiles Gets list of Project Shared Files
ProjectTeamMembers Returns data from project team members table.
PullRequestCommentChangeLog Returns data from pull request comment changelog table.
PullRequestCommentNotifications Returns data from pull request comment notifications table.
PullRequestCommentStars Returns data from pull request comment starts table.
Repositories Returns data from project repositories table.
Resolutions Returns data from resolutions table.
Space Returns information about your space.
SpaceDiskUsage Returns information about space disk usage.
SpaceDiskUsageDetails Returns information about space disk details usage.
SpaceNotifications Returns space notification.
SpaceUpdates Returns recent updates in your space.
TeamMembers Returns data from team members table.
Teams Returns data from teams table.
UserReceivedStars Returns the list of stars that user received.
UserRecentlyViewedIssues Returns list of issues which the user viewed recently.
UserRecentlyViewedProjects Returns list of projects which the user viewed recently.
UserRecentlyViewedWikiPages Returns list of Wikis which the user viewed recently.
UserRecentUpdates Returns user recent updates.
Users Returns data from users table.
WikiPageHistory Returns history of Wiki page.
WikiPageLinkedSharedFiles Returns data from wiki page linked shred files table.
WikiPageStars Returns list of stars received on the Wiki page.
WikiPageTags Returns list of tags that are used in the project.

Backlog Connector for CData Sync

IssueCategories

Returns data from issue categories table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports the '='.

For example, the following query is processed server side:

SELECT * FROM IssueCategories WHERE IssueId = 6840954

Columns

Name Type Description
IssueId String
Id [KEY] Int
Name String
DisplayOrder String

Backlog Connector for CData Sync

IssueCommentChangeLog

Returns data from issue comment change log table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports the '='.

For example, the following query is processed server side:

SELECT * FROM IssueCommentChangeLog WHERE IssueId = 6840954

Columns

Name Type Description
IssueId Int
CommentId Int
AttachmentInfo String
AttributeInfo String
Field String
NewValue String
NotificationInfo String
OriginalValue String

Backlog Connector for CData Sync

IssueCommentNotifications

Returns data from issue comment notifications table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports the '='.

For example, the following query is processed server side:

SELECT * FROM IssueCommentNotifications WHERE IssueId = 6840954

Columns

Name Type Description
IssueId Int
CommentId Int
NotificationId [KEY] Int
Reason String
AlreadyRead Boolean
ResourceAlreadyRead Boolean
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

IssueCommentStars

Returns data from issue comment starts table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueCommentStars WHERE IssueId = 6840954

Columns

Name Type Description
IssueId Int
CommentId Int
StarId [KEY] Int
Comment String
Title String
Url String
Created Datetime
PresenterId Int
PresenterUserId String
PresenterName String
PresenterKeyword String
PresenterRoleType Int
PresenterLanguage String
PresenterMailAddress String
PresenterNulabAccountName String
PresenterNulabId String
PresenterNulabAccountUniqueId String

Backlog Connector for CData Sync

IssueMilestones

Returns data from issue milestones table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueMilestones WHERE IssueId = 6868745

Columns

Name Type Description
IssueId String
Id [KEY] Int
Name String
Description String
Archived Boolean
ProjectId Int
ReleaseDueDate Date
StartDate Date
DisplayOrder String

Backlog Connector for CData Sync

IssueParticipants

Returns list of participants of an issue.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueParticipants WHERE IssueId = '6840954'

Columns

Name Type Description
IssueId Int
Id [KEY] Int
UserId String
Name String
Keyword String
NulabAccountName String
NulabId String
NulabAccountUniqueId String
RoleType Int
Language String
MailAddress String

Backlog Connector for CData Sync

IssueVersions

Returns data from issue versions table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The IssueId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • IssueId supports '='.

For example, the following query is processed server side:

SELECT * FROM IssueVersions WHERE IssueId = 6868745

Columns

Name Type Description
IssueId String
Id [KEY] Int
Name String
Description String
Archived Boolean
ProjectId Int
ReleaseDueDate Date
StartDate Date
DisplayOrder String

Backlog Connector for CData Sync

Licenses

Returns licence.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Active Boolean
AttachmentLimit Int
AttachmentLimitPerFile Int
AttachmentNumLimit Int
Attribute Boolean
AttributeLimit Int
Burndown Boolean
CommentLimit Int
ComponentLimit Int
FileSharing Boolean
Gantt Boolean
Git Boolean
IssueLimit Int
LicenceTypeId Int
LimitDate Date
NulabAccount Boolean
ParentChildIssue Boolean
PostIssueByMail Boolean
ProjectGroup Boolean
ProjectLimit Int
PullRequestAttachmentLimitPerFile Int
PullRequestAttachmentNumLimit Int
RemoteAddress Boolean
RemoteAddressLimit Int
StartedOn Datetime
StorageLimit Int
Subversion Boolean
SubversionExternal Boolean
UserLimit Int
VersionLimit Int
WikiAttachment Boolean
WikiAttachmentLimitPerFile Int
WikiAttachmentNumLimit Int

Backlog Connector for CData Sync

Notifications

Returns own notifications.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Id [KEY] Int
AlreadyRead Boolean
Reason Int
ResourceAlreadyRead Int
Created Int
ProjectId Int
ProjectKey String
ProjectName String
ProjectDisplayOrder Int
ProjectChartEnabled Boolean
ProjectSubtaskingEnabled Boolean
ProjectProjectLeaderCanEditProjectLeader Boolean
ProjectUseDevAttributes Boolean
ProjectUseWikiTreeView Boolean
ProjectTextFormattingRule String
ProjectArchived Boolean
IssueId Int
IssueProjectId Int
IssueKey String
IssueKeyId Int
IssueTypeId Int
IssueTypeName String
IssueTypeColor String
IssueTypeProjectId Int
IssueTypeDisplayOrder Int
IssueSummary String
IssueDescription String
IssueResolutions String
IssuePriorityId Int
IssuePriorityName String
IssueStatusId Int
IssueStatusName String
IssueStatusColor String
IssueStatusProjectId Int
IssueStatusDisplayOrder Int
IssueAssigneeId Int
IssueAssigneeName String
IssueAssigneeRoleType Int
IssueAssigneeLanguage String
IssueAssigneeMailAddress String
IssueCategories String
IssueVersions String
IssueMilestones String
IssueCustomFields String
IssueAttachments String
IssueSharedFiles String
IssueStars String
IssueStartDate Date
IssueDueDate Date
IssueEstimatedHours Decimal
IssueActualHours Decimal
IssueParentIssueId Int
IssueCreated Datetime
IssueCreatedById Int
IssueCreatedByUserId String
IssueCreatedByName String
IssueCreatedByKeyword String
IssueCreatedByNulabAccountName String
IssueCreatedByNulabId String
IssueCreatedByNulabAccountUniqueId String
IssueCreatedByRoleType Int
IssueCreatedByLanguage String
IssueCreatedByMailAddress String
IssueUpdated Datetime
IssueUpdatedById Int
IssueUpdatedByUserId String
IssueUpdatedByName String
IssueUpdatedByKeyword String
IssueUpdatedByNulabAccountName String
IssueUpdatedByNulabId String
IssueUpdatedByNulabAccountUniqueId String
IssueUpdatedByRoleType Int
IssueUpdatedByLanguage String
IssueUpdatedByMailAddress String
CommentId Int
CommentContent String
CommentCreated String
SentById Int
SentByUserId String
SentByName String
SentByKeyword String
SentByNulabAccountName String
SentByNulabId String
SentByNulabAccountUniqueId String
SentByRoleType Int
SentByLanguage String
SentByMailAddress String

Backlog Connector for CData Sync

Priorities

Returns data from priorities table.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Id [KEY] Int
Name String

Backlog Connector for CData Sync

ProjectRecentUpdates

Returns recent update in the project.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectRecentUpdates WHERE ProjectId = 114706

Columns

Name Type Description
Id [KEY] Int
Created Datetime
Type String
ContentId Int
Content String
ContentDiff String
ContentKeyId String
ContentDescription String
ContentSummary String
ContentRepository String
ContentAttachments String
ContentSharedFiles String
ContentComments String
ContentChanges String
ContentParties String
ProjectId Int
ProjectKey String
ProjectName String
ProjectDisplayOrder Int
ProjectChartEnabled Boolean
ProjectSubtaskingEnabled Boolean
ProjectProjectLeaderCanEditProjectLeader Boolean
ProjectUseDevAttributes Boolean
ProjectUseWikiTreeView Boolean
ProjectTextFormattingRule String
ProjectArchived Boolean
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String

Backlog Connector for CData Sync

ProjectSharedFiles

Gets list of Project Shared Files

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • Directory supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectSharedFiles WHERE ProjectId = '114706'
SELECT * FROM ProjectSharedFiles WHERE ProjectId = '114706' AND Directory = '/folder/'

Columns

Name Type Description
ProjectId Int
Id [KEY] Int
Name String
Size Int
Type String
Directory String
Created Datetime
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
Updated Datetime
UpdatedById Int
UpdatedByUserId String
UpdatedByName String
UpdatedByKeyword String
UpdatedByRoleType Int
UpdatedByLanguage String
UpdatedByMailAddress String
UpdatedByNulabAccountName String
UpdatedByNulabId String
UpdatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

ProjectTeamMembers

Returns data from project team members table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM ProjectTeamMembers WHERE ProjectId = 114706

Columns

Name Type Description
ProjectId Int
TeamId Int
MemberId Int
UserId String
Name String
Keyword String
NulabAccountName String
NulabId String
NulabAccountUniqueId String
RoleType Int
Lang String
MailAddress String

Backlog Connector for CData Sync

PullRequestCommentChangeLog

Returns data from pull request comment changelog table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId, RepositoryId and PullRequestNumber are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • PullRequestNumber supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequestCommentChangeLog WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns

Name Type Description
ProjectId Int
RepositoryId Int
PullRequestNumber Int
AttachmentInfo String
AttributeInfo String
Field String
NewValue String
NotificationInfo String
OriginalValue String

Backlog Connector for CData Sync

PullRequestCommentNotifications

Returns data from pull request comment notifications table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId, RepositoryId and PullRequestNumber are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • PullRequestNumber supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequestCommentNotifications WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns

Name Type Description
ProjectId Int
RepositoryId Int
PullRequestNumber Int
NotificationId [KEY] Int
Reason String
AlreadyRead Boolean
ResourceAlreadyRead Boolean
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

PullRequestCommentStars

Returns data from pull request comment starts table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId, RepositoryId and PullRequestNumber are required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • RepositoryId supports '='.
  • PullRequestNumber supports '='.

For example, the following query is processed server side:

SELECT * FROM PullRequestCommentStars WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2

Columns

Name Type Description
ProjectId Int
RepositoryId Int
PullRequestNumber Int
StarId [KEY] Int
Comment String
Title String
Url String
Created Datetime
PresenterId Int
PresenterUserId String
PresenterName String
PresenterKeyword String
PresenterRoleType Int
PresenterLanguage String
PresenterMailAddress String
PresenterNulabAccountName String
PresenterNulabId String
PresenterNulabAccountUniqueId String

Backlog Connector for CData Sync

Repositories

Returns data from project repositories table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.
  • Id supports '='.
  • Name supports '='.

For example, the following query is processed server side:

SELECT * FROM Repositories WHERE ProjectId = 117182
SELECT * FROM Repositories WHERE ProjectId = 117182 AND Id = 22862
SELECT * FROM Repositories WHERE ProjectId = 117182 AND Name = 'First'

Columns

Name Type Description
Id [KEY] Int
ProjectId Int
Name String
Description String
HookUrl String
HttpUrl String
SshUrl String
DisplayOrder Int
PushedAt Datetime
Created Datetime
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
Updated Datetime
UpdatedById Int
UpdatedByUserId String
UpdatedByName String
UpdatedByKeyword String
UpdatedByRoleType Int
UpdatedByLanguage String
UpdatedByMailAddress String
UpdatedByNulabAccountName String
UpdatedByNulabId String
UpdatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

Resolutions

Returns data from resolutions table.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Id [KEY] Int
Name String

Backlog Connector for CData Sync

Space

Returns information about your space.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
SpaceKey String
Name String
OwnerId [KEY] Int
Language String
Timezone String
ReportSendTime Hour
TextFormattingRule String
Created Datetime
Updated Datetime

Backlog Connector for CData Sync

SpaceDiskUsage

Returns information about space disk usage.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Capacity String
Issue String
Wiki String
File Int
Subversion Int
Git Int
GitLFS Int
PullRequest Int

Backlog Connector for CData Sync

SpaceDiskUsageDetails

Returns information about space disk details usage.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
ProjectId String
File Int
Git Int
GitLFS Int
Issue String
Wiki String
Subversion Int

Backlog Connector for CData Sync

SpaceNotifications

Returns space notification.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Content String
Updated Datetime

Backlog Connector for CData Sync

SpaceUpdates

Returns recent updates in your space.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Type supports '=,IN'.

For example, the following query is processed server side:

SELECT * FROM SpaceUpdates WHERE Type = 13
SELECT * FROM SpaceUpdates WHERE Type IN (13, 5)

Columns

Name Type Description
Id [KEY] Int
Created Datetime
Type String
ContentId Int
Content String
ContentDiff String
ContentKeyId String
ContentDescription String
ContentSummary String
ContentRepository String
ContentAttachments String
ContentSharedFiles String
ContentComments String
ContentChanges String
ContentParties String
ProjectId Int
ProjectKey String
ProjectName String
ProjectDisplayOrder Int
ProjectChartEnabled Boolean
ProjectSubtaskingEnabled Boolean
ProjectProjectLeaderCanEditProjectLeader Boolean
ProjectUseDevAttributes Boolean
ProjectUseWikiTreeView Boolean
ProjectTextFormattingRule String
ProjectArchived Boolean
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String

Backlog Connector for CData Sync

TeamMembers

Returns data from team members table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The TeamId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • TeamId supports '='.

For example, the following query is processed server side:

SELECT * FROM TeamMembers WHERE TeamId = 54836

Columns

Name Type Description
TeamId Int
Id [KEY] Int
UserId String
Name String
Keyword String
NulabAccountName String
NulabId String
NulabAccountUniqueId String
RoleType Int
Lang String
MailAddress String

Backlog Connector for CData Sync

Teams

Returns data from teams table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM Teams WHERE Id = 55081

Columns

Name Type Description
Id [KEY] Int
Name String
DisplayOrder Int
Members String
Created Datetime
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByRoleType Int
CreatedByLang String
CreatedByMailAddress String
Updated Datetime
UpdatedById Int
UpdatedByUserId String
UpdatedByName String
UpdatedByRoleType Int
UpdatedByLang String
UpdatedByMailAddress String

Backlog Connector for CData Sync

UserReceivedStars

Returns the list of stars that user received.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The UserId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • UserId supports '='.

For example, the following query is processed server side:

SELECT * FROM UserReceivedStars WHERE UserId = 263366

Columns

Name Type Description
UserId String
Id [KEY] Int
Comment String
Title String
Url String
Created Datetime
PresenterId Int
PresenterUserId String
PresenterName String
PresenterKeyword String
PresenterRoleType Int
PresenterLanguage String
PresenterMailAddress String
PresenterNulabAccountName String
PresenterNulabId String
PresenterNulabAccountUniqueId String

Backlog Connector for CData Sync

UserRecentlyViewedIssues

Returns list of issues which the user viewed recently.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Id [KEY] Int
ProjectId Int
IssueKey String
KeyId Int
ParentIssueId Int
Summary String
Description String
StartDate Date
DueDate Date
ActualHours Decimal
EstimatedHours Decimal

Backlog Connector for CData Sync

UserRecentlyViewedProjects

Returns list of projects which the user viewed recently.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
Id [KEY] Int
ProjectKey String
Name String
DisplayOrder Int
ChartEnabled Boolean
SubtaskingEnabled Boolean
ProjectLeaderCanEditProjectLeader Boolean
UseDevAttributes Boolean
UseWikiTreeView Boolean
TextFormattingRule String
Archived Boolean

Backlog Connector for CData Sync

UserRecentlyViewedWikiPages

Returns list of Wikis which the user viewed recently.

Table Specific Information

Backlog does not support any column for filtering this table. All filters will be executed client side.

Columns

Name Type Description
ProjectId Int
Id [KEY] Int
Name String
Content String
Created Datetime

Backlog Connector for CData Sync

UserRecentUpdates

Returns user recent updates.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The UserId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • UserId supports '='.
  • Type supports '=,IN'.

For example, the following query is processed server side:

SELECT * FROM UserRecentUpdates WHERE UserId = 263366
SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type = 3
SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type IN (3, 5)

Columns

Name Type Description
UserId String
Id [KEY] Int
Created Datetime
Type String
ContentId Int
Content String
ContentDiff String
ContentKeyId String
ContentDescription String
ContentSummary String
ContentRepository String
ContentAttachments String
ContentSharedFiles String
ContentComments String
ContentChanges String
ContentParties String
ProjectId Int
ProjectKey String
ProjectName String
ProjectDisplayOrder Int
ProjectChartEnabled Boolean
ProjectSubtaskingEnabled Boolean
ProjectProjectLeaderCanEditProjectLeader Boolean
ProjectUseDevAttributes Boolean
ProjectUseWikiTreeView Boolean
ProjectTextFormattingRule String
ProjectArchived Boolean
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String

Backlog Connector for CData Sync

Users

Returns data from users table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports '='.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 54836

Columns

Name Type Description
Id [KEY] Int
UserId String
Name String
NulabAccountName String
NulabAccountID String
NulabAccountUniqueId String
RoleType Int
Lang String
MailAddress String

Backlog Connector for CData Sync

WikiPageHistory

Returns history of Wiki page.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The WikiPageId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • WikiPageId supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPageHistory WHERE WikiPageId = '639459'

Columns

Name Type Description
WikiPageId Int
PageId [KEY] Int
Name String
Content String
Version Int
Created Datetime
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

WikiPageLinkedSharedFiles

Returns data from wiki page linked shred files table.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The WikiPageId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • WikiPageId supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPageLinkedSharedFiles WHERE WikiPageId = '639459'

Columns

Name Type Description
WikiPageId Int
Id [KEY] Int
Name String
Size Int
Type String
Dir String
Created Datetime
CreatedById Int
CreatedByUserId String
CreatedByName String
CreatedByKeyword String
CreatedByRoleType Int
CreatedByLanguage String
CreatedByMailAddress String
CreatedByNulabAccountName String
CreatedByNulabId String
CreatedByNulabAccountUniqueId String
Updated Datetime
UpdatedById Int
UpdatedByUserId String
UpdatedByName String
UpdatedByKeyword String
UpdatedByRoleType Int
UpdatedByLanguage String
UpdatedByMailAddress String
UpdatedByNulabAccountName String
UpdatedByNulabId String
UpdatedByNulabAccountUniqueId String

Backlog Connector for CData Sync

WikiPageStars

Returns list of stars received on the Wiki page.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The WikiPageId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • WikiPageId supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPageStars WHERE WikiPageId = '528251'

Columns

Name Type Description
WikiPageId Int
CommentId Int
StarId [KEY] Int
Comment String
Title String
Url String
Created Datetime
PresenterId Int
PresenterUserId String
PresenterName String
PresenterKeyword String
PresenterRoleType Int
PresenterLanguage String
PresenterMailAddress String
PresenterNulabAccountName String
PresenterNulabId String
PresenterNulabAccountUniqueId String

Backlog Connector for CData Sync

WikiPageTags

Returns list of tags that are used in the project.

Select

The Sync App will use the Backlog API to process WHERE clause conditions built with the following column and operator. The ProjectId is required to make a request and the rest of the filter is executed client side within the Sync App.

  • ProjectId supports '='.

For example, the following query is processed server side:

SELECT * FROM WikiPageTags WHERE ProjectId = '94706'

Columns

Name Type Description
ProjectId Int
Id [KEY] Int
Name String

Backlog Connector for CData Sync

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
URLThe URL of the Backlog account.
AuthSchemeThe type of authentication to use when connecting to Backlog.
ApiKeyThe API key allows you make requests to the Backlog API.

OAuth


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
IncludeCustomFieldsSet this to true if you want to retrieve custom fields from the Issues table.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxThreadsThe Max Thread.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Backlog.
ProjectIdId of the specific project.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Backlog Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
URLThe URL of the Backlog account.
AuthSchemeThe type of authentication to use when connecting to Backlog.
ApiKeyThe API key allows you make requests to the Backlog API.
Backlog Connector for CData Sync

URL

The URL of the Backlog account.

Remarks

The URL of the Backlog account in the form "https://{sample}.backlog.com".

Backlog Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Backlog.

Remarks

  • APIToken: Set this to use ApiKey for APIToken authentication.
  • OAuth: Set to this to perform OAuth authentication.

Backlog Connector for CData Sync

ApiKey

The API key allows you make requests to the Backlog API.

Remarks

Append your API key to the API requests to return data from your account.

Backlog Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
Backlog Connector for CData Sync

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

Backlog Connector for CData Sync

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Backlog Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Backlog Connector for CData Sync

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Backlog Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Backlog Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the Sync App opens a connection to Backlog and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Backlog Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

Backlog Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

Backlog Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Backlog Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Backlog Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Backlog Connector for CData Sync

ProxyAutoDetect

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Backlog Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

Backlog Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

Backlog Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Backlog Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

Backlog Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

Backlog Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Backlog Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Backlog Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Backlog Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Backlog Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Backlog Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Backlog Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Backlog Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Backlog Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Backlog Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Backlog Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
IncludeCustomFieldsSet this to true if you want to retrieve custom fields from the Issues table.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxThreadsThe Max Thread.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Backlog.
ProjectIdId of the specific project.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Backlog Connector for CData Sync

IncludeCustomFields

Set this to true if you want to retrieve custom fields from the Issues table.

Remarks

If set to true, the ProjectId connection property is also required.

Backlog Connector for CData Sync

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Backlog Connector for CData Sync

MaxThreads

The Max Thread.

Remarks

Backlog Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Backlog Connector for CData Sync

Pagesize

The maximum number of results to return per page from Backlog.

Remarks

The Pagesize property affects the maximum number of results to return per page from Backlog. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

Backlog Connector for CData Sync

ProjectId

Id of the specific project.

Remarks

Id of the specific project.

Backlog Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Backlog Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Backlog Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Issues WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839