Getting Started

This page provides a guide to Establishing a Connection to Backlog in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Backlog

Establishing a Connection shows how to authenticate to Backlog and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Backlog through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Backlog by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. 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:

Open the personal information page on Backlog.
Click API Section, set the API Key description, and then click Submit. This generates the token.
Specify the API key in ApiKey.
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.

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 Cloud 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.
Then configure the Cloud 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.

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.
Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
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 Cloud 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 Cloud to enable the automatic refreshing of the access token.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

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.

Data Model

Overview

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

Key Features

The Cloud 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 Cloud.

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.

Tables

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

CData Cloud - Backlog 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.

IssueAttachments

Returns data from issue attachments table.

Select

The Cloud 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 Cloud.

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

IssueComments

Returns data from issue comments table.

Select

The Cloud 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 Cloud.

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

IssueLinkedSharedFiles

Returns data from issue linked shared files table.

Select

The Cloud 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 Cloud.

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

Issues

Returns data from issues table.

Select

The Cloud 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 Cloud.

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

ProjectAdministrators

Returns data from project administrators table.

Select

The Cloud 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 Cloud.

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

ProjectCategories

Returns data from project categories table.

Select

The Cloud 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 Cloud.

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

ProjectCustomFieldItems

Returns data from project custom field items table.

Select

The Cloud 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 Cloud.

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

ProjectCustomFields

Returns data from project custom fields table.

Select

The Cloud 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 Cloud.

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

ProjectIssueTypes

Returns data from project issue types table.

Select

The Cloud 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 Cloud.

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

Projects

Returns data from projects table.

Select

The Cloud 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 Cloud.

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

ProjectStatuses

Returns data from project statuses table.

Select

The Cloud 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 Cloud.

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

ProjectTeams

Returns data from project teams table.

Select

The Cloud 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 Cloud.

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

ProjectUsers

Returns data from project users table.

Select

The Cloud 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 Cloud.

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

ProjectVersionMilestones

Returns data from project version milestones table.

projectversionmilestones

Select

The Cloud 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 Cloud.

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

PullRequestAttachments

Returns data from pull request attachments table.

Select

The Cloud 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 Cloud.

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

PullRequestComments

Returns data from pull request comments table.

Select

The Cloud 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 Cloud.

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

PullRequests

Returns data from project pull requests table.

Select

The Cloud 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 Cloud.

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

Watchings

Returns data from watchings table.

Select

The Cloud 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 Cloud.

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

WikiPageAttachments

Gets list of files attached to Wiki.

Select

The Cloud 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 Cloud.

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

WikiPages

Returns data from wiki pages table.

Select

The Cloud 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 Cloud.

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

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.

CData Cloud - Backlog 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.

IssueCategories

Returns data from issue categories table.

Select

The Cloud 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 Cloud.

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

IssueCommentChangeLog

Returns data from issue comment change log table.

Select

The Cloud 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 Cloud.

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

IssueCommentNotifications

Returns data from issue comment notifications table.

Select

The Cloud 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 Cloud.

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

IssueCommentStars

Returns data from issue comment starts table.

Select

The Cloud 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 Cloud.

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

IssueMilestones

Returns data from issue milestones table.

Select

The Cloud 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 Cloud.

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

IssueParticipants

Returns list of participants of an issue.

Select

The Cloud 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 Cloud.

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

IssueVersions

Returns data from issue versions table.

Select

The Cloud 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 Cloud.

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

Licenses

Returns licence.

Table Specific Information

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

Columns

Description Boolean Int Int Int Boolean Int Boolean Int Int Boolean Boolean Boolean Int Int Date Boolean Boolean Boolean Boolean Int Int Int Boolean Int Datetime Int Boolean Boolean Int Int Boolean Int Int


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

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

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

ProjectRecentUpdates

Returns recent update in the project.

Select

The Cloud 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 Cloud.

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

ProjectSharedFiles

Gets list of Project Shared Files

Select

The Cloud 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 Cloud.

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

ProjectTeamMembers

Returns data from project team members table.

Select

The Cloud 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 Cloud.

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

