Cloud

Build 24.0.9175
  • Zoho Projects
    • はじめに
      • 接続の確立
      • カスタムアプリへの接続
    • データモデル
      • User Portals
        • テーブル
          • Contacts
          • PortalClients
          • ProjectGroups
          • Projects
          • Tags
          • Teams
          • Users
        • ビュー
          • MyBugs
          • MyMilestones
          • MyTasks
          • MyTimelogs
          • ProjectCustomFields
          • ProjectCustomStatus
          • ProjectLayouts
          • TaskLayouts
          • TaskStatusHistory
          • TimesheetCustomFields
          • PortalUsersRemaining
      • User Projects
        • テーブル
          • BugAssociatedTasks
          • BugComments
          • BugEntityProperties
          • BugFollowers
          • Bugs
          • BugTimelogs
          • Events
          • ForumCategories
          • ForumComments
          • Forums
          • Milestones
          • ProjectEntityProperties
          • ProjectUsers
          • Statuses
          • TaskActivities
          • TaskComments
          • TaskCustomfields
          • TaskEntityProperties
          • Tasklists
          • Tasks
          • TaskSubtasks
          • TaskTimelogs
          • TeamUsers
        • ビュー
          • Activities
          • BugActivities
          • BugAttachments
          • BugCustomFields
          • BugResolution
          • Clients
          • Documents
          • TaskAttachments
          • Timelogs
      • All Portals
        • テーブル
          • Portals
      • ストアドプロシージャ
        • AddUserToClientCompany
        • ApproveTimelog
        • AssociateBugs
        • AssociateContacts
        • AssociateTags
        • DissociateBugs
        • DissociateContacts
        • DissociateTags
        • ForumFollow
        • ForumSelectBestAnswer
        • ForumUnfollow
        • ForumUnselectBestAnswer
        • SelectTeamLead
        • TaskFollow
        • TaskMove
        • TaskReorder
        • TaskUnfollow
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • Region
      • Connection
        • PortalId
        • ProjectId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AccountsServer
        • APIDomain
        • MaxRows
        • Pagesize
        • PseudoColumns
        • Timeout

Zoho Projects - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるZoho Projects へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してZoho Projects に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Zoho Projects への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Zoho Projects は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのZoho Projects への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Zoho Projects への接続

接続の確立 は、CData Cloud にデータベースを作成するためのZoho Projects への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してZoho Projects からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Zoho Projects に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Zoho Projects への接続

Region をサーバーURL のトップレベルドメイン(TLD)に設定します。

Zoho Projects への認証

Zoho Projects は、データに接続する2つの方法を提供します。

  • デスクトップ経由で自分のローカルデータに接続する場合(非ブラウザ接続)は、CData が提供する埋め込みOAuth アプリケーションを使用します。
  • ネットワーク経由で共有データに接続する場合(ブラウザ接続)は、カスタムOAuth アプリケーションを使用します。

すべてのOAuth フロー(埋め込みまたはカスタム)で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのZoho Projects への認証について詳しく説明します。

  • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
  • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
  • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Zoho Projects で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ:

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する際、次の接続プロパティを設定します。
    • InitiateOAuth:REFRESH。
    • OAuthClientId:アプリケーション設定のクライアントId。
    • OAuthClientSecret:アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation:Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId:アプリケーション設定のクライアントId。
    • OAuthClientSecret:アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムアプリへの接続

OAuth requires the authenticating user to interact with Zoho Projects using the browser. Cloud facilitates this in various ways as described below.

Registering an OAuth Application

Before you get started with authorization and make any calls to the Zoho CRM API, you need to register your application with Zoho CRM. You can follow the procedure below to obtain the OAuthClientId and OAuthClientSecret connection properties.

  1. Navigate to the Zoho Developer Console.
  2. Click Add Client Id, and enter the following application information:
    • Set the Client Name to a new name for this connection.
    • Set the Client Domain to the domain of your Application.
    • Set the Authorized Redirect URI to https://oauth.cdata.com/oauth/.
  3. Click Create to save the new application.

Connect to Your Custom Application

After creating your custom app, set the following connection properties in order to establish a connection, and click Connect:

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

CData Cloud

データモデル

Overview

The Cloud exposes all of the portals and projects tied to your Zoho Projects account, so you can access all of your Zoho Projects data with a single connection.

You can access:

  • portal-specific data
  • project-specific data
  • data pertaining to all portals

User Portals

The Cloud models each portal associated with your account as a catalog, named after the portal, containing a portal-specific schema called "ZohoProjects".

The User Portals section is a generic example of such a portal-specific schema.

User Projects

The Cloud models each portal associated with your account as a catalog, named after the portal. For every project in each of these catalogs, there is a project-specific schema, which is named after the project.

The User Projects section is a generic example of such a project-specific schema.

All Portals

The All Portals section contains data pertaining to all portals tied to your account.

CData Cloud

User Portals

Overview

The Cloud models each portal associated with your account as a catalog, named after the portal, containing a portal-specific schema called "ZohoProjects".

Tables

テーブル describes the available tables. Tables are statically defined to model Zoho Projects entities such as contacts, teams, projects, etc.

Views

ビュー describes the available views. Views are read-only tables that are statically defined to model Zoho Projects entities such as project and task layouts.

CData Cloud

テーブル

The Cloud models the entities for which Zoho Projects provides full or limited CRUD support as tables.

It models each portal tied to your account as a schema with the following tables.

Navigate to an individual table's page for a breakdown of its columns, as well as its supported filters and CRUD operations.

CData Cloud - Zoho Projects テーブル

Name Description
Contacts Fetches all client contacts from a portal.
PortalClients Returns the list of client companies in the portal.
ProjectGroups Gets all the groups for the specified project.
Projects Gets all the projects for the logged in user.
Tags Fetches all the tags present in a specific portal.
Teams Fetch the team details from the portal.
Users Gets the details of all the users in a specific project.

CData Cloud

Contacts

Fetches all client contacts from a portal.

Select

  • ClientId is required to retrieve Contacts.
For example, the following query is processed server side:
SELECT * FROM Contacts WHERE ClientId = '123456000000045005'

Insert

To create a new Contact you can specify the following fields:

  • ClientId
  • FirstName
  • LastName
  • Email
  • InvoiceRate
  • WorkProjects


INSERT INTO Contacts (WorkProjects, ClientId, FirstName, LastName, Email, Invoicerate)
VALUES ('123456000000031899', '123456000000039025', 'TestFirstname222', 'TestLastname222', '[email protected]', '15')

Update

To update a Contact specify the Id field.

UPDATE Contacts
	SET FirstName = 'updatedname', LastName = 'updatedlastname', email = '[email protected]'
	WHERE Id = '166135000000038075'

Delete

Contacts can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Contacts WHERE Id = '123456000000040053' 

Columns

Name Type ReadOnly Description
ClientId String False

Contact Client Id.

Id [KEY] String False

Contact Id.

CrmContactId String False

Contact Crm Contact Id.

DisplayName String False

Contact Display Name.

FirstName String False

Contact First Name.

LastName String False

Contact Last Name.

Email String False

Contact Email.

InvoiceRate String False

Contact Invoice Rate.

WorkProjects String False

Array of Project Ids. Multiple Ids can be separated with comma.

CData Cloud

PortalClients

Returns the list of client companies in the portal.

Select

You can use the below query to get all Portal Clients:
SELECT * FROM PortalClients

Insert

To create a new PortalClient you can specify the following fields:

  • Name
  • City
  • Country
  • State
  • FirstAddress
  • SecondAddress
  • WebAddress
  • ZipCode
  • UserEmail
  • WorkProjects
  • PrimaryClient


INSERT INTO PortalClients (Name, UserEmail, WebAddress, FirstAddress, SecondAddress, City, State, Country, PrimaryClient, ZipCode)
VALUES ('Company12', '[email protected]', 'www.example.com', 'Address line 1', 'Address line 2', 'Budapest', 'Hungary', 'Hungary', 'Yes', '1025')

Columns

Name Type ReadOnly Description
Id [KEY] String False

Client Id.

Name String False

Client Name.

City String False

Client City.

Country String False

Client Country.

State String False

Client State.

CrmAccountId String False

Client Crm Account Id.

FirstAddress String False

Client First Address.

SecondAddress String False

Client Second Address.

WebAddress String False

Client Web Address.

ZipCode String False

Client Zip Code.

UserId String False

Client User Id.

UserName String False

Client User Name.

UserEmail String False

Client User Email.

UserZpuid String False

Client User Zpuid.

WorkProjects String False

Client Work Projects.

PrimaryClient String False

Client Primary Client.

使用できる値は次のとおりです。Yes, No

CData Cloud

ProjectGroups

Gets all the groups for the specified project.

Select

You can use the below query to get all ProjectGroups:
SELECT * FROM ProjectGroups

Insert

To create a new ProjectGroup you can use the below query:

INSERT INTO ProjectGroups (name) VALUES ('New Project Group')

Delete

ProjectGroups can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM ProjectGroups WHERE Id = '123456000000045018'  

Columns

Name Type ReadOnly Description
Id [KEY] String False

Project Group Id.

Name String False

Project Group Name.

Default Boolean False

Is Default Project Group.

CData Cloud

Projects

Gets all the projects for the logged in user.

Select

Columns that support the = operator:
  • Id
  • CreatedDate
  • Status
  • LastModifiedTime

Columns that support the = and IN operator:
  • GroupId
  • Assignee

For example, the following query is processed server side:
SELECT * FROM Projects WHERE Id = '123456000000039053' 

Insert

To create a new Project you can specify the following fields:

  • Name
  • BillingStatus
  • BillingType
  • Currency
  • Description
  • Public
  • OwnerId
  • BudgetType
  • BudgetValue
  • Rate
  • BudgetTrackingMethod
  • FixedCost
  • TemplateId
  • Threshold
  • StartDate
  • EndDate
  • EnableRollup

To create a new Project specify the following fields:

INSERT INTO Projects (Name, BudgetType, BudgetValue, BillingStatus, BillingType, Currency, Description, Public, BudgetType, BudgetTrackingMethod)
VALUES ('New Project', '2', '2.5', 'Billable', '2', 'EUR', 'TestDescription 123', 'no', '2', '4')

Update

You can use the below query to update a Project:

UPDATE Projects 
	SET Currency = 'USD', SingleLinCustomField = 'New Custom Field Value' 
	WHERE Id = '123456000000039053'

Delete

Projects can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Projects WHERE Id = '123456000000039053' 

Columns

Name Type ReadOnly Description
Id [KEY] String False

Project Id.

Name String False

Project Name.

Key String False

Project Key.

BugsEnabled Boolean False

Project Bugs Enabled.

BillingStatus String False

Project Billing Status.

使用できる値は次のとおりです。Billable, Non Billable

BillingType String False

Mention the billing method for invoicing. (1 = Based on project hours, 2 = Based on staff hours, 3 = Fixed cost for project, 4 = Based on task / issue hours).

使用できる値は次のとおりです。1, 2, 3, 4

BugClientPermission String False

Project Bug Client Permission.

BugsClosed Integer False

Project Bugs Closed.

BugsOpen Integer False

Project Bugs Open.

BugsDefaultView String False

Project Bugs Default View.

BugsPrefix String False

Project Bugs Prefix.

CreatedDate Date False

Project Created Date.

CreatedDateTime Datetime False

Project Created Date Time.

CustomStatusColor String False

Project Custom Status Color.

CustomStatusId String False

Project Custom Status Id.

CustomStatusName String False

Project Custom Status Name.

Currency String False

The default currency of your project. Example: USD, INR, etc.

CurrencySymbol String False

Project Currency Symbol.

Description String False

Project Description.

EnabledTabs String False

Project Enabled Tabs.

ChatEnabled Boolean False

Project Chat Enabled.

ClientAssignBug String False

Project Client Assign Bug.

Public String False

Project Public.

使用できる値は次のとおりです。yes, no

SprintsProject Boolean False

Project Sprints Project.

Strict String False

Project Strict.

BugLayoutId String False

Project Bug Layout Id.

BugLayoutName String False

Project Bug Layout Name.

ProjectLayoutId String False

Project Project Layout Id.

ProjectLayoutName String False

Project Project Layout Name.

TaskLayoutId String False

Project Task Layout Id.

TaskLayoutName String False

Project Task Layout Name.

ActivityUrl String False

Project Activity Url.

BugUrl String False

Project Bug Url.

DocumentUrl String False

Project Document Url.

EventUrl String False

Project Event Url.

FolderUrl String False

Project Folder Url.

ForumUrl String False

Project Forum Url.

MilestoneUrl String False

Project Milestone Url.

SelfUrl String False

Project Self Url.

StatusUrl String False

Project Status Url.

TaskUrl String False

Project Task Url.

TasklistUrl String False

Project Tasklist Url.

