Create a connection to Backlog by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Backlog icon is not available, click the Add More icon to download and install the Backlog connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

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.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Backlog. You can then use the Sync App to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the path where the Sync App saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

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 file.

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 file containing the encrypted OAuth authentication values. Make sure this file 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 path 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 path to your OAuth settings file. Make sure this file gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

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.

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.

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.

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.

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

Generally, querying Backlog tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

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.

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

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'.

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)

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
Resolutions	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

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

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

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

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

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

Delete

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

DELETE FROM ProjectIssueTypes WHERE ProjectId = 114706 AND Id = 530958 AND SubstituteStatusId = 343433

Columns

Name	Type	ReadOnly	Description
ProjectId [KEY]	Int	False
Id [KEY]	Int	False
Name	String	False
Color	String	False
DisplayOrder	Int	False
TemplateSummary	String	False
TemplateDescription	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
SubstituteStatusId	String

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

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

Delete

Delete can be executed by specifying the IssueId, ID AND SubstituteStatusId.

DELETE FROM ProjectStatuses WHERE ProjectId = 114706 AND Id = 18528 AND SubstituteStatusId = 343433

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
ProjectId [KEY]	Int	False
Name	String	False
Color	String	False
DisplayOrder	Int	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
SubstituteStatusId	String

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

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

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

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

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

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

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

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.

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

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

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

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

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

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

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

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

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

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

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

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

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

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

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)

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

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

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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

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

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

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)

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

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

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