PullRequestCommentChangeLog

Returns data from pull request comment changelog table.

Select

The Cloud 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 Cloud.

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

PullRequestCommentNotifications

Returns data from pull request comment notifications table.

Select

The Cloud 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 Cloud.

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

PullRequestCommentStars

Returns data from pull request comment starts table.

Select

The Cloud 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 Cloud.

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

Repositories

Returns data from project repositories table.

Select

The Cloud 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 Cloud.

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

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

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

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

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

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

SpaceUpdates

Returns recent updates in your space.

Select

The Cloud 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 Cloud.

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

TeamMembers

Returns data from team members table.

Select

The Cloud 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 Cloud.

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

Teams

Returns data from teams table.

Select

The Cloud 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 Cloud.

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

UserReceivedStars

Returns the list of stars that user received.

Select

The Cloud 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 Cloud.

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

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

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

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

UserRecentUpdates

Returns user recent updates.

Select

The Cloud 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 Cloud.

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

Users

Returns data from users table.

Select

The Cloud 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 Cloud.

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

WikiPageHistory

Returns history of Wiki page.

Select

The Cloud 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 Cloud.

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

WikiPageLinkedSharedFiles

Returns data from wiki page linked shred files table.

Select

The Cloud 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 Cloud.

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

WikiPageStars

Returns list of stars received on the Wiki page.

Select

The Cloud 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 Cloud.

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

WikiPageTags

Returns list of tags that are used in the project.

Select

The Cloud 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 Cloud.

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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Backlog.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Backlog, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Backlog Stored Procedures


Name	Description
AddStar	Adds star.
AttachFileToWiki	Attaches file to Wiki.
GetOwnUser	Returns own information about user.
LinkSharedFilesToWiki	Links Shared Files to Wiki.
MarkWatchingAsRead	Mark a watching as read.
PostAttachmentFile	Posts an attachment file for issue or wiki.
RemoveProjectIssueType	Delete the Project Issue Type.
RemoveProjectStatus	Delete the Project Status.
RemoveSharedFileFromWiki	Removes link to shared file from Wiki.
UpdatePullRequestCommentInformation	Updates pull request comment information.Authenticated user can update his own comments.
UpdateSpaceNotification	Updates space notification.

AddStar

Adds star.

Input


Name	Type	Required	Description
IssueId	String	False	Id of the issue.
CommentId	String	False	Id of the comment.
WikiId	String	False	Id of the wiki.
PullRequestId	String	False	Id of the pullRequest.
PullRequestCommentId	String	False	Id of the pullRequestComment.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

AttachFileToWiki

Attaches file to Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the issue.
AttachmentId	String	True	Id of the attachment. You can specify multiple ids separating them by comma ','.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the attachment succeeded.

GetOwnUser

Returns own information about user.

Stored Procedure Specific Information

Backlog does not allows columns to be used in the Exec query. For example:

EXECUTE GetOwnUser;

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.
Id	String	Id of the User.

LinkSharedFilesToWiki

Links Shared Files to Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the wiki.
SharedFileId	String	True	Id of the shared file. You can specify multiple ids separating them by comma ','.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

MarkWatchingAsRead

Mark a watching as read.

Input


Name	Type	Required	Description
WatchingId	String	True	Id of the watching.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

PostAttachmentFile

Posts an attachment file for issue or wiki.

Input


Name	Type	Required	Description
FileLocation	String	False	Location of the downloaded file. EX: C:\Temp\downloads\file.txt
FileName	String	False	File name that is uploaded. Required if content is not empty.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the upload succeeded.

RemoveProjectIssueType

Delete the Project Issue Type.

Stored Procedure Specific Information

Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE RemoveProjectIssueType ProjectId ='123844', Id = '530228', SubstituteIssueTypeId = '530140'

Input


Name	Type	Required	Description
ProjectId	String	True	ProjectId.
Id	String	True	Project Issue Type Id.
SubstituteIssueTypeId	String	True	Project Issue Type Id to change linked issue.

Result Set Columns


Name	Type	Description
Success	String	Returns true if procedure succeeded.

RemoveProjectStatus