TimesheetUrl String False

Project Timesheet Url.

UserUrl String False

Project User Url.

MilestoneClosed Integer False

Project Milestone Closed.

MilestoneOpen Integer False

Project Milestone Open.

OwnerId String False

Project Owner Id.

OwnerName String False

Project Owner Name.

OwnerZpUid String False

Project Owner Zp Uid.

ProfileId Long False

Project Profile Id.

ProjectPercent String False

Project Project Percent.

Role String False

Project Role.

ShowProjectOverview Boolean False

Project Show Project Overview.

Status String False

Project Status.

使用できる値は次のとおりです。active, archived, template

SettingsDate Boolean False

Project Settings Date.

SettingsLogHours Boolean False

Project Settings Log Hours.

SettingsPercentage Boolean False

Project Settings Percentage.

SettingsPlan Boolean False

Project Settings Plan.

SettingsWorkHours Boolean False

Project Settings Work Hours.

TaskClosed Integer False

Project Task Closed.

TaskOpen Integer False

Project Task Open.

TaskbugPrefix String False

Project Taskbug Prefix.

UpdatedDate Date False

Project Updated Date.

UpdatedDateTime Datetime False

Project Updated Date Time.

WorkspaceId String False

Project Workspace Id.

BudgetType String False

Type of your budget. Accepted values 0, 1, 2, 3, 4, 5 and 6. (0 = None, 1 = Based on amount, 2 = Based on hours, 3 = Based on milestone amount, 4 = Based on milestone hours, 5 = Based on task amount and 6 = Based on task hours).

使用できる値は次のとおりです。1, 2, 3, 4, 5, 6

BudgetTypeValue String False

Project Budget Type Value.

BudgetValue String False

Project Budget Value.

Rate String False

Project Rate.

BudgetTrackingMethod String False

Method to track your project budget. Accepted values 1, 2, and 4. (1 = Project hours, 2 = Staff hours, 4 = Task / Issue hours).

FixedCost String False

Project Fixed Cost.

TemplateId String False

Project Template Id.

Threshold String False

Specify the budget threshold limit (Amount or hours)..

StartDate String False

Project Start Date.

EndDate String False

Project End Date.

EnableRollup String False

Project Enable Rollup.

使用できる値は次のとおりです。Yes, No

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastModifiedTime Datetime

Project Last Modified Time.

GroupId String

Project Group Id.

Assignee String

Project Assignee.

CData Cloud

Tags

Fetches all the tags present in a specific portal.

Select

You can use the below query to get all Tags:
SELECT * FROM Tags

Insert

To create a new Tag you can specify the following fields:

INSERT INTO Tags (Name, ColorClass) VALUES ('New Tag', 'bg-tag16') 

Update

To update a Tag specify the Id field.

UPDATE Tags SET Name = 'Updated Name', ColorClass = 'bg-tag99' WHERE Id = '123456000000043057'

Delete

Tags can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Tags WHERE Id = '123456000000043057' 

Columns

Name Type ReadOnly Description
Id [KEY] String False

Tag Id.

Name String False

Tag Name.

ColorClass String False

Tag Color Class.

CreatedBy String False

Tag Created By.

CreatedByName String False

Tag Created By Name.

CreatedByEmail String False

Tag Created By Email.

CreatedByFirstName String False

Tag Created By First Name.

CreatedByLastName Unknown False

Tag Created By Last Name.

CreatedByIsClientUser Boolean False

Tag Created By Is Client User.

CreatedByZpuid String False

Tag Created By Zpuid.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Tags String

CData Cloud

Teams

Fetch the team details from the portal.

Select

You can use the below query to get all Teams:
SELECT * FROM Teams

Insert

To create a new Team you can specify the following fields:

  • GroupName
  • EmailAlias
  • UserIdArr
  • ProjIds
  • TeamLead


