CData Sync App は、Zoho Projects データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Zoho Projects コネクタはCData Sync アプリケーションから使用可能で、Zoho Projects からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、Zoho Projects API(REST API およびv3 API)を使用して、Zoho Projects のプロジェクトマネジメントデータへの双方向でのアクセスを可能にします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Region をサーバーURL のトップレベルドメイン(TLD)に設定します。
Zoho Projects は、データに接続する2つの方法を提供します。
すべてのOAuth フロー(埋め込みまたはカスタム)で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。
以下のサブセクションでは、3つの一般的な認証フローでのZoho Projects への認証について詳しく説明します。
カスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。
Zoho Projects で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ:
Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
The Sync App 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:
The Sync App 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.
The Sync App 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.
The All Portals section contains data pertaining to all portals tied to your account.
The Sync App models each portal associated with your account as a catalog, named after the portal, containing a portal-specific schema called "ZohoProjects".
テーブル describes the available tables. Tables are statically defined to model Zoho Projects entities such as contacts, teams, projects, etc.
ビュー describes the available views. Views are read-only tables that are statically defined to model Zoho Projects entities such as project and task layouts.
The Sync App 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.
| 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. |
Fetches all client contacts from a portal.
SELECT * FROM Contacts WHERE ClientId = '123456000000045005'
To create a new Contact you can specify the following fields:
INSERT INTO Contacts (WorkProjects, ClientId, FirstName, LastName, Email, Invoicerate)
VALUES ('123456000000031899', '123456000000039025', 'TestFirstname222', 'TestLastname222', '[email protected]', '15')
To update a Contact specify the Id field.
UPDATE Contacts SET FirstName = 'updatedname', LastName = 'updatedlastname', email = '[email protected]' WHERE Id = '166135000000038075'
Contacts can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Contacts WHERE Id = '123456000000040053'
| 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. |
| String | False |
Contact Email. | |
| InvoiceRate | String | False |
Contact Invoice Rate. |
| WorkProjects | String | False |
Array of Project Ids. Multiple Ids can be separated with comma. |
Returns the list of client companies in the portal.
SELECT * FROM PortalClients
To create a new PortalClient you can specify the following fields:
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')
| 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 |
Gets all the groups for the specified project.
SELECT * FROM ProjectGroups
To create a new ProjectGroup you can use the below query:
INSERT INTO ProjectGroups (name) VALUES ('New Project Group')
ProjectGroups can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM ProjectGroups WHERE Id = '123456000000045018'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Project Group Id. |
| Name | String | False |
Project Group Name. |
| Default | Boolean | False |
Is Default Project Group. |
Gets all the projects for the logged in user.
SELECT * FROM Projects WHERE Id = '123456000000039053'
To create a new Project you can specify the following fields:
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')
You can use the below query to update a Project:
UPDATE Projects SET Currency = 'USD', SingleLinCustomField = 'New Custom Field Value' WHERE Id = '123456000000039053'
Projects can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Projects WHERE Id = '123456000000039053'
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastModifiedTime | Datetime |
Project Last Modified Time. |
| GroupId | String |
Project Group Id. |
| Assignee | String |
Project Assignee. |
Fetches all the tags present in a specific portal.
SELECT * FROM Tags
To create a new Tag you can specify the following fields:
INSERT INTO Tags (Name, ColorClass) VALUES ('New Tag', 'bg-tag16')
To update a Tag specify the Id field.
UPDATE Tags SET Name = 'Updated Name', ColorClass = 'bg-tag99' WHERE Id = '123456000000043057'
Tags can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Tags WHERE Id = '123456000000043057'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Tags | String |
Fetch the team details from the portal.
SELECT * FROM Teams
To create a new Team you can specify the following fields:
INSERT INTO Teams (GroupName, UserIdArr, TeamLead, ProjIds)" +
VALUES ('TestTeam5', '["123456000000031003", "123456000000032055"]', '123456000000032055', '["123456000000031899"]
To update a Team specify the GroupId field.
UPDATE Teams SET TeamLead = '123456000000031003', UserIdArr = '["123456000000031003", "123456000000032055"]', ProjIds = '["123456000000031899"]', GroupName = 'TestTeam5' WHERE GroupId = '123456000000036001'
Teams can be deleted by providing the GroupId and issuing a DELETE statement.
DELETE FROM Teams WHERE GroupId = '123456000000044025'
| 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. |
Gets the details of all the users in a specific project.
| 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. |
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| UserType | String |
User Type. 使用できる値は次のとおりです。active, inactive |
The Sync App 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.
| 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. |
Lists all the bugs created by you or assigned to you.
SELECT * FROM MyBugs WHERE Owner = '12345021738' AND ViewType = 'owned' AND StatusType = 'open' ORDER BY CreatedDate
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Owner | String | Bug Owner. |
| ViewType | String | Bug View Type.
使用できる値は次のとおりです。reported, owned |
| LastModifiedTime | Datetime | Bug Last Modified Time. |
Get all the milestones assigned to a particular user in the given project.
SELECT * FROM MyMilestones WHERE ProjectId IN ('12345000000030899', '12345000000033005') AND Flag = 'internal' ORDER BY CreatedDate
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastModifiedTime | Datetime | Milestone Last Modified Time. |
Gets all your tasks in the portal.
SELECT * FROM MyTasks WHERE MilestoneId = '12345600000123' AND Priority = 'High'
| 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. |
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. |
Gets the time logs under a specific bug.
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
| 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 |
Gets all the project custom fields.
SELECT * FROM ProjectCustomFields
| 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. |
Gets list of all project custom status.
SELECT * FROM ProjectCustomStatus
| 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. |
Gets list of project layouts.
SELECT * FROM ProjectLayouts
| Name | Type | Description |
| Id [KEY] | String | Project Layout Id. |
| Name | String | Project Layout Name. |
| Default | Boolean | Is Default Project Layout. |
View the list of all the task layouts available in your portal.
SELECT * FROM TaskLayouts
| Name | Type | Description |
| Id [KEY] | String | Task Layout Id. |
| Name | String | Task Layout Name. |
| Default | Boolean | Task Layout Default. |
Fetches status history of tasks from the Portal.
SELECT * FROM TaskStatusHistory ORDER BY LastModifiedTime
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastModifiedTime | Datetime | Task Status History Last Modified Time. |
Fetch all timesheet custom fields across the project.
SELECT * FROM TimesheetCustomFields
| 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. |
Gets the details of all users in a specific portal.
| Name | Type | Description |
| AvailableUsersCount | String | Available User Count. |
The Sync App 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.
テーブル describes the available tables. Tables are statically defined to model Zoho Projects entities such as bugs, events, tasks, etc.
ビュー describes the available views. Views are read-only tables that are statically defined to model Zoho Projects entities such as activities, clients, documents, etc.
The Sync App 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.
| 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. |
Fetches the details of the task associated with a bug.
This table shows associations between Bugs and Tasks.
SELECT * FROM BugAssociatedTasks WHERE BugId = '123439000000045005'
To add a new bug-task association specify the BugId and TaskId fields.
INSERT INTO BugAssociatedTasks (BugId, TaskId) VALUES ('123418000000045005', '["123418000000044005"]')
To delete an existing bug-task association specify the BugId and TaskId fields.
DELETE FROM BugAssociatedTasks WHERE BugId = '123418000000045005' AND TaskId = '123418000000044005'
| 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. |
Fetch comments for the bug.
SELECT * FROM BugComments WHERE BugId = '123456000000045005'
To add a Bug Comment specify the BugId and Comment fields.
INSERT INTO BugComments (BugId, Comment) VALUES ('123456000000045005', 'Test Comment #1')
Bug Comments can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM BugComments WHERE BugId = '123456000000045005' AND Id = '123456000000045042'
| 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. |
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.
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 * FROM BugEntityProperties WHERE BugId = '123456000000034087' AND PropertyKey = 'key1'
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')
ZohoProjects allows updates for the PropertyValue column.
UPDATE BugEntityProperties SET PropertyValue = 'This is an updated property value' WHERE BugId = '123456000000034087' AND PropertyKey = 'key1'
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'
| 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. |
Get list of followers for the bug.
SELECT * FROM BugFollowers WHERE BugId = '123456000000042110'
To add a Bug Follower specify the BugId and Follower fields.
INSERT INTO BugFollowers (BugId, BugFollowers) VALUES ('123456000000042110', '12345649448')
Bug Followers can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM BugFollowers WHERE BugId = '123456000000042110' AND FollowerId = '12345649448'
| 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. |
Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.
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')
To create a new Bug, you can specify the following fields:
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')
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'
Bugs can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Bugs WHERE Id = '123456000000042126'
| 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. |
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. |
Gets the time logs under a specific bug.
SELECT * FROM BugTimelogs WHERE BugId = '123456000000045005'
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')
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'
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'
| 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. |
Fetches all the tags present in a specific portal.
SELECT * FROM Events WHERE Status = 'open'
To create a new Event you can specify the following fields:
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')
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'
Events can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Events WHERE Id = '123456000000045018'
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Status | String |
Event Status. 使用できる値は次のとおりです。open, closed |
Gets all the forum categories.
SELECT * FROM ForumCategories
To create a new Forum Category you can use the below query:
INSERT INTO ForumCategories (name) VALUES ('New Forum Category')
ForumCategories can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM ForumCategories WHERE Id = '123456000000045018'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Forum Category Id. |
| Name | String | False |
Forum Category Name. |
Gets all the forum comments.
SELECT * FROM ForumComments WHERE ForumId = '123456000000045018'
To create a new Forum Comment you can use the below query:
INSERT INTO ForumComments (ForumId, Content, ParentId)
VALUES ('123456000000045028', 'Forum Comment Reply', '123456000000043083')
Forum Comments can be deleted by providing the Id, ForumId and issuing a DELETE statement.
DELETE FROM ForumComments WHERE Id = '123456000000043083' AND ForumId = '123456000000045028'
| 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. |
Gets all the forums in the given project.
SELECT * FROM Forums WHERE Id = '123456000000043771'
To create a new Forum, you can specify the following fields:
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)
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'
Forums can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Forums WHERE Id = '123456000000043771'
| 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). |
Gets list of project layouts.
SELECT * FROM Milestones WHERE Id = '123456000000043771' WHERE flag = 'internal'
To create a new Milestone you can specify the following fields:
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')
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'
Milestones can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Milestones WHERE Id = '123456000000043021'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| DisplayType | String |
Milestone Display Type. 使用できる値は次のとおりです。upcoming, delayed |
| LastModifiedTime | Datetime |
Milestone Last Modified Time. |
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.
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 * FROM ProjectEntityProperties WHERE PropertyKey = 'key1'
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')
ZohoProjects allows updates for the PropertyValue column.
UPDATE ProjectEntityProperties SET PropertyValue = 'This is an updated property value' WHERE PropertyKey = 'key1'
Project Entity Properties can be deleted by providing Id, PropertyKey and issuing a DELETE statement.
DELETE FROM ProjectEntityProperties WHERE PropertyKey = 'key1' AND Id = '166135000000035001'
| 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. |
Gets the details of all the users in a specific project.
| 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. |
| 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 |
Gets the statuses for the given project.
SELECT * FROM Statuses
To create a new Status you can specify the following fields:
INSERT INTO Statuses (Content) VALUES ('My Custom Status')
| 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. |
Retrieve details of who modified a specific task and when.
SELECT * FROM TaskActivities WHERE TaskId = '123456789'
| 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. |
Get all the task comments.
SELECT * FROM TaskComments WHERE TaskId = '123456000000040013'
To add a Task Comment specify the TaskId and Comment fields.
INSERT INTO TaskComments (TaskId, content) VALUES ('123456000000040013', 'SQL Comment #6')
To update a Task Comments specify the Id field.
UPDATE TaskComments SET Content = 'Updated forum post content' WHERE Id = '123456000000043771' AND TaskId = '123456000000040013'
Task Comments can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM TaskComments WHERE TaskId = '123456000000045005' AND Id = '123456000000045042'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastModifiedTime | Datetime |
Task Comment Last Modified Time. |
Usage information for the operation TaskCustomfields.rsd.
| 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. |
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.
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 * FROM TaskEntityProperties WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1'
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')
ZohoProjects allows updates for the PropertyValue column.
UPDATE TaskEntityProperties SET PropertyValue = 'This is an updated property value' WHERE TaskId = '123456000000034087' AND PropertyKey = 'key1'
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'
| 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. |
Get all the task lists in the given project.
SELECT * FROM Tasklists WHERE MilestoneId = '12345600000123' AND Flag = 'internal'
To create a new Tasklist you can specify the following fields:
INSERT INTO Tasklists (name, flag, ShiftDays)
VALUES ('New Tasklist #2', 'internal', '2022-03-10T01:00:00Z')
To update a Tasklist specify the Id field.
UPDATE Tasklists SET Name = 'SQL Updated tasklist #7' WHERE Id = '123456000000041033'
Tasklists can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Tasklists WHERE Id = '123456000000041033'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Flag | String |
Tasklist Flag. 使用できる値は次のとおりです。internal, external |
Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.
SELECT * FROM Tasks WHERE MilestoneId = '12345600000123' AND Priority = 'High' ORDER BY CreatedDate
To create a new Task you can specify the following fields:
INSERT INTO Tasks (Name, Description, Duration, DurationType, Priority, BudgetValue)
VALUES ('New Task #2', 'This is a test description', '5', 'hrs', 'High', '1000')
To update a Task specify the Id field.
UPDATE Tasks SET Priority = 'Low' WHERE Id = '123456000000034003'
Tasks can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Tasks WHERE Id = '123456000000034003'
| 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. |
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. |
View all the subtasks of the given task.
SELECT * FROM TaskSubtasks WHERE TaskId = '12345600000123'
To create a new Task you can specify the following fields:
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')
| 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. |
Gets the time logs under a specific task.
SELECT * FROM TaskTimelogs WHERE TaskId = '123456000000045005'
To create a new Task Timelog you can specify the following fields:
INSERT INTO TaskTimelogs (TaskId, LogDate, BillStatus, HoursDisplay, Notes) " +
VALUES ('123456000000040013', '2022-03-03', 'Non Billable', '01:20', 'This is a test timelog')
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'
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'
| 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. |
Fetch details of a particular team.
SELECT * FROM TeamUsers WHERE GroupId = '123456000000033021'
To create a new Team you must specify the following fields:
INSERT INTO TeamUsers (GroupId, ZPUID)
VALUES ('123456000000034163', '123456000000031003')
TeamUsers can be deleted by providing the GroupId and Id and issuing a DELETE statement.
DELETE FROM TeamUsers WHERE GroupId = '123456000000034163' AND Id = '123456000000031003'
| 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. |
| 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. |
The Sync App 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.
| 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. |
List all the recent activities of the project.
SELECT * FROM Activities
| 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. |
Gets all the activities for the given bug.
SELECT * FROM BugActivities WHERE BugId = '12345600001'
| 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. |
Get details of attachments for a bug.
| 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. |
Gets all the custom fields in the given project.
SELECT * FROM BugCustomFields WHERE BugId = '12345600001'
| 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. |
Get bug's resolution.
| 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. |
Returns the list of client companies associated with a specific project Id.
SELECT * FROM Clients WHERE Id = '12345600001'
| 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. |
List all the recent activities of the project.
| 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. |
Retrieve details of attachments associated to the task.
SELECT * FROM TaskAttachments WHERE TaskId = '123456000000112'
| 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. |
Gets the time logs under a specific bug.
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
| 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 |
The Sync App models information about all of the portals attached to your account in the "ZohoProjects" schema in the "CData" catalog.
ストアドプロシージャ are function-like interfaces to Zoho Projects. Stored procedures allow you to execute operations to Zoho Projects, including approving timelogs and reordering tasks.
The Sync App models account-level information about all portals as a single "Portals" table.
| Name | Description |
| Portals | Gets all the portals for the logged in user. |
Gets all the portals for the logged in user.
The Sync App 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 Sync App.
SELECT * FROM Portals WHERE Id = '20081021809'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ViewId | String |
Stored procedures are function-like interfaces that enable the Sync App 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.
| 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. |
Adds user to an existing client company.
EXEC AddUserToClientCompany PortalId = '12345317133', CompanyId = '123456000000039025', ContactEmail = '[email protected]'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Approve general/bug/task time log.
EXEC ApproveTimelog PortalId = '12345317133', ProjectId = '123456000000031899', LogId = '123456000000031977', Approval = 'approve', Reason = 'Submitted timelog is approved', EntityType = 'general', EntityId = '1234560001'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Associate related bugs to a task.
EXEC AssociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Associates a tag with a specific entity in a specific project.
EXEC AssociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Associates a tag with a specific entity in a specific project.
EXEC AssociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task', EntityId = '123456000000034087'
| 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' |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Associate related bugs to a task.
EXEC DissociateBugs PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000031977', BugId = '123456000000034087'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Dissociate a client contact from a project.
EXEC DissociateContacts PortalId = '12345317133', ProjectId = '123456000000031899', ContactId = '1234560000000123456'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Dissociates a tag with a specific entity in a specific project.
EXEC DissociateTags PortalId = '12345317133', ProjectId = '123456000000031899', TagId = '123456000000031977', EntityType = 'Task', EntityId = '123456000000034087'
| 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' |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Follow a forum post.
EXEC ForumFollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Unfollow a forum post.
EXEC ForumSelectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Unfollow a forum post.
EXEC ForumUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Unfollow a forum post.
EXEC ForumUnselectBestAnswer PortalId = '12345317133', ProjectId = '123456000000031899', ForumId = '123456000000034053', CommentId = '123456000000039021'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Gets an authentication token from ZohoProjects.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Scope | String | False | A comma-separated list of permissions to request from the user. Please check the ZohoProjects API for a list of available permissions.
デフォルト値はZohoProjects.portals.ALL,ZohoProjects.projects.ALL,ZohoProjects.status.ALL,ZohoProjects.milestones.ALL,ZohoProjects.tasklists.ALL,ZohoProjects.tasks.ALL,ZohoProjects.tags.ALL,ZohoProjects.bugs.ALL,ZohoProjects.events.ALL,ZohoProjects.forums.ALL,ZohoProjects.users.ALL,ZohoProjects.clients.ALL,ZohoProjects.documents.ALL,ZohoProjects.search.READ,ZohoProjects.entity_properties.ALL,ZohoProjects.activities.READ,ZohoProjects.timesheets.ALLです。 |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the ZohoProjects app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from ZohoProjects after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the ZohoProjects authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| AccountsServer | String | False | The full Account Server URL that will be used to retrieve the OAuth Access Token. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with ZohoProjects. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
| AccountsServer | String | The full Account Server URL. |
| APIDomain | String | The full URL of the API domain. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the ZohoProjects app settings. |
| Scope | String | False | A comma-separated list of scopes to request from the user. Please check the ZohoProjects API documentation for a list of available permissions.
デフォルト値はZohoProjects.portals.ALL,ZohoProjects.projects.ALL,ZohoProjects.status.ALL,ZohoProjects.milestones.ALL,ZohoProjects.tasklists.ALL,ZohoProjects.tasks.ALL,ZohoProjects.tags.ALL,ZohoProjects.bugs.ALL,ZohoProjects.events.ALL,ZohoProjects.forums.ALL,ZohoProjects.users.ALL,ZohoProjects.clients.ALL,ZohoProjects.documents.ALL,ZohoProjects.search.READ,ZohoProjects.entity_properties.ALL,ZohoProjects.activities.READ,ZohoProjects.timesheets.ALLです。 |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the ZohoProjects authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with ZohoProjects.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| AccountsServer | String | False | The full Account Server URL that will be used to retrieve a new access token. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token returned from ZohoProjects. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Update the team lead.
EXEC SelectTeamLead PortalId = '12345317133', ProjectId = '123456000000031899', UserId = '123456000000033053'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the update was successful. |
Follow a task in the given project.
EXEC TaskFollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Moves a task from one tasklist to another tasklist. The target tasklist can be of the same project or different project.
EXEC TaskMove PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', FromTasklist = '123456000000031932', ToTasklist = '123456000000031941'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
Reorders the tasks in the given project. Task will be reordered in-between two tasks based on the previous and next task Ids.
EXEC TaskReorder PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', PreviousTaskId = '123456000000031932', NextTaskId = '123456000000031941'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the update was successful. |
Unfollow a task in the given project.
EXEC TaskUnfollow PortalId = '12345317133', ProjectId = '123456000000031899', TaskId = '123456000000034053', UserId = '123456000000039021'
| 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. |
| Name | Type | Description |
| Success | String | Specifies whether the execution was successful. |
| プロパティ | 説明 |
| Region | サーバーURL のトップレベルドメイン(TLD)。 |
| プロパティ | 説明 |
| PortalId | Restrict exposed entities based on the Portal Id. If left empty all available portals will be exposed. |
| ProjectId | Restrict exposed entities based on the Project Id. If left empty, all available portals will be exposed. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がZoho Projects にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| Region | サーバーURL のトップレベルドメイン(TLD)。 |
サーバーURL のトップレベルドメイン(TLD)。
アカウントが米国以外のドメインにある場合、地域に応じてRegion を変更してください。InitiateOAuth=Off で独自のOAuth アクセストークンを使用する場合のみ、これを指定する必要があります。それ以外の場合、Region はOAuth フローから取得されます。使用可能なすべての値を表に示します。
| Region | Domain |
| US | .com |
| Europe | .eu |
| India | .in |
| Australia | .com.au |
| Japan | .jp |
| China | .com.cn |
Restrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.
Restrict exposed entities based on the Portal Id. If left empty all available portals will be exposed.
Restrict exposed entities based on the Project Id. If left empty, all available portals will be exposed.
Restrict 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 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
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 |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がZoho Projects への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がZoho Projects への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がZoho Projects にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\ZohoProjects Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | provider がZoho Projects にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
provider がZoho Projects にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
クエリを処理する際、Zoho Projects でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。
Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Portals WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.