Delete the Project Status.

Stored Procedure Specific Information

Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE RemoveProjectStatus ProjectId ='123844', Id = '4', SubstituteStatusId = '3'

Input


Name	Type	Required	Description
ProjectId	String	True	ProjectId.
Id	String	True	Project Status Id.
SubstituteStatusId	String	True	Project Status Id to replace linked issues statuses. Issues which status are set to the deleted status will be set to the specied substitute status.

Result Set Columns


Name	Type	Description
Success	String	Returns true if procedure succeeded.

RemoveSharedFileFromWiki

Removes link to shared file from Wiki.

Input


Name	Type	Required	Description
WikiId	String	True	Id of the wiki.
SharedFileId	String	True	Id of the shared file.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

UpdatePullRequestCommentInformation

Updates pull request comment information.Authenticated user can update his own comments.

Input


Name	Type	Required	Description
ProjectId	String	True	Id of the project.
RepositoryId	String	True	Id of the repository.
Number	String	True	Number of the pull request.
CommentId	String	True	Id of the comment.
Content	String	True	Content of the comment.

Result Set Columns


Name	Type	Description
Success	String	Returns True if procedure succeeded.

UpdateSpaceNotification

Updates space notification.

Input


Name	Type	Required	Description
Content	String	True	Content of the update.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the update succeeded.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Backlog:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Issues table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Issues'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the AddStar stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddStar' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Issues table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Issues'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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

Property	Description
URL	The URL of the Backlog account.
AuthScheme	The type of authentication to use when connecting to Backlog.
ApiKey	The API key allows you make requests to the Backlog API.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
IncludeCustomFields	Set this to true if you want to retrieve custom fields from the Issues table.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreads	The Max Thread.
Pagesize	Specifies the maximum number of results to return from Backlog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
ProjectId	Id of the specific project.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Authentication

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

Property	Description
URL	The URL of the Backlog account.
AuthScheme	The type of authentication to use when connecting to Backlog.
ApiKey	The API key allows you make requests to the Backlog API.

URL

The URL of the Backlog account.

Data Type

string

Default Value

""

Remarks

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

AuthScheme

The type of authentication to use when connecting to Backlog.

Possible Values

OAuth, APIToken

Data Type

string

Default Value

"APIToken"

Remarks

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

ApiKey

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

Data Type

string

Default Value

""

Remarks

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

OAuth

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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SSL

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

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

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

Data Type

string

Default Value

""

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.

Logging

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

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

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

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Miscellaneous

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

Property	Description
IncludeCustomFields	Set this to true if you want to retrieve custom fields from the Issues table.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreads	The Max Thread.
Pagesize	Specifies the maximum number of results to return from Backlog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
ProjectId	Id of the specific project.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

IncludeCustomFields

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

Data Type

bool

Default Value

false

Remarks

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

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

MaxThreads

The Max Thread.

Data Type

string

Default Value

"1"

Remarks

Pagesize

Specifies the maximum number of results to return from Backlog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

100

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

ProjectId

Id of the specific project.

Data Type

string

Default Value

""

Remarks

Id of the specific project.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Cloud

Backlog - CData Cloud

Overview

Key Features

Getting Started

Connecting to Backlog

Accessing Data from CData Cloud Services

Establishing a Connection

Authenticating to Backlog

API Key

OAuth

Headless Machines

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Views

Tables

Stored Procedures

Tables

CData Cloud - Backlog Tables

IssueAttachments

Select

INSERT

Update

Delete

Columns

IssueComments

Select

Insert

Update

Delete

Columns

Pseudo-Columns

IssueLinkedSharedFiles

Select

Insert

Update

Delete

Columns

Issues

Select

Insert

Update

Delete

Columns

Pseudo-Columns

ProjectAdministrators

Select

Insert

Update

Delete

Columns

ProjectCategories

Select

Insert

Update

Delete

Columns

ProjectCustomFieldItems

Select

Insert

Update

Delete

Columns

ProjectCustomFields

Select

Insert

Update

Delete

Columns

ProjectIssueTypes

Select

Insert

Update