INSERT INTO Teams (GroupName, UserIdArr, TeamLead, ProjIds)" +
VALUES ('TestTeam5', '["123456000000031003", "123456000000032055"]', '123456000000032055', '["123456000000031899"]

Update

To update a Team specify the GroupId field.

UPDATE Teams
SET TeamLead = '123456000000031003', 
	UserIdArr = '["123456000000031003", "123456000000032055"]',
	ProjIds = '["123456000000031899"]', 
	GroupName = 'TestTeam5' 
WHERE GroupId = '123456000000036001'

Delete

Teams can be deleted by providing the GroupId and issuing a DELETE statement.

DELETE FROM Teams WHERE GroupId = '123456000000044025' 

Columns

Name Type ReadOnly Description
GroupId [KEY] String False

Group Id of the team.

GroupName String False

Group Name of the team.

CreatedBy String False

Team Created By.

CreatedTime String False

Created Time of the team.

Description String False

Description of the team.

EmailAlias String False

Email Id of the team.

EmailVerified Boolean False

Email Verified of the team.

OrgId String False

Organization Id of the team.

OwnerEmail String False

Owner Email of the team.

OwnerName String False

Owner Name of the team.

OwnerZpuid String False

Owner Zpuid of the team.

OwnerZuid String False

Owner Zuid of the team.

Prefix String False

Prefix of the team.

UpdatedBy String False

Updated By of the team.

UpdatedTime String False

Updated Time of the team.

HasGroupEdit Boolean False

Has Group Edit of the team.

ProjectCount Integer False

Project Count of the team.

UserCount Integer False

User Count of the team.

UserIdArr String False

Array of multiple Zpuid.

UserObj String False

User Object of the team.

ProjIds String False

Array of multiple project Ids.

TeamLead String False

ZPuid of the team lead.

CData Cloud

Users

Gets the details of all the users in a specific project.

Columns

Name Type ReadOnly Description
Id [KEY] String False

User Id.

Name String False

User Name.

Active Boolean False

User Active.

ChatAccess Boolean False

User Chat Access.

Email String False

User Email.

PortalProfileName String False

User Portal Profile Name.

PortalRoleId String False

User Portal Role Id.

PortalRoleName String False

User Portal Role Name.

ProfileId String False

User Profile Id.

ProfileType String False

User Profile Type.

ProjectProfileId String False

User Project Profile Id.

Role String False

User Role.

使用できる値は次のとおりです。manager, employee, contractor

RoleId String False

User Role Id.

RoleName String False

User Role Name.

Zpuid String False

User Zpuid.

WorkProjects String False

User Work Projects.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UserType String

User Type.

使用できる値は次のとおりです。active, inactive

CData Cloud

ビュー

The Cloud models the entities for which Zoho Projects only provides read-only access as views.

It exposes each portal tied to your account as a schema with the following views.

Navigate to an individual view's page for a breakdown of its columns and supported filters.

CData Cloud - Zoho Projects ビュー

Name Description
MyBugs Lists all the bugs created by you or assigned to you.
MyMilestones Get all the milestones assigned to a particular user in the given project.
MyTasks Gets all your tasks in the portal.
MyTimelogs Gets the time logs under a specific bug.
ProjectCustomFields Gets all the project custom fields.
ProjectCustomStatus Gets list of all project custom status.
ProjectLayouts Gets list of project layouts.
TaskLayouts View the list of all the task layouts available in your portal.
TaskStatusHistory Fetches status history of tasks from the Portal.
TimesheetCustomFields Fetch all timesheet custom fields across the project.
PortalUsersRemaining Gets the details of all users in a specific portal.

CData Cloud

MyBugs

Lists all the bugs created by you or assigned to you.

Select

This is a portal-level view.
  • StatusType, Owner, ViewType and ViewType support the following operator: =.
  • CreatedDate and LastModifiedTime support: ORDER
For example, the following query is processed server side:
SELECT * FROM MyBugs WHERE Owner = '12345021738' AND ViewType = 'owned' AND StatusType = 'open' ORDER BY CreatedDate

Columns

Name Type Description
Id [KEY] String Bug Id.
Key String Bug Key.
Title String Bug Title.
AssigneeId String Bug Assignee Id.
AssigneeName String Bug Assignee Name.
AssigneeZpuid String Bug Assignee ZPUID.
AttachmentCount String Bug Attachment Count.
BugPrefix String Bug Prefix.
ClassificationId Long Bug Classification Id.
ClassificationType String Bug Classification Type.
Closed Boolean Bug Closed.
CommentCount String Bug Comment Count.
CreatedDate Date Bug Created Date.
CreatedDateTime Datetime Bug Created Date Time.
Description String Bug Description.
DueDate Date Bug Due Date.
DueDateTime Date Bug Due Date Time.
Flag String Bug Flag.
LinkSelfUrl String Bug Link Self Url.
LinkTimesheetUrl String Bug Link Timesheet Url.
ModuleId Long Bug Module Id.
ModuleName String Bug Module Name.
ProjectId Long Bug Project Id.
ProjectIdString String Bug Project Id String.
ProjectName String Bug Project Name.
ReportedPerson String Bug Reported Person.
ReporterId String Bug Reporter Id.
ReproducibleId Long Bug Reproducible Id.
ReproducibleType String Bug Reproducible Type.
SeverityId Long Bug Severity Id.
SeverityType String Bug Severity Type.
StatusId Long Bug Status Id.
StatusType String Bug Status Type.

使用できる値は次のとおりです。open, closed

UpdatedDate Date Bug Updated Date.
UpdatedDateTime Datetime Bug Updated Date Time.
UpdatedTimeLong Long Bug Updated Time Long.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Owner String Bug Owner.
ViewType String Bug View Type.

使用できる値は次のとおりです。reported, owned

LastModifiedTime Datetime Bug Last Modified Time.

CData Cloud

MyMilestones

Get all the milestones assigned to a particular user in the given project.

Select

This is a portal-level view.
  • ProjectId and Flag support the following operator: =.
  • ProjectId supports the operator: IN
  • CreatedDate and LastModifiedTime support: ORDER
For example, the following query is processed server side:
SELECT * FROM MyMilestones WHERE ProjectId IN ('12345000000030899', '12345000000033005') AND Flag = 'internal' ORDER BY CreatedDate

Columns

Name Type Description
ProjectId String Project Id.
Id [KEY] String Milestone Id.
Name String Milestone Name.
Closed Boolean Milestone Closed.
CreatedDate Date Milestone Created Date.
CreatedDateTime Datetime Milestone Created Date Time.
EndDate Date Milestone End Date.
EndDateTime Datetime Milestone End Date Time.
Flag String Milestone Flag.

使用できる値は次のとおりです。internal, external

IsWorkfieldRemoved Boolean Milestone Is Work Field Removed.
LastUpdatedDate Date Milestone Last Updated Date.
LastUpdatedDateTime Datetime Milestone Last Updated Date Time.
SelfUrl String Milestone Self Url.
StatusUrl String Milestone Status Url.
OwnerId String Milestone Owner Id.
OwnerName String Milestone Owner Name.
OwnerZpuid String Milestone Owner ZPUID.
ProjectName String Milestone Project Name.
Sequence Integer Milestone Sequence.
StartDate Date Milestone Start Date.
StartDateTime Datetime Milestone Start Date Time.
Status String Milestone Status.
StatusColorCode String Milestone Status Color Code.
StatusId String Milestone Status Id.
StatusName String Milestone Status Name.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastModifiedTime Datetime Milestone Last Modified Time.

CData Cloud

MyTasks

Gets all your tasks in the portal.

Select

This is a portal-level view. Columns that support the = operator:
  • Id
  • CreatedBy
  • MilestoneId
  • Priority
  • TasklistId
  • Owner
  • Status
  • Time
  • LastModifiedTime
  • ViewId

For example, the following query is processed server side:
SELECT * FROM MyTasks WHERE MilestoneId = '12345600000123' AND Priority = 'High' 

Columns

Name Type Description
ProjectId String Project Id.
Id [KEY] String Task Id.
Name String Task Name.
Key String Task Key.
BillingType String Task Billing Type.
Completed Boolean Task Completed.
CreatedBy String Task Created By.
CreatedByEmail String Task Created By Email.
CreatedByZpuid String Task Created By Zpuid.
CreatedPerson String Task Created Person.
CreatedDate Date Task Created Date.
CreatedDateTime Datetime Task Created Date Time.
Description String Task Description.
Owners String Task Owners.
Duration String Task Duration.
DurationType String Task Duration Type.
EndDate Date Task End Date.
EndDateTime Datetime Task End Date Time.
CommentAdded Boolean Task Comment Added.
DocsAssociated Boolean Task Docs Associated.
ForumAssociated Boolean Task Forum Associated.
RecurrenceSet Boolean Task Recurrence Set.
ReminderSet Boolean Task Reminder Set.
Parent Boolean Task Parent.
LastUpdatedDate Date Task Last Updated Date.
LastUpdatedDateTime Datetime Task Last Updated Date Time.
LinkSelfUrl String Task Link Self Url.
LinkTimesheetUrl String Task Link Timesheet Url.
LinkWebUrl String Task Link Web Url.
LogHoursBillableHours String Task Log Hours Billable Hours.
LogHoursNonBillableHours String Task Log Hours Non Billable Hours.
MilestoneId String Task Milestone Id.
OrderSequence Integer Task Order Sequence.
PercentComplete String Task Percent Complete.
Priority String Task Priority.

使用できる値は次のとおりです。none, low, medium, high

StartDate Date Task Start Date.
StartDateTime Datetime Task Start Date Time.
StatusColorCode String Task Status Color Code.
StatusId String Task Status Id.
StatusName String Task Status Name.
StatusType String Task Status Type.
Subtasks Boolean Task Subtasks.
TaskFollowers String Task Task Followers.
TaskFollowerSize Integer Task Task Follower Size.
TasklistId String Task Tasklist Id.
TasklistIdString String Task Tasklist Id String.
TasklistName String Task Tasklist Name.
Work String Task Work.
WorkForm String Task Work Form.
WorkType String Task Work Type.
GroupNameAssociatedTeamsAnyTeam String Task Group Name Associated Teams Any Team.
GroupNameAssociatedTeamsCount Integer Task Group Name Associated Teams Count.
GroupNameIsTeamUnassigned Boolean Task Group Name Is Team Unassigned.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Owner String Task Owner.
Status String Task Status.

使用できる値は次のとおりです。completed, notcompleted

Time String Task Time.

使用できる値は次のとおりです。overdue, today, tomorrow

LastModifiedTime Datetime Task Last Modified Time.
CustomViewId String Task Custom View Id.

CData Cloud

MyTimelogs

Gets the time logs under a specific bug.

Select

This is a portal-level view. Columns that support the = operator:
  • BillStatus
  • User
  • ComponentType

Columns that support the >,>=,=,<,<= operators:
  • Date
  • LastModifiedDate

For example, the following queries are processed server side:
SELECT * FROM MyTimelogs WHERE User = '123450000123'

SELECT * FROM MyTimelogs WHERE Date > '2024-01-01'

SELECT * FROM MyTimelogs WHERE LastModifiedDate > '2024-01-01'
Querying MyTimeLogs without filters will return data for only the current month:
SELECT * FROM MyTimelogs

Columns

Name Type Description
Id [KEY] String Time Log Id.
AddedByName String Time Log Added By Name.
AddedByZpuid String Time Log Added By Zpuid.
AddedByZuid Long Time Log Added By Zuid.
ApprovalStatus String Time Log Approval Status.
ApproverName String Time Log Approver Name.
BillStatus String Time Log Bill Status.

使用できる値は次のとおりです。all, billable, non billable

CreatedDate Date Time Log Created Date.
CreatedDateTime Datetime Time Log Created Date Time.
StartTime Datetime Time Log Start Time.
EndTime Datetime Time Log End Time.
Notes String Time Log Notes.
HoursDisplay String Time Log Hours Display.
Hours Integer Time Log Hours.
Minutes Integer Time Log Minutes.
IsParent Boolean Time Log Is Parent.
IsSubTask Boolean Time Log Is Sub Task.
LastModifiedDate Date Time Log Last Modified Date.
LastModifiedDateTime Datetime Time Log Last Modified Date Time.
LinkSelfUrl String Time Log Link Self Url.
LogDate Date Time Log Date.
LogDateTime Datetime Time Log Date Time.
OwnerId String Time Log Owner Id.
OwnerName String Time Log Owner Name.
SubTaskLevel String Time Log Sub Task Level.
TaskName String Time Log Task Name.
TaskListId Long Time Log Task List Id.
TaskListName String Time Log Task List Name.
TotalMinutes Integer Time Log Total Minutes.
ProjectId String Time Log Project Id.
ProjectName String Time Log Project Name.
Date Date Time Log Date.
User String Time Log User.
ComponentType String Time Log Component Type.

使用できる値は次のとおりです。bug, task, general

CData Cloud

ProjectCustomFields

Gets all the project custom fields.

Select

You can use the below query to get all Project Custom Fields:
SELECT * FROM ProjectCustomFields

Columns

Name Type Description
Id [KEY] String Custom Field Id.
Name String Custom Field Name.
FieldType String Custom Field Type.
FieldId String Field Id.
PII Boolean Custom Field PII.
Encrypted Boolean Encrypted.
DefaultValue String Custom Field Default Value.
PickList String Custom Field Pick List Options.

CData Cloud

ProjectCustomStatus

Gets list of all project custom status.

Select

You can use the below query to get all Project Custom Statuses:
SELECT * FROM ProjectCustomStatus

Columns

Name Type Description
Id [KEY] String Portal Id.
Name String Portal Name.
Closed Boolean Portal Closed.
Default Boolean Portal Default.
HasDefaultValue Boolean Portal Has Default Value.
Sequence Int Portal Sequence.
StatusColor String Portal Status Color.
StatusColorHexcode String Portal Status Color Hex Code.

CData Cloud

ProjectLayouts

Gets list of project layouts.

Select

You can use the below query to get all Project Layouts:
SELECT * FROM ProjectLayouts

Columns

Name Type Description
Id [KEY] String Project Layout Id.
Name String Project Layout Name.
Default Boolean Is Default Project Layout.

CData Cloud

TaskLayouts

View the list of all the task layouts available in your portal.

Select

This is a portal-level view. You can use the below query to get all Task Layouts:
SELECT * FROM TaskLayouts

Columns

Name Type Description
Id [KEY] String Task Layout Id.
Name String Task Layout Name.
Default Boolean Task Layout Default.

CData Cloud

TaskStatusHistory

Fetches status history of tasks from the Portal.

Select

This is a portal-level view.
  • LastModifiedTime supports: ORDER
You can use the below query to get all Task Layouts:
SELECT * FROM TaskStatusHistory ORDER BY LastModifiedTime

Columns

Name Type Description
Id [KEY] String Task Status History Id.
Name String Task Status History Name.
StatusId String Task Status History Status Id.
StatusName String Task Status History Status Name.
PreviousStatusId String Task Status History Previous Status Id.
PreviousStatusName String Task Status History Previous Status Name.
UpdatedStatusId String Task Status History Updated Status Id.
UpdatedStatusName String Task Status History Updated Status Name.
TransitionTimeMillis String Task Status History Transition Time Millis.
TransitionTimeDuration String Task Status History Transition Time Duration.
UpdatedBy String Task Status History Updated By.
UpdatedByName String Task Status History Updated By Name.
UpdatedByEmail String Task Status History Updated By Email.
UpdatedOn Datetime Task Status History Updated On.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastModifiedTime Datetime Task Status History Last Modified Time.

CData Cloud

TimesheetCustomFields

Fetch all timesheet custom fields across the project.

Select

This is a portal-level view. You can use the below query to get all Timesheet Custom Fields:
SELECT * FROM TimesheetCustomFields

Columns

Name Type Description
Id [KEY] String Time Sheet Custom Field Id.
FieldName String Time Sheet Custom Field Name.
DataType String Time Sheet Custom Field Data Type.
UniqueColumn String Time Sheet Custom Field Unique Column.

CData Cloud

PortalUsersRemaining

Gets the details of all users in a specific portal.

Columns

Name Type Description
AvailableUsersCount String Available User Count.

CData Cloud

User Projects

Overview

The Cloud models each portal associated with your account as a catalog, named after the portal. For every project in each of these catalogs, there is a project-specific schema, which is named after the project.

Tables

テーブル describes the available tables. Tables are statically defined to model Zoho Projects entities such as bugs, events, tasks, etc.

Views

ビュー describes the available views. Views are read-only tables that are statically defined to model Zoho Projects entities such as activities, clients, documents, etc.

CData Cloud

テーブル

The Cloud models the entities for which Zoho Projects provides full or limited CRUD support as tables.

It models each project tied to your account as a schema with the following tables.

Navigate to an individual table's page for a breakdown of its columns, as well as its supported filters and CRUD operations.

CData Cloud - Zoho Projects テーブル

Name Description
BugAssociatedTasks Fetches the details of the task associated with a bug.
BugComments Fetch comments for the bug.
BugEntityProperties Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.
BugFollowers Get list of followers for the bug.
Bugs Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.
BugTimelogs Gets the time logs under a specific bug.
Events Fetches all the tags present in a specific portal.
ForumCategories Gets all the forum categories.
ForumComments Gets all the forum comments.
Forums Gets all the forums in the given project.
Milestones Gets list of project layouts.
ProjectEntityProperties Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.
ProjectUsers Gets the details of all the users in a specific project.
Statuses Gets the statuses for the given project.
TaskActivities Retrieve details of who modified a specific task and when.
TaskComments Get all the task comments.
TaskCustomfields Usage information for the operation TaskCustomfields.rsd.
TaskEntityProperties Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.
Tasklists Get all the task lists in the given project.
Tasks Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.
TaskSubtasks View all the subtasks of the given task.
TaskTimelogs Gets the time logs under a specific task.
TeamUsers Fetch details of a particular team.

CData Cloud

BugAssociatedTasks

Fetches the details of the task associated with a bug.

Table Specific Information

This table shows associations between Bugs and Tasks.

Select

  • BugId supports the following operator: =.
For example, the following query is processed server side:
SELECT * FROM BugAssociatedTasks WHERE BugId = '123439000000045005'

Insert

To add a new bug-task association specify the BugId and TaskId fields.

INSERT INTO BugAssociatedTasks (BugId, TaskId) VALUES ('123418000000045005', '["123418000000044005"]') 

Delete

To delete an existing bug-task association specify the BugId and TaskId fields.

DELETE FROM BugAssociatedTasks WHERE BugId = '123418000000045005' AND TaskId = '123418000000044005'

Columns

Name Type ReadOnly Description
BugId String False

Bug Id.

TaskId String False

Associated Task Id.

TaskName String False

Associated Task Name.

Prefix String False

Associated Task Prefix.

ProjectId String False

Associated Task Project Id.

TaskOwners String False

Associated Task Owners.

TaskPercentageCompleted String False

Associated Task Percentage Completed.

TaskPriority String False

Associated Task Priority.

TaskListId String False

Associated Task List Id.

CData Cloud

BugComments

Fetch comments for the bug.

Select

  • BugId is required to retrieve Bug Comments.
For example, the following query is processed server side:
SELECT * FROM BugComments WHERE BugId = '123456000000045005'

Insert

To add a Bug Comment specify the BugId and Comment fields.

INSERT INTO BugComments (BugId, Comment) VALUES ('123456000000045005', 'Test Comment #1')

Delete

Bug Comments can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM BugComments WHERE BugId = '123456000000045005' AND Id = '123456000000045042'

Columns

Name Type ReadOnly Description
BugId [KEY] String False

Bug Id.

Id [KEY] String False

Bug Comment Id.

Comment String False

Bug Comment Content.

AddedBy String False

Bug Comment Added By.

AddedPersonName String False

Bug Comment Added Person Name.

CreatedDate Date False

Bug Comment Created Date.

CreatedDateTime Datetime False

Bug Comment Created Date Time.

UpdatedBy String False

Bug Comment Updated By.

UpdatedPerson String False

Bug Comment Updated Person.

UpdatedDate Date False

Bug Comment Updated Date.

UpdatedDateTime Datetime False

Bug Comment Updated Date Time.

CData Cloud

BugEntityProperties

Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.

Table Specific Information

Entity-properties are key-value pairs stored against the bug entities. They can be used for storing details that are needed for API integrations but don't have to be visible in the UI. The key has to be a String and the Value could be a simple string or a json object. You can store multiple key-value pair for a single entity. These entity properties can be stored / retrieved / updated / deleted using the following queries.

Select

  • BugId and PropertyKey are required to retrieve Bug Entity Properties.
For example, the following query is processed server side:
SELECT * FROM BugEntityProperties WHERE BugId = '123456000000034087' AND PropertyKey = 'key1' 

Insert

To add a new Bug Entity Property specify the BugId, PropertyKey and PropertyValue fields.

INSERT INTO BugEntityProperties (BugId, PropertyKey, PropertyValue) VALUES ('123456000000034087', 'key1', 'This is a test value')

Update

ZohoProjects allows updates for the PropertyValue column.

UPDATE BugEntityProperties SET PropertyValue = 'This is an updated property value' WHERE BugId = '123456000000034087' AND PropertyKey = 'key1'

Delete

Bug Entity Properties can be deleted by providing Id, BugId, PropertyKey and issuing a DELETE statement.

DELETE FROM BugEntityProperties WHERE BugId = '166135000000034087' AND PropertyKey = 'key1' AND Id = '166135000000035001'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Bug Entity Property Id.

BugId [KEY] String False

Bug Id.

PropertyKey [KEY] String False

Bug Entity Property Key.

PropertyValue String False

Bug Entity Property Value.

CData Cloud

BugFollowers

Get list of followers for the bug.

Select

  • BugId is required to retrieve Bug Followers.
For example, the following query is processed server side:
SELECT * FROM BugFollowers WHERE BugId = '123456000000042110'

Insert

To add a Bug Follower specify the BugId and Follower fields.

INSERT INTO BugFollowers (BugId, BugFollowers) VALUES ('123456000000042110', '12345649448')

Delete

Bug Followers can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM BugFollowers WHERE BugId = '123456000000042110'  AND  FollowerId = '12345649448'

Columns

Name Type ReadOnly Description
BugId [KEY] String False

Bug Id.

FollowerId String False

Bug Follower Id.

FollowerName String False

Bug Follower Name.

BugFollowers String False

Bug Followers.

CData Cloud

Bugs

Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.

Select

Columns that support the = operator:
  • Id
  • CreatedTime
  • Flag
  • StatusType
  • CustomViewId

Columns that support the = and IN operator:
  • AssigneeId
  • ClassificationId
  • EscalationLevel
  • ModuleId
  • SeverityId
  • StatusId
  • ReporterId
  • MilestoneId
  • AffectedMilestoneId

For example, the following query is processed server side:
SELECT * FROM Bugs 
	WHERE ReporterId IN ('12341021738')
	AND AssigneeId IN ('12341021738')
	AND ClassificationId IN ('123456000000030015')
	AND EscalationLevel IN ('0')
	AND Flag = 'Internal'
	AND ModuleId IN ('123456000000030145')
	AND SeverityId IN ('123456000000030151')
	AND StatusId IN ('123456000000030083')

Insert

To create a new Bug, you can specify the following fields:

  • Title
  • AssigneeId
  • ClassificationId
  • Description
  • DueDate
  • Flag
  • ModuleId
  • ReproducibleId
  • SeverityId
  • HourlyRate
  • BugFollowers
  • MilestoneId

To create a new Bug, specify the following fields:

INSERT INTO Bugs (Title, Description, AssigneeId, flag, ClassificationId, DueDate, ModuleId, SeverityId, ReproducibleId, HourlyRate, CustomField1)
VALUES ('SQL Inserted Bug #5', 'Test Description', '12341249448', 'Internal', '123456000000031015', '2022-03-20', '123456000000031145', '123456000000031149', '123456000000031053', '2', 'TestCustomField')

Update

You can use the below query to update a bug:

UPDATE Bugs
SET Title = 'SQL Inserted Bug #5',
    Description = 'Another Test Description',
    AssigneeId = '20081249448',
    ClassificationId = '165818000000031015',
    DueDate = '2022-03-20',
    ModuleId = '165818000000031145',
    SeverityId = '165818000000031149',
    ReproducibleId = '165818000000031053',
    HourlyRate = '2',
    cf1 = 'Custom Field Edited #1'
WHERE Id = '165818000000042126'

Delete

Bugs can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Bugs WHERE Id = '123456000000042126' 

Columns

Name Type ReadOnly Description
Id [KEY] String False

Bug Id.

Key String False

Bug Key.

Title String False

Bug Title.

AssigneeId String False

Bug Assignee Id.

AssigneeName String False

Bug Assignee Name.

AssigneeZpuid String False

Bug Assignee ZPUID.

AttachmentCount String False

Bug Attachment Count.

BugNumber String False

Bug Number.

BugPrefix String False

Bug Prefix.

ClassificationId Long False

Bug Classification Id.

ClassificationType String False

Bug Classification Type.

Closed Boolean False

Bug Closed.

CommentCount String False

Bug Comment Count.

CreatedTime Date False

Bug Created Time.

CreatedDateTime Datetime False

Bug Created Date Time.

Description String False

Bug Description.

DueDate Date False

Bug Due Date.

DueDateTime Datetime False

Bug Due Date Time.

EscalationLevel String False

Bug Escalation Level.

Flag String False

Bug Flag.

使用できる値は次のとおりです。internal, external

LinkSelfUrl String False

Bug Link Self Url.

LinkTimesheetUrl String False

Bug Link Timesheet Url.

LinkWebUrl String False

Bug Link Web Url.

ModuleId Long False

Bug Module Id.

ModuleName String False

Bug Module Name.

ReportedPerson String False

Bug Reported Person.

ReporterEmail String False

Bug Reporter Email.

ReporterId String False

Bug Reporter Id.

ReporterNonZuser String False

Bug Reporter Non User.

ReproducibleId Long False

Bug Reproducible Id.

ReproducibleType String False

Bug Reproducible Type.

SeverityId Long False

Bug Severity Id.

SeverityType String False

Bug Severity Type.

StatusColorcode String False

Bug Status Color Code.

StatusId String False

Bug Status Id.

StatusType String False

Bug Status Type.

使用できる値は次のとおりです。open, closed

UpdatedDate Date False

Bug Updated Date.

UpdatedDateTime Datetime False

Bug Updated Date Time.

GroupNameAssociatedTeamsAnyTeam String False

Bug Group Name Associated Teams by Any Team.

GroupNameAssociatedTeamsCount Integer False

Bug Group Name Associated Teams Count.

GroupNameIsTeamUnassigned Boolean False

Bug Group Name Is Team Unassigned.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
HourlyRate String

Bug Hourly Rate.

BugFollowers String

Bug Bug Followers.

CustomViewId String

Bug Custom View Id.

MilestoneId String

Bug Milestone Id.

AffectedMilestoneId String

Bug Affected Milestone Id.

CData Cloud

BugTimelogs

Gets the time logs under a specific bug.

Select

  • BugId is required to retrieve Bug Time Logs.
For example, the following query is processed server side:
SELECT * FROM BugTimelogs WHERE BugId = '123456000000045005'

Insert

To add a Bug TimeLog specify the BugId and Follower fields.

INSERT INTO BugTimelogs (BugId, LogDate, BillStatus, HoursDisplay, Notes)
VALUES ('123456000000045005', '2022-03-03', 'Non Billable', '01:20', 'This is a test timelog')

Update

To update a Bug TimeLog specify the BugId and Id fields.

UPDATE BugTimelogs
	SET Notes = 'This is an updated SQL Note'
	WHERE BugId = '165818000000045005' AND Id = '123456000000044025'

Delete

Bug TimeLogs can be deleted by providing the BugId and Id and issuing a DELETE statement.

DELETE FROM BugTimelogs WHERE BugId = '123456000000045005' AND Id = '123456000000044025'

Columns

Name Type ReadOnly Description
BugId [KEY] String False

Bug Id.

Id [KEY] String False

Bug Time Log Id.

AddedByName String False

Bug Time Log Added By Name.

AddedByZpuid String False

Bug Time Log Added By ZPUID.

AddedByZuid Long False

Bug Time Log Added By ZUID.

ApprovalStatus String False

Bug Time Log Approval Status.

ApproverName String False

Bug Time Log Approver Name.

BillStatus String False

Bug Time Log Bill Status.

使用できる値は次のとおりです。Billable, Non Billable

BugTitle String False

Bug Time Log Bug Title.

CreatedDate Date False

Bug Time Log Created Date.

CreatedDateTime Datetime False

Bug Time Log Created Date Time.

Hours Integer False

Bug Time Log Hours.

Minutes Integer False

Bug Time Log Minutes.

HoursDisplay String False

Bug Time Log Hours Display.

LastModifiedDate Date False

Bug Time Log Last Modified Date.

LastModifiedDateTime Datetime False

Bug Time Log Last Modified Date Time.

LinkSelfUrl String False

Bug Time Log Link Self Url.

LogDate Date False

Bug Time Log Date.

LogDateTime Datetime False

Bug Time Log Date Time.

Notes Unknown False

Bug Time Log Notes.

OwnerId String False

Bug Time Log Owner Id.

OwnerName String False

Bug Time Log Owner Name.

TotalMinutes Integer False

Bug Time Log Total Minutes.

CData Cloud

Events

Fetches all the tags present in a specific portal.

Select

  • Status supports the following operator =.
For example, the following query is processed server side:
SELECT * FROM Events WHERE Status = 'open'

Insert

To create a new Event you can specify the following fields:

  • Title
  • DurationHour
  • DurationMinutes
  • Location
  • Participants
  • Reminder
  • Repeat
  • ScheduledOn
  • RepeatTimes


INSERT INTO Events (Title, ScheduledOn, DurationHour, DurationMinutes, Participants, Reminder, Repeat, Location)
	VALUES ('SQL Event #2', '2022-03-20T18:00:00', '2', '30', '20081249448', '15 mins', 'only once', 'Test Location 2')

Update

To update an Event specify the Id field.

UPDATE Events
	SET title = 'Updated Title #1', DurationHour = '4', DurationMinutes = '10', ScheduledOn = '2022-05-01T23:12:00', Participants = '20081249448'
	WHERE Id = '123456000000045018'

Delete

Events can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Events WHERE Id = '123456000000045018'  

Columns

Name Type ReadOnly Description
Id [KEY] String False

Event Id.

Title String False

Event Title.

CreatedBy String False

Event Created By.

CreatedByZpuid String False

Event Created By ZPUID.

CreatedOn Long False

Event Created On.

DurationHour String False

Event Duration Hour.

DurationMinutes String False

Event Duration Minutes.

Location String False

Event Location.

Occurred Integer False

Event Occurred.

Occurrences Integer False

Event Occurrences.

Participants String False

Event Participants.

ProjectName String False

Event Project Name.

Reminder String False

Event Reminder.

使用できる値は次のとおりです。on time, 15 mins, 30 mins, 1 hour, 2 hours, 6 hours, 12 hours, 1 day

Repeat String False

Event Repeat.

使用できる値は次のとおりです。only once, everyday, everyweek, everymonth, everyyear

ScheduledOn String False

Event Scheduled On.

ScheduledOnLong String False

Event Scheduled On Long.

ScheduledOnTo String False

Event Scheduled On To.

ScheduledOnToLong String False

Event Scheduled On To Long.

RepeatTimes String False

Event Repeat Times.

使用できる値は次のとおりです。2, 3, 4, 5, 6, 7, 8, 9, 10

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Status String

Event Status.

使用できる値は次のとおりです。open, closed

CData Cloud

ForumCategories

Gets all the forum categories.

Select

You can use the below query to get all ForumCategories:
SELECT * FROM ForumCategories

Insert

To create a new Forum Category you can use the below query:

INSERT INTO ForumCategories (name) VALUES ('New Forum Category')

Delete

ForumCategories can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM ForumCategories WHERE Id = '123456000000045018'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Forum Category Id.

Name String False

Forum Category Name.

CData Cloud

ForumComments

Gets all the forum comments.

Select

  • ForumId is required to retrieve Forum Comments.
You can use the below query to get all Forum Comments:
SELECT * FROM ForumComments WHERE ForumId = '123456000000045018'

Insert

To create a new Forum Comment you can use the below query:

INSERT INTO ForumComments (ForumId, Content, ParentId) 
VALUES ('123456000000045028', 'Forum Comment Reply', '123456000000043083')

Delete

Forum Comments can be deleted by providing the Id, ForumId and issuing a DELETE statement.

DELETE FROM ForumComments WHERE Id = '123456000000043083' AND ForumId = '123456000000045028'

Columns

Name Type ReadOnly Description
ForumId [KEY] Long False

Forum Id.

Id [KEY] String False

Forum Comment Id.

Content String False

Forum Comment Content.

Type String False

Forum Comment Type.

Attachments String False

Forum Comment Attachments.

IsBestAnswer Boolean False

Forum Comment Is Best Answer.

Level String False

Forum Comment Level.

ParentId String False

Forum Comment Parent Id.

ParentPostedBy String False

Forum Comment Parent Posted By.

ParentPostedByZpuid String False

Forum Comment Parent Posted By ZPUID.

PostDate Date False

Forum Comment Post Date.

PostDateTime Datetime False

Forum Comment Post Date Time.

PostedBy String False

Forum Comment Posted By.

PostedByZpuid String False

Forum Comment Posted By Zpuid.

PostedPerson String False

Forum Comment Posted Person.

RootId String False

Forum Comment Root Id.

ThirdPartyAttachments String False

Forum Comment Third Party Attachments.

CData Cloud

Forums

Gets all the forums in the given project.

Select

  • Id and CategoryId support the following operator: =.
For example, the following query is processed server side:
SELECT * FROM Forums WHERE Id = '123456000000043771' 

Insert

To create a new Forum, you can specify the following fields:

  • Name
  • Type
  • CategoryId
  • Content
  • Flag
  • IsAnnouncementPost
  • IsStickyPost
  • Notify

To create a new Forum, you can use the below query:

INSERT INTO Forums (Name, Type, CategoryId, Content, Flag, IsAnnouncementPost, IsStickyPost)
VALUES ('Forum Post', 'normal', '123456000000039039', 'Content for Forum Post', 'internal', false, false)

Update

To update a Forum, specify the Id field.

UPDATE Forums
	SET Name = 'Updated Post Name', CategoryId = '123456000000093039', Content = 'Updated forum post content' 
	WHERE Id = '123456000000043771' 

Delete

Forums can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Forums WHERE Id = '123456000000043771' 

Columns

Name Type ReadOnly Description
Id [KEY] String False

Forum Id.

Name String False

Forum Name.

Type String False

Forum Type.

使用できる値は次のとおりです。normal, question

Attachments String False

Forum Attachments.

CategoryId String False

Forum Category Id.

CategoryName String False

Forum Category Name.

CommentCount Integer False

Forum Comment Count.

Content String False

Forum Content.

Flag String False

Forum Flag.

IsAnnouncementPost Boolean False

Forum Is Announcement Post.

IsStickyPost Boolean False

Forum Is Sticky Post.

LastActivityDate Date False

Forum Last Activity Date.

LastActivityDateTime Datetime False

Forum Last Activity Date Time.

LastModifiedDate Date False

Forum Last Modified Date.

LastModifiedDateTime Datetime False

Forum Last Modified Date Time.

LinkSelfUrl String False

Forum Link Self Url.

PostDate Date False

Forum Post Date.

PostDateTime Datetime False

Forum Post Date Time.

PostedBy String False

Forum Posted By.

PostedByZpuid String False

Forum Posted By ZPUID.

PostedPerson String False

Forum Posted Person.

ThirdPartyAttachments String False

Forum Third Party Attachments.

Notify String False

Enter the user mail Ids to be notified (Multiple emails can be comma-separated).

CData Cloud

Milestones

Gets list of project layouts.

Select

Columns that support the = operator:
  • Id
  • Flag
  • OwnerId
  • Status
  • DisplayType
  • LastModifiedTime

For example, the following query is processed server side:
SELECT * FROM Milestones WHERE Id = '123456000000043771' WHERE flag = 'internal' 

Insert

To create a new Milestone you can specify the following fields:

  • Name
  • Flag
  • StartDate
  • EndDate
  • OwnerId

To create a new Milestone you can use the below query:

INSERT INTO Milestones (name, StartDate, EndDate, OwnerId, flag) 
VALUES ('New Milestone name', '2022-03-01', '2022-03-10', '1234567890', 'internal')

Update

To update a Milestone specify the Id field.

UPDATE Milestones 
	SET Name = 'Updated Name',
		Flag = 'external',
		StartDate = '2022-02-01',
		EndDate = '2022-03-01',
		OwnerId = '1234567890' " +
	WHERE Id = '123456000000043021'

Delete

Milestones can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Milestones WHERE Id = '123456000000043021' 

Columns

Name Type ReadOnly Description
Id [KEY] String False

Project Milestone Id.

Name String False

Project Milestone Name.

Flag String False

Milestone Flag.

使用できる値は次のとおりです。internal, external

Closed Boolean False

Milestone Closed.

CreatedDate Date False

Milestone Created Date.

CreatedDateTime Datetime False

Milestone Created Date Time.

StartDate Date False

Milestone Start Date.

StartDateTime Datetime False

Milestone Start Date Time.

EndDate Date False

Milestone End Date.

EndDateTime Datetime False

Milestone End Date Time.

Actual Integer False

Milestone Actual.

ActualCostFormatted String False

Milestone Actual Cost Formatted.

ActualHoursFormatted String False

Milestone Actual Hours Formatted.

Balance Integer False

Milestone Balance.

BalanceCostFormatted String False

Milestone Balance Cost Formatted.

BcyActual Integer False

Milestone Bcy Actual.

BcyActualCost String False

Milestone Bcy Actual Cost.

BcyForecasted Integer False

Milestone Bcy Forecasted.

BcyForecastedCost String False

Milestone Bcy Forecasted Cost.

BcyPlanned Integer False

Milestone Bcy Planned.

BcyPlannedCost String False

Milestone Bcy Planned Cost.

BudgetType Integer False

Milestone Budget Type.

CurrencyCode String False

Milestone Currency Code.

Difference Integer False

Milestone Difference.

DifferenceFormatted String False

Milestone Difference Formatted.

Forecasted Integer False

Milestone Forecasted.

ForecastedCostFormatted String False

Milestone Forecasted Cost Formatted.

ForecastedHoursFormatted String False

Milestone Forecasted Hours Formatted.

LastCalculatedTime String False

Milestone Last Calculated Time.

Planned Integer False

Milestone Planned.

PlannedCostFormatted String False

Milestone Planned Cost Formatted.

PlannedHoursFormatted String False

Milestone Planned Hours Formatted.

IsWorkfieldRemoved Boolean False

Milestone Is Work Field Removed.

LastUpdatedDate Date False

Milestone Last Updated Date.

LastUpdatedDateTime Datetime False

Milestone Last Updated Date Time.

SelfUrl String False

Milestone Self Url.

StatusUrl String False

Milestone Status Url.

OwnerId String False

Milestone Owner Id.

OwnerName String False

Milestone Owner Name.

OwnerZpuid String False

Milestone Owner ZPUID.

ProjectId String False

Project Id.

ProjectName String False

Project Name.

Sequence Integer False

Milestone Sequence.

Status String False

Status.

使用できる値は次のとおりです。completed, notcompleted

StatusColorCode String False

Status Color Code.

StatusId String False

Status Id.

StatusName String False

Status Name.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
DisplayType String

Milestone Display Type.

使用できる値は次のとおりです。upcoming, delayed

LastModifiedTime Datetime

Milestone Last Modified Time.

CData Cloud

ProjectEntityProperties

Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.

Table Specific Information

Entity-properties are key-value pairs stored against the project entities. They can be used for storing details that are needed for API integrations but don't have to be visible in the UI. Key has to be a String and the Value could be a simple string or a json object. You can store multiple key-value pair for a single entity. These entity properties can be stored / retrieved / updated / deleted using the below queries.

Select

  • PropertyKey is required to retrieve ProjectEntityProperties.
For example, the following query is processed server side:
SELECT * FROM ProjectEntityProperties WHERE PropertyKey = 'key1' 

Insert

To add a new Project Entity Property specify the PropertyKey and PropertyValue fields.

INSERT INTO ProjectEntityProperties (PropertyKey, PropertyValue) VALUES ('key1', 'This is a test value')

Update

ZohoProjects allows updates for the PropertyValue column.

UPDATE ProjectEntityProperties SET PropertyValue = 'This is an updated property value' WHERE PropertyKey = 'key1'

Delete

Project Entity Properties can be deleted by providing Id, PropertyKey and issuing a DELETE statement.

DELETE FROM ProjectEntityProperties WHERE PropertyKey = 'key1' AND Id = '166135000000035001'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Project Entity Property Id.

PropertyKey [KEY] String False

Project Entity Property Key.

PropertyValue String False

Project Entity Property Value.

CData Cloud

ProjectUsers

Gets the details of all the users in a specific project.

Columns

Name Type ReadOnly Description
Id [KEY] String False

User Id.

Name String False

User Name.

Active Boolean False

User Active.

ChatAccess Boolean False

User Chat Access.

Email String False

User Email.

PortalProfileName String False

User Portal Profile Name.

PortalRoleId String False

User Portal Role Id.

PortalRoleName String False

User Portal Role Name.

ProfileId String False

User Profile Id.

ProfileType String False

User Profile Type.

ProjectProfileId String False

User Project Profile Id.

Role String False

User Role.

使用できる値は次のとおりです。manager, employee, contractor

RoleId String False

User Role Id.

RoleName String False

User Role Name.

Zpuid String False

User ZPUID.

WorkProjects String False

User Work Projects.

UserType String False

User User Type.

使用できる値は次のとおりです。active, inactive

CData Cloud

Statuses

Gets the statuses for the given project.

Select

You can use the below query to get all Statuses:
SELECT * FROM Statuses

Insert

To create a new Status you can specify the following fields:

INSERT INTO Statuses (Content) VALUES ('My Custom Status')

Columns

Name Type ReadOnly Description
Id [KEY] String False

Status Id.

Content String False

Status Content.

PostedBy String False

Status Posted By.

PostedPerson String False

Status Posted Person.

PostedDate Date False

Status Posted Date.

PostedDateTime Datetime False

Status Posted Date Time.

CData Cloud

TaskActivities

Retrieve details of who modified a specific task and when.

Select

  • TaskId is required to retrieve Forum Comments.
You can use the below query to get all Activities for a given Task:
SELECT * FROM TaskActivities WHERE TaskId = '123456789' 

Columns

Name Type ReadOnly Description
TaskId String False

Task Id.

Id [KEY] String False

Task Activity Id.

Name String False

Task Activity Name.

ActivityBy String False

Task Activity By.

OldValue Unknown False

Task Activity Old Value.

NewValue Unknown False

Task Activity New Value.

State String False

Task Activity State.

Time Date False

Task Activity Time.

DateTime Datetime False

Task Activity Date Time.

Zuid String False

Task Activity ZUID.

CData Cloud

TaskComments

Get all the task comments.

Select

  • TaskId is required to retrieve Task Comments.
  • LastModifiedTime supports the following operator: =.
For example, the following query is processed server side:
SELECT * FROM TaskComments WHERE TaskId = '123456000000040013'

Insert

To add a Task Comment specify the TaskId and Comment fields.

INSERT INTO TaskComments (TaskId, content) VALUES ('123456000000040013', 'SQL Comment #6')

Update

To update a Task Comments specify the Id field.

UPDATE TaskComments
	SET Content = 'Updated forum post content' 
	WHERE Id = '123456000000043771' AND TaskId = '123456000000040013'

Delete

Task Comments can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM TaskComments WHERE TaskId = '123456000000045005' AND Id = '123456000000045042' 

Columns

Name Type ReadOnly Description
TaskId [KEY] String False

Task Id.

Id [KEY] String False

Task Comment Id.

Content String False

Task Comment Content.

AddedPersonId String False

Task Comment Added Person Id.

AddedPersonName String False

Task Comment Added Person Name.

AddedVia String False

Task Comment Added Via.

Attachments String False

Task Comment Attachments.

CreatedDate Date False

Task Comment Created Date.

CreatedDateTime Datetime False

Task Comment Created Date Time.

LastModifiedDate Date False

Task Comment Last Modified Date.

LastModifiedDateTime Datetime False

Task Comment Last Modified Date Time.

ProjectName String False

Task Comment Project Name.

SprintsNotesId Integer False

Task Comment Sprints Notes Id.

ThirdPartyAttachments String False

Task Comment Third Party Attachments.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastModifiedTime Datetime

Task Comment Last Modified Time.

CData Cloud

TaskCustomfields

Usage information for the operation TaskCustomfields.rsd.

Columns

Name Type ReadOnly Description
ColumnName [KEY] String False

Task Custom Field Column Name.

ColumnType [KEY] String False

Task Custom Field Column Type.

DisplayName [KEY] String False

Task Custom Field Display Name.

IsDefault [KEY] String False

Task Custom Field Is Default.

IsEncrypted [KEY] String False

Task Custom Field Is Encrypted.

IsMandatory String False

Task Custom Field Is Mandatory.

CData Cloud

TaskEntityProperties

Retrieves the data stored against an entity. The argument of this method should be the key that was used when the same data was stored.

Table Specific Information

Entity-properties are key-value pairs stored against the Task entities. They can be used for storing details that are needed for API integrations but don't have to be visible in the UI. Key has to be a String and the Value could be a simple string or a json object. You can store multiple key-value pair for a single entity. These entity properties can be stored / retrieved / updated / deleted using the below queries.

Select

  • TaskId and PropertyKey are required to retrieve Task Entity Properties.
For example, the following query is processed server side:
SELECT * FROM TaskEntityProperties WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1' 

Insert

To add a new Task Entity Property specify the TaskId, PropertyKey and PropertyValue fields.

INSERT INTO TaskEntityProperties (TaskId, PropertyKey, PropertyValue) VALUES ('123456000000034087', 'key1', 'This is a test value')

Update

ZohoProjects allows updates for the PropertyValue column.

UPDATE TaskEntityProperties SET PropertyValue = 'This is an updated property value' WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1'

Delete

Task Entity Properties can be deleted by providing Id, TaskId, PropertyKey and issuing a DELETE statement.

DELETE FROM TaskEntityProperties WHERE TaskId = '166135000000034087' AND PropertyKey = 'key1' AND Id = '166135000000035001'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Task Entity Property Id.

TaskId [KEY] String False

Task Id.

PropertyKey [KEY] String False

Task Entity Property Key.

PropertyValue String False

Task Entity Property Value.

CData Cloud

Tasklists

Get all the task lists in the given project.

Select

  • MilestoneId and Flag support the following operator: =.
For example, the following query is processed server side:
SELECT * FROM Tasklists WHERE MilestoneId = '12345600000123' AND Flag = 'internal' 

Insert

To create a new Tasklist you can specify the following fields:

  • Name
  • MilestoneId
  • TaskTemplateId
  • ShiftDays
  • Flag


INSERT INTO Tasklists (name, flag, ShiftDays)
VALUES ('New Tasklist #2', 'internal', '2022-03-10T01:00:00Z')

Update

To update a Tasklist specify the Id field.

UPDATE Tasklists SET Name = 'SQL Updated tasklist #7' WHERE Id = '123456000000041033'

Delete

Tasklists can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Tasklists WHERE Id = '123456000000041033'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Tasklist Id.

Name String False

Tasklist Name.

Completed Boolean False

Tasklist Completed.

CreatedDate Date False

Tasklist Created Date.

CreatedDateTime Datetime False

Tasklist Created Date Time.

LastUpdatedDate Date False

Tasklist Last Updated Date.

LastUpdatedDateTime Datetime False

Tasklist Last Updated Date Time.

LinkSelfUrl String False

Tasklist Link Self Url.

LinkTaskUrl String False

Tasklist Link Task Url.

MilestoneClosed Boolean False

Tasklist Milestone Closed.

MilestoneCreatedDate Date False

Tasklist Milestone Created Date.

MilestoneCreatedDateTime Datetime False

Tasklist Milestone Created Date Time.

MilestoneEndDate Date False

Tasklist Milestone End Date.

MilestoneEndDateTime Datetime False

Tasklist Milestone End Date Time.

MilestoneFlag String False

Tasklist Milestone Flag.

MilestoneId String False

Tasklist Milestone Id.

MilestoneIsWorkfieldRemoved Boolean False

Tasklist Milestone Is Workfield Removed.

MilestoneLastUpdatedDate Date False

Tasklist Milestone Last Updated Date.

MilestoneLastUpdatedDateTime Datetime False

Tasklist Milestone Last Updated Date Time.

MilestoneLinkSelfUrl String False

Tasklist Milestone Link Self Url.

MilestoneLinkStatusUrl String False

Tasklist Milestone Link Status Url.

MilestoneName String False

Tasklist Milestone Name.

MilestoneOwnerId String False

Tasklist Milestone Owner Id.

MilestoneOwnerName String False

Tasklist Milestone Owner Name.

MilestoneOwnerZpuid String False

Tasklist Milestone Owner Zpuid.

MilestoneProjectId String False

Tasklist Milestone Project Id.

MilestoneProjectName String False

Tasklist Milestone Project Name.

MilestoneSequence Integer False

Tasklist Milestone Sequence.

MilestoneStartDate Date False

Tasklist Milestone Start Date.

MilestoneStartDateTime Datetime False

Tasklist Milestone Start Date Time.

MilestoneStatus String False

Tasklist Milestone Status.

MilestoneStatusDetColorcode String False

Tasklist Milestone Status Det Colorcode.

MilestoneStatusDetId String False

Tasklist Milestone Status Det Id.

MilestoneStatusDetName String False

Tasklist Milestone Status Det Name.

Rolled Boolean False

Tasklist Rolled.

Sequence Integer False

Tasklist Sequence.

TaskCountOpen Integer False

Tasklist Task Count Open.

TaskTemplateId String False

Id of the task list template.

ShiftDays Datetime False

The ISO 8601 Datetime from which the Task start date is calculated, based on shift days.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Flag String

Tasklist Flag.

使用できる値は次のとおりです。internal, external

CData Cloud

Tasks

Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.

Select

Columns that support the = operator:
  • Id
  • CreatedBy
  • MilestoneId
  • Priority
  • TasklistId
  • Owner
  • Status
  • Time
  • LastModifiedTime
  • ViewId

  • CreatedDate and LastModifiedTime support: ORDER
For example, the following query is processed server side:
SELECT * FROM Tasks WHERE MilestoneId = '12345600000123' AND Priority = 'High' ORDER BY CreatedDate

Insert

To create a new Task you can specify the following fields:

  • Name
  • Description
  • Owners
  • Duration
  • DurationType
  • EndDate
  • Priority
  • StartDate
  • TasklistId
  • Work
  • GroupNameAssociatedTeamsAnyTeam
  • RatePerHour
  • ReminderString
  • Recurrence
  • BudgetValue
  • BudgetThreshold


INSERT INTO Tasks (Name, Description, Duration, DurationType, Priority,  BudgetValue)
VALUES ('New Task #2', 'This is a test description', '5', 'hrs', 'High', '1000')

Update

To update a Task specify the Id field.

UPDATE Tasks SET Priority = 'Low' WHERE Id = '123456000000034003'

Delete

Tasks can be deleted by providing the Id and issuing a DELETE statement.

DELETE FROM Tasks WHERE Id = '123456000000034003'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Task Id.

Name String False

Task Name.

Key String False

Task Key.

BillingType String False

Task Billing Type.

Completed Boolean False

Task Completed.

CreatedBy String False

Task Created By.

CreatedByEmail String False

Task Created By Email.

CreatedByZpuid String False

Task Created By Zpuid.

CreatedPerson String False

Task Created Person.

CreatedDate Date False

Task Created Date.

CreatedDateTime Datetime False

Task Created Date Time.

Description String False

Task Description.

Owners String False

Task Owners.

Duration String False

Task Duration.

DurationType String False

Task Duration Type.

使用できる値は次のとおりです。days, hrs

EndDate Date False

Task End Date.

EndDateTime Datetime False

Task End Date Time.

CommentAdded Boolean False

Task Comment Added.

DocsAssociated Boolean False

Task Docs Associated.

ForumAssociated Boolean False

Task Forum Associated.

RecurrenceSet Boolean False

Task Recurrence Set.

ReminderSet Boolean False

Task Reminder Set.

Parent Boolean False

Task Parent.

LastUpdatedDate Date False

Task Last Updated Date.

LastUpdatedDateTime Datetime False

Task Last Updated Date Time.

LinkSelfUrl String False

Task Link Self Url.

LinkTimesheetUrl String False

Task Link Timesheet Url.

LinkWebUrl String False

Task Link Web Url.

LogHoursBillableHours String False

Task Log Hours Billable Hours.

LogHoursNonBillableHours String False

Task Log Hours Non Billable Hours.

MilestoneId String False

Task Milestone Id.

OrderSequence Integer False

Task Order Sequence.

PercentComplete String False

Task Percent Complete.

Priority String False

Task Priority.

使用できる値は次のとおりです。none, low, medium, high

StartDate Date False

Task Start Date.

StartDateTime Datetime False

Task Start Date Time.

StatusColorCode String False

Task Status Color Code.

StatusName String False

Task Status Name.

StatusId String False

Task Status Id.

StatusType String False

Task Status Type.

Subtasks Boolean False

Task Subtasks.

TaskFollowers String False

Task Task Followers.

TaskFollowerSize Integer False

Task Task Follower Size.

TasklistId String False

Tasklist Id.

TasklistName String False

Tasklist Name.

Work String False

Task Work.

WorkForm String False

Task Work Form.

WorkType String False

Task Work Type.

使用できる値は次のとおりです。work_hrs_per_day

GroupNameAssociatedTeamsAnyTeam String False

Task Group Name Associated Teams Any Team.

GroupNameAssociatedTeamsCount Integer False

Task Group Name Associated Teams Count.

GroupNameIsTeamUnassigned Boolean False

Task Group Name Is Team Unassigned.

RatePerHour String False

Task Rate Per Hour.

ReminderString String False

Task Reminder String.

Recurrence String False

Task Recurrence.

BudgetValue String False

Task Budget Value.

BudgetThreshold String False

Task Budget Threshold.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Owner String

Task Owner.

Status String

Task Status.

使用できる値は次のとおりです。completed, notcompleted

Time String

Task Time.

使用できる値は次のとおりです。overdue, today, tomorrow

LastModifiedTime Datetime

Task Last Modified Time.

ViewId String

Task View Id.

CData Cloud

TaskSubtasks

View all the subtasks of the given task.

Select

  • TaskId is required to retrieve Task Subtasks.
You can use the below query to get all Task Subtasks:
SELECT * FROM TaskSubtasks WHERE TaskId = '12345600000123' 

Insert

To create a new Task you can specify the following fields:

  • TaskId
  • Name
  • Description
  • Duration
  • DurationType
  • Priority
  • StartDate
  • EndDate
  • PersonResponsible


INSERT INTO TaskSubtasks (TaskId, Name, StartDate, EndDate, Duration, DurationType, Priority, Description)
VALUES ('165818000000040013', 'Sql Subtask #4', '2022-03-01', '2022-03-10', '2', 'hrs', 'High', 'Test description of the subtask')

Columns

Name Type ReadOnly Description
TaskId String False

Task Id.

Id [KEY] String False

Subtask Id.

Name String False

Subtask Name.

Key String False

Subtask Key.

BillingType String False

Subtask Billing Type.

Completed Boolean False

Subtask Completed.

CreatedBy String False

Subtask Created By.

CreatedByEmail String False

Subtask Created By Email.

CreatedByZpuid String False

Subtask Created By Zpuid.

CreatedPerson String False

Subtask Created Person.

CreatedTime Date False

Subtask Created Time.

CreatedDateTime Datetime False

Subtask Created Date Time.

Depth Integer False

Subtask Depth.

Description String False

Subtask Description.

DetailsOwners String False

Subtask Details Owners.

Duration String False

Subtask Duration.

DurationType String False

Subtask Duration Type.

使用できる値は次のとおりです。days, hrs

IsCommentAdded Boolean False

Subtask Is Comment Added.

IsDocsAssociated Boolean False

Subtask Is Docs Associated.

IsForumAssociated Boolean False

Subtask Is Forum Associated.

IsRecurrenceSet Boolean False

Subtask Is Recurrence Set.

IsReminderSet Boolean False

Subtask Is Reminder Set.

IsParent Boolean False

Subtask Is Parent.

LastUpdatedTime Date False

Subtask Last Updated Time.

LastUpdatedDateTime Datetime False

Subtask Last Updated Date Time.

LinkSelfUrl String False

Subtask Link Self Url.

LinkTimesheetUrl String False

Subtask Link Timesheet Url.

LinkWebUrl String False

Subtask Link Web Url.

LogBillableHours String False

Subtask Log Billable Hours.

LogNonBillableHours String False

Subtask Log Non Billable Hours.

MilestoneId String False

Subtask Milestone Id.

OrderSequence Integer False

Subtask Order Sequence.

ParentTaskId String False

Subtask Parent Task Id.

PercentComplete String False

Subtask Percent Complete.

Priority String False

Subtask Priority.

使用できる値は次のとおりです。none, low, medium, high

RootTaskId String False

Subtask Root Task Id.

StatusColorCode String False

Subtask Status Color Code.

StatusId String False

Subtask Status Id.

StatusName String False

Subtask Status Name.

StatusType String False

Subtask Status Type.

Subtasks Boolean False

Subtask Subtasks.

TaskFollowers String False

Subtask Task Followers.

TaskFollowerSize Integer False

Subtask Task Follower Size.

TasklistId String False

Subtask Tasklist Id.

TasklistName String False

Subtask Tasklist Name.

Work String False

Subtask Work.

WorkForm String False

Subtask Work Form.

WorkType String False

Subtask Work Type.

GroupNameAssociatedTeamsAnyTeam String False

Subtask Group Name Associated Teams Any Team.

GroupNameAssociatedTeamsCount Integer False

Subtask Group Name Associated Teams Count.

GroupNameIsTeamUnassigned Boolean False

Subtask Group Name Is Team Unassigned.

StartDate Date False

Subtask Start Date.

EndDate Date False

Subtask End Date.

PersonResponsible String False

Subtask Person Responsible.

CData Cloud

TaskTimelogs

Gets the time logs under a specific task.

Select

  • TaskId is required to retrieve Task Time Logs.
For example, the following query is processed server side:
SELECT * FROM TaskTimelogs WHERE TaskId = '123456000000045005'

Insert

To create a new Task Timelog you can specify the following fields:

  • TaskId
  • BillStatus
  • Notes
  • HoursDisplay
  • LogDate
  • OwnerId


INSERT INTO TaskTimelogs (TaskId, LogDate, BillStatus, HoursDisplay, Notes) " +
VALUES ('123456000000040013', '2022-03-03', 'Non Billable', '01:20', 'This is a test timelog')

Update

To update a Task TimeLog specify the TaskId and Id fields.

UPDATE TaskTimelogs
	SET Notes = 'This is an updated SQL Note'
	WHERE TaskId = '165818000000040013' AND Id = '165818000000045001'

Delete

Task TimeLogs can be deleted by providing the TaskId and Id and issuing a DELETE statement.

DELETE FROM TaskTimelogs WHERE TaskId = '123456000000045005' AND Id = '123456000000044025'

Columns

Name Type ReadOnly Description
TaskId [KEY] String False

Task Id.

Id [KEY] String False

Task Time Log Id.

AddedByName String False

Task Time Log Added By Name.

AddedByZpuid String False

Task Time Log Added By Zpuid.

AddedByZuid Long False

Task Time Log Added By Zuid.

ApprovalStatus String False

Task Time Log Approval Status.

ApproverName String False

Task Time Log Approver Name.

BillStatus String False

Task Time Log Bill Status.

使用できる値は次のとおりです。Billable, Non Billable

CreatedDate Date False

Task Time Log Created Date.

CreatedDateTime Datetime False

Task Time Log Created Date Time.

StartTime Datetime False

Task Time Log Start Time.

EndTime Datetime False

Task Time Log End Time.

Notes String False

Task Time Log Notes.

HoursDisplay String False

Task Time Log Hours Display.

Hours Integer False

Task Time Log Hours.

Minutes Integer False

Task Time Log Minutes.

IsParent Boolean False

Task Time Log Is Parent.

IsSubTask Boolean False

Task Time Log Is Sub Task.

LastModifiedDate Date False

Task Time Log Last Modified Date.

LastModifiedDateTime Datetime False

Task Time Log Last Modified Date Time.

LinkSelfUrl String False

Task Time Log Link Self Url.

LogDate Date False

Task Time Log Date.

LogDateTime Datetime False

Task Time Log Date Time.

OwnerId String False

Task Time Log Owner Id.

OwnerName String False

Task Time Log Owner Name.

SubTaskLevel String False

Task Time Log Sub Task Level.

TaskName String False

Task Time Log Task Name.

TaskListId Long False

Task Time Log Task List Id.

TaskListName String False

Task Time Log Task List Name.

TotalMinutes Integer False

Task Time Log Total Minutes.

CData Cloud

TeamUsers

Fetch details of a particular team.

Select

  • GroupId is required to retrieve Team Users.
You can use the below query to get all Team Users:
SELECT * FROM TeamUsers WHERE GroupId = '123456000000033021'

Insert

To create a new Team you must specify the following fields:

  • GroupId
  • Zpuid


INSERT INTO TeamUsers (GroupId, ZPUID)
VALUES ('123456000000034163', '123456000000031003')

Delete

TeamUsers can be deleted by providing the GroupId and Id and issuing a DELETE statement.

DELETE FROM TeamUsers WHERE GroupId = '123456000000034163' AND Id = '123456000000031003'

Columns

Name Type ReadOnly Description
ProjectId String False

Project Id.

GroupId String False

Team Id.

Id [KEY] String False

User Id.

Name String False

User Name.

AddedBy String False

User Added By.

AddedTime String False

User Added Time.

Confirmed String False

User Confirmed.

CreatedBy String False

User Created By.

CreatedTime String False

User Created Time.

CreatedUser String False

User Created User.

Description String False

User Description.

DisplayName String False

User Display Name.

Email String False

User Email.

EntityType String False

User Entity Type.

FirstName String False

User First Name.

IsClient Boolean False

User Is Client.

IsDefault Boolean False

User Is Default.

LastAccessedTime String False

User Last Accessed Time.

LastName String False

User Last Name.

LastUpdatedTime String False

User Last Updated Time.

RoleId String False

User Role Id.

RoleName String False

User Role Name.

Type String False

User Type.

UpdatedBy String False

User Updated By.

UpdatedDate String False

User Updated Date.

UpdatedDateTime String False

User Updated Date Time.

UserStatus String False

User User Status.

Zpuid String False

User Zpuid.

Zuid String False

User Zuid.

CData Cloud

ビュー

The Cloud models the entities for which Zoho Projects only provides read-only access as views.

It exposes each project tied to your account as a schema with the following views.

Navigate to an individual view's page for a breakdown of its columns and supported filters.

CData Cloud - Zoho Projects ビュー

Name Description
Activities List all the recent activities of the project.
BugActivities Gets all the activities for the given bug.
BugAttachments Get details of attachments for a bug.
BugCustomFields Gets all the custom fields in the given project.
BugResolution Get bug's resolution.
Clients Returns the list of client companies associated with a specific project Id.
Documents List all the recent activities of the project.
TaskAttachments Retrieve details of attachments associated to the task.
Timelogs Gets the time logs under a specific bug.

CData Cloud

Activities

List all the recent activities of the project.

Select

This is a project-level view. You can use the below query to get all Activities:
SELECT * FROM Activities

Columns

Name Type Description
Id [KEY] String Project Activity Id.
Name String Project Activity Name.
Activity By String Project Activity Author.
Activity For String Project Activity For Entity.
Display Time String Project Activity Display Time.
State String Project Activity State.
Time String Project Activity Time.

CData Cloud

BugActivities

Gets all the activities for the given bug.

Select

This is a bug-level view.
  • BugId is required to retrieve BugActivities.
You can use the below query to get all BugActivities:
SELECT * FROM BugActivities WHERE BugId = '12345600001'

Columns

Name Type Description
BugId String Bug Id.
Action String Bug Activity Action.
Type String Bug Activity Type.
PreviousValue String Bug Activity Previous Value.
CurrentValue String Bug Activity Current Value.
ActionBy String Bug Activity Action By.
ActionField String Bug Activity Action Field.
ActionDate Date Bug Activity Action Date.
ActionDateTime Datetime Bug Activity Action Date Time.
Zuid [KEY] String Bug Activity ZUID.

CData Cloud

BugAttachments

Get details of attachments for a bug.

Columns

Name Type Description
BugId String Bug Id.
AttachmentId Long Attachment Id.
FileName String Attached File Name.
FileType String Attached File Type.
FileSize Integer Attached File Size.
FileEncAttachParam String Attached File Enc Attach Param.
FileUri String Attached File Uri.
AttachedDate Date Attached Date.
AttachedDateTime Datetime Attached Date Time.
AuthorId String Attachment Author Id.
AuthorName String Attachment Author Name.
IsDocsAttachment Boolean Is Docs Attachment.

CData Cloud

BugCustomFields

Gets all the custom fields in the given project.

Select

This is a project-level view. You can use the below query to get all BugCustomFields:
SELECT * FROM BugCustomFields WHERE BugId = '12345600001'

Columns

Name Type Description
LabelName String Bug Custom Field Label Name.
ColumnName String Bug Custom Field Column Name.
DefaultValue String Bug Custom Field Default Value.
FieldType String Bug Custom Field Field Type.
IsEnc Boolean Bug Custom Field Is Enc.
IsMandatory Boolean Bug Custom Field Is Mandatory.
IsPi Boolean Bug Custom Field Is Pi.
IsVisible Boolean Bug Custom Field Is Visible.
NewColumnName String Bug Custom Field New Column Name.
PicklistValues String Bug Custom Field Picklist Values.

CData Cloud

BugResolution

Get bug's resolution.

Columns

Name Type Description
BugId String Bug Id.
Resolver String Bug Resolver.
ResolverId String Bug Resolver Id.
Resolution String Bug Resolution.
ResolutionThirdPartyAttachments String Bug Resolution Third Party Attachments.
ResolvedDate Date Bug Resolved Date.
ResolvedDateTime Datetime Bug Resolved Date Time.
ResolverZpuid String Bug Resolver ZPUID.

CData Cloud

Clients

Returns the list of client companies associated with a specific project Id.

Select

This is a project-level view.
  • Id supports the following operator: =.
For example, the following query is processed server side:
SELECT * FROM Clients WHERE Id = '12345600001'

Columns

Name Type Description
Id [KEY] String Client Id.
Name String Client Name.
City String Client City.
Country String Client Country.
CrmAccountId String Client Crm Account Id.
FirstAddress String Client First Address.
SecondAddress String Client Second Address.
State String Client State.
WebAddress String Client Web Address.
ZipCode String Client Zip Code.
UserId String Client User Id.
UserName String Client User Name.
UserEmail String Client User Email.
UserZpuid String Client User ZPUID.

CData Cloud

Documents

List all the recent activities of the project.

Columns

Name Type Description
Id [KEY] String Project Activity Id.
Name String Project Activity Name.
Activity By String Project Activity Author.
Activity For String Project Activity For.
Display Time String Project Activity Display Time.
State String Project Activity State.
Time String Project Activity Time.

CData Cloud

TaskAttachments

Retrieve details of attachments associated to the task.

Select

This is a project-level view.
  • TaskId is required to retrieve TaskAttachments.
You can use the below query to get all TaskAttachments:
SELECT * FROM TaskAttachments WHERE TaskId = '123456000000112'

Columns

Name Type Description
TaskId String Task Id.
Id [KEY] String Task Attachment Id.
AuthorId String Task Attachment Author Id.
ContentType String Task Attachment Content Type.
DocsDownloadUrl String Task Attachment Docs Download Url.
DownloadUrl String Task Attachment Download.
Extension String Task Attachment Extension.
Filename String Task Attachment Filename.
Owner String Task Attachment Owner.
Size Integer Task Attachment size in bytes..
TaskId Long Task Attachment Task Id.
ThumbnailUrl String Task Attachment Thumbnail Url.
UploadedTime Long Task Attachment Uploaded Time.

CData Cloud

Timelogs

Gets the time logs under a specific bug.

Select

This is a project-level view. Columns that support the = operator:
  • BillStatus
  • User
  • ComponentType

Columns that support the >,>=,=,<,<= operators:
  • Date
  • LastModifiedDate

For example, the following queries are processed server side:
SELECT * FROM Timelogs WHERE Date > '2024-01-01'

SELECT * FROM Timelogs WHERE LastModifiedDate > '2024-01-01'
Querying Timelogs without filters will return data for only the current month:
SELECT * FROM Timelogs

Columns

Name Type Description
Id [KEY] String Time Log Id.
AddedByName String Time Log Added By Name.
AddedByZpuid String Time Log Added By Zpuid.
AddedByZuid Long Time Log Added By Zuid.
ApprovalStatus String Time Log Approval Status.
ApproverName String Time Log Approver Name.
BillStatus String Time Log Bill Status.

使用できる値は次のとおりです。all, billable, non billable

CreatedDate Date Time Log Created Date.
CreatedDateTime Datetime Time Log Created Date Time.
StartTime Datetime Time Log Start Time.
EndTime Datetime Time Log End Time.
Notes String Time Log Notes.
HoursDisplay String Time Log Hours Display.
Hours Integer Time Log Hours.
Minutes Integer Time Log Minutes.
IsParent Boolean Time Log Is Parent.
IsSubTask Boolean Time Log Is Sub Task.
LastModifiedDate Date Time Log Last Modified Date.
LastModifiedDateTime Datetime Time Log Last Modified Date Time.
LinkSelfUrl String Time Log Link Self Url.
LogDate Date Time Log Date.
LogDateTime Datetime Time Log Date Time.
OwnerId String Time Log Owner Id.
OwnerName String Time Log Owner Name.
SubTaskLevel String Time Log Sub Task Level.
TaskName String Time Log Task Name.
TaskListId Long Time Log Task List Id.
TaskListName String Time Log Task List Name.
TotalMinutes Integer Time Log Total Minutes.
Date Date Time Log Date.
User String Time Log User.
ComponentType String Time Log Component Type.

使用できる値は次のとおりです。bug, task, general

CData Cloud

All Portals

Overview

The Cloud models information about all of the portals attached to your account in the "ZohoProjects" schema in the "CData" catalog.

Tables

The テーブル section contains a single table, Portals, which stores information about your account's portals, such as company names, profile names, and portal roles.

Stored Procedures

ストアドプロシージャ are function-like interfaces to Zoho Projects. Stored procedures allow you to execute operations to Zoho Projects, including approving timelogs and reordering tasks.

CData Cloud

テーブル

The Cloud models account-level information about all portals as a single "Portals" table.

CData Cloud - Zoho Projects テーブル

Name Description
Portals Gets all the portals for the logged in user.

CData Cloud

Portals

Gets all the portals for the logged in user.

Select

The Cloud will use the Zoho Projects API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id and ViewId support the following operator: =.
For example, the following query is processed server side:
SELECT * FROM Portals WHERE Id = '20081021809'

Columns

Name Type ReadOnly Description
Id [KEY] String False

Portal Id.

Name String False

Portal Name.

CompanyName String False

Portal Company Name.

AvailableClients Integer False

Portal Available Clients.

AvailableUsers Integer False

Portal Available Users.

AvailableProjects Integer False

Portal Available Projects.

BugPlan String False

Portal Bug Plan.

BugPlural String False

Bug Plural.

BugSingular String False

Bug Singular.

CanAddTemplate Boolean False

Can Add Portal Template.

CanCreateProject Boolean False

Can Create Portal Project.

Default Boolean False

Default Portal.

ExtensionsAppSettings String False

Portal Extensions Locations App Settings.

ExtensionsAttachmentPicker String False

Portal Extensions Locations Attachment Picker.

ExtensionsBlueprintDuring String False

Portal Extensions Locations Blueprint During.

ExtensionsIssueTab String False

Portal Extensions Locations Issue Tab.

ExtensionsIssuedetailsRightpanel String False

Portal Extensions Locations Issue Details Right Panel.

ExtensionsProjectTab String False

Portal Extensions Locations Project Tab.

ExtensionsTaskTab String False

Portal Extensions Locations Task Tab.

ExtensionsTaskTransition String False

Portal Extensions Locations Task Transition.

ExtensionsTaskdetailsRightpanel String False

Portal Extensions Locations Task Details Right Panel.

ExtensionsTopBand String False

Portal Extensions Locations Top Band.

GmtTimeZone String False

Portal GMT Time Zone.

GmtTimeZoneOffset Integer False

Portal GMT Time Zone Offset.

MeetingEnabled Boolean False

Portal Meeting Enabled.

PeopleEnabled Boolean False

Portal People Enabled.

CrmPartner Boolean False

Portal CRM Partner.

DisplayProjectPrefix Boolean False

Portal Display Project Prefix.

DisplayTaskPrefix Boolean False

Portal Display Task Prefix.

NewPlan Boolean False

Portal New Plan.

SprintsIntegrated Boolean False

Portal Sprints Integrated.

TagsAvailable Boolean False

Portal Tags Available.

TimeLogRestricted Boolean False

Portal Time Log Restricted.

ProjectsModuleId String False

Portal Projects Module Id.

TasksModuleId String False

Portal Tasks Module Id.

ProjectUrl String False

Portal Project URL.

LocaleCode String False

Portal Locale Code.

LocaleCountry String False

Portal Locale Country.

Language String False

Portal Language.

LoginZpuid Long False

Portal Login ZPUID.

MaxClients Integer False

Portal Max Clients.

MaxUsers Integer False

Portal Max Users.

NewUserPlan Boolean False

Portal New User Plan.

PercentageCalculation String False

Portal Percentage Calculation.

Plan String False

Portal Plan.

ProfileId Long False

Portal Profile Id.

ProfileName String False

Portal Profile Name.

ProfileType Integer False

Portal Profile Type.

ActiveProjects Integer False

Portal Active Projects.

ProjectPrefix String False

Portal Project Prefix.

Role String False

Portal Role.

RoleId String False

Portal Role Id.

RoleName String False

Portal Role Name.

BusinessHoursEnd Integer False

Portal Business Hours End.

BusinessHoursStart Integer False

Portal Business Hours Start.

DateFormat String False

Portal Date Format.

DefaultCurrency String False

Portal Default Currency.

DefaultDependencyType String False

Portal Default Dependency Type.

BudgetPermission Boolean False

Portal Budget Permission.

Holidays String False

Portal Holidays.

BudgetEnabled Boolean False

Portal Budget Enabled.

LastSyncTime String False

Portal Last Sync Time.

StartDayOfWeek String False

Portal Start Day of Week.

TaskDateFormat String False

Portal Task Date Format.

TaskDurationType String False

Portal Task Duration Type.

TimeZone String False

Portal Time Zone.

EditTimeLogRestricted Boolean False

Portal Edit Time Log Restricted.

LogFutureTimeAllowed Boolean False

Portal Log Future Time Allowed.

LogPastTimeAllowed Boolean False

Portal Log Past Time Allowed.

DefaultBillingStatus String False

Portal Default billing Status.

TimesheetApprovalEnabled Boolean False

Portal Timesheet Approval Enabled.

WorkingDays String False

Portal Working Days.

SprintsProjectPermission Boolean False

Portal Sprints Project Permission.

StorageType String False

Portal Storage Type.

TrialEnabled Boolean False

Portal Trial Enabled.

LogHrRestrictedByWorkHr Boolean False

Portal Log Hr restricted by Work Hr.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ViewId String

CData Cloud

ストアドプロシージャ

Stored procedures are function-like interfaces that enable the Cloud to perform actions beyond the scope of basic data access. They accept a list of parameters, perform an action, and return response data from Zoho Projects and/or a confirmation of the success or failure of the procedure.

The full list of procedures is provided below. Navigate to an individual procedure's page for a breakdown of its functionality, inputs, and outputs.

CData Cloud - Zoho Projects ストアドプロシージャ

Name Description
AddUserToClientCompany Adds user to an existing client company.
ApproveTimelog Approve general/bug/task time log.
AssociateBugs Associate related bugs to a task.
AssociateContacts Associates a tag with a specific entity in a specific project.
AssociateTags Associates a tag with a specific entity in a specific project.
DissociateBugs Associate related bugs to a task.
DissociateContacts Dissociate a client contact from a project.
DissociateTags Dissociates a tag with a specific entity in a specific project.
ForumFollow Follow a forum post.
ForumSelectBestAnswer Unfollow a forum post.
ForumUnfollow Unfollow a forum post.
ForumUnselectBestAnswer Unfollow a forum post.
SelectTeamLead Update the team lead.
TaskFollow Follow a task in the given project.
TaskMove Moves a task from one tasklist to another tasklist. The target tasklist can be of the same project or different project.
TaskReorder Reorders the tasks in the given project. Task will be reordered in-between two tasks based on the previous and next task Ids.
TaskUnfollow Unfollow a task in the given project.

CData Cloud

AddUserToClientCompany

Adds user to an existing client company.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC AddUserToClientCompany PortalId = '12345317133', CompanyId = '123456000000039025', ContactEmail = '[email protected]'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
CompanyId String True Specify the client company Id.
ContactEmail String True Email Id of the client user.
WorkProjects String False Multiple project Ids are separated using comma.
ProfileId String False Specify Profile Id. profile_id is obtained from Get Portal Users API.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

ApproveTimelog

Approve general/bug/task time log.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC ApproveTimelog PortalId = '12345317133', ProjectId = '123456000000031899', LogId = '123456000000031977', Approval = 'approve', Reason = 'Submitted timelog is approved', EntityType = 'general', EntityId = '1234560001'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
LogId String True Specify the log Id.
EntityType String False Specify the entity type to approve the log time.

使用できる値は次のとおりです。task, bug, general

EntityId String False Id of entity specified by parameter 'EntityType'
Approval String True The time log is approved if the given value is approve

使用できる値は次のとおりです。approve, pending, reject

Reason String False Reason should be mentioned if the time log is rejected. The reason shouldn't exceed 250 characters.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

AssociateBugs

Associate related bugs to a task.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC AssociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True Specify the task Id.
BugId String True Id for multiple bugs must be separated by commas.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

AssociateContacts

Associates a tag with a specific entity in a specific project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC AssociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ContactId String True Array of client contact Ids. Multiple Ids can be separated by comma.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

AssociateTags

Associates a tag with a specific entity in a specific project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC AssociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task',  EntityId = '123456000000034087'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TagId String True Specify the tag Id.
EntityType String True Specify the entity type to approve the log time.

使用できる値は次のとおりです。Project, Milestone, Tasklist, Task, Bug, Forum, Status

EntityId String True Id of entity specified by parameter 'EntityType'

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

DissociateBugs

Associate related bugs to a task.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC DissociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True Specify the task Id.
BugId String True Id for multiple bugs must be separated by commas.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

DissociateContacts

Dissociate a client contact from a project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC DissociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ContactId String True Array of client contact Ids.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

DissociateTags

Dissociates a tag with a specific entity in a specific project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC DissociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task',  EntityId = '123456000000034087'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TagId String True Specify the tag Id.
EntityType String True Specify the entity type to approve the log time.

使用できる値は次のとおりです。Project, Milestone, Tasklist, Task, Bug, Forum, Status

EntityId String True Id of entity specified by parameter 'EntityType'

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

ForumFollow

Follow a forum post.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC ForumFollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ForumId String True Specify the tag Id.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

ForumSelectBestAnswer

Unfollow a forum post.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC ForumSelectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ForumId String True Specify the forum Id.
CommentId String True Specify the comment Id.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

ForumUnfollow

Unfollow a forum post.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC ForumUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ForumId String True Specify the tag Id.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

ForumUnselectBestAnswer

Unfollow a forum post.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC ForumUnselectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
ForumId String True Specify the forum Id.
CommentId String True Specify the comment Id.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

SelectTeamLead

Update the team lead.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC SelectTeamLead PortalId = '12345317133', ProjectId = '123456000000031899', UserId = '123456000000033053'

Input

Name Type Required Description
PortalId String False Specify the portal Id.
TeamId String False Specify the group Id.
UserId String False ZPUID of the team lead.

Result Set Columns

Name Type Description
Success String Specifies whether the update was successful.

CData Cloud

TaskFollow

Follow a task in the given project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC TaskFollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True Specify the task Id.
UserId String True User Id for multiple followers must be separated by commas.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

TaskMove

Moves a task from one tasklist to another tasklist. The target tasklist can be of the same project or different project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC TaskMove PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', FromTasklist = '123456000000031932', ToTasklist = '123456000000031941'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True Specify the task Id.
FromTasklist String True Id of the tasklist in which the task exists.
ToTasklist String True Id of the tasklist to which the task has to be moved.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

TaskReorder

Reorders the tasks in the given project. Task will be reordered in-between two tasks based on the previous and next task Ids.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC TaskReorder PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', PreviousTaskId = '123456000000031932', NextTaskId = '123456000000031941'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True Specify the Task Id.
PreviousTaskId String True Specify the previous Task Id.
NextTaskId String True Specify the next Task Id.

Result Set Columns

Name Type Description
Success String Specifies whether the update was successful.

CData Cloud

TaskUnfollow

Unfollow a task in the given project.

Procedure-Specific Information

An example query for executing this stored procedure is shown below:
EXEC TaskUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'

Input

Name Type Required Description
PortalId String True Specify the portal Id.
ProjectId String True Specify the group Id.
TaskId String True ZPUID of the team lead.
UserId String True User Id for multiple followers must be separated by commas.

Result Set Columns

Name Type Description
Success String Specifies whether the execution was successful.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Zoho Projects のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Portals テーブルのカラムとデータ型を返します。

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

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、ApproveTimelog ストアドプロシージャのすべての入力パラメータについての情報を返します。

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

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Portals テーブルの主キーを取得します。

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

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
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サポートされている数値関数。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サポートされている日付および時刻関数。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レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。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使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
RegionサーバーURL のトップレベルドメイン(TLD)。

Connection


プロパティ説明
PortalIdRestrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.
ProjectIdRestrict exposed entities based on the Project Id. If left empty, all available portals will be exposed.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
AccountsServerDeprecated. The full Account Server URL.
APIDomainDeprecated. The full URL of the API domain.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PagesizeZoho Projects から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
RegionサーバーURL のトップレベルドメイン(TLD)。
CData Cloud

Region

サーバーURL のトップレベルドメイン(TLD)。

Possible Values

US, Europe, India, Australia, Japan, China

データ型

string

デフォルト値

"US"

解説

アカウントが米国以外のドメインにある場合、地域に応じてRegion を変更してください。InitiateOAuth=Off で独自のOAuth アクセストークンを使用する場合のみ、これを指定する必要があります。それ以外の場合、Region はOAuth フローから取得されます。使用可能なすべての値を表に示します。

Region Domain
US .com
Europe .eu
India .in
Australia .com.au
Japan .jp
China .com.cn

CData Cloud

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。


プロパティ説明
PortalIdRestrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.
ProjectIdRestrict exposed entities based on the Project Id. If left empty, all available portals will be exposed.
CData Cloud

PortalId

Restrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.

データ型

string

デフォルト値

""

解説

Restrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.

CData Cloud

ProjectId

Restrict exposed entities based on the Project Id. If left empty, all available portals will be exposed.

データ型

string

デフォルト値

""

解説

Restrict exposed entities based on the Project Id. If left empty, all available portals will be exposed.

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
AccountsServerDeprecated. The full Account Server URL.
APIDomainDeprecated. The full URL of the API domain.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PagesizeZoho Projects から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
CData Cloud

AccountsServer

Deprecated. The full Account Server URL.

データ型

string

デフォルト値

""

解説

Note:この接続プロパティは非推奨となりました。代わりにRegion 接続プロパティを設定してください。

You only need to supply this when executing the RefreshOAuthAccessToken stored procedure with InitiateOAuth=Off. Most of the time, the value of this property is https://accounts.zoho.com/, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).

CData Cloud

APIDomain

Deprecated. The full URL of the API domain.

データ型

string

デフォルト値

""

解説

Note:この接続プロパティは非推奨となりました。代わりにRegion 接続プロパティを設定してください。

You only need to supply this when using your own OAuth access token with InitiateOAuth=Off. Otherwise, the API domain will be retrieved from the OAuth flow. Most of the time, the value of this property is https://www.zohoapis.com, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).

CData Cloud

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

Pagesize

Zoho Projects から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

100

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175