The CData Sync App provides a straightforward way to continuously pipeline your Microsoft Project data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Microsoft Project connector can be used from the CData Sync application to pull data from Microsoft Project and move it to any of the supported destinations.
The Sync App enables bidirectional SQL access to Project Server web apps by modeling them as relational databases through Microsoft Project's OData APIs.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
To connect to the Microsoft Project data source, set these connection properties:
To use your login credentials to connect to Microsoft Project on SharePoint Online, set the AuthScheme to SharePointOnlineCookies, User to your user login, and Password to your user login password.
To enable this authentication from all Microsoft Project OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.
The following subsections describe how to authenticate to Microsoft Project from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Microsoft Project, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
To connect to ADFS, set the AuthScheme to ADFS, and set these properties:
Example connection string:
AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';
The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.
To connect to Okta, set the AuthScheme to Okta, and set these properties:
If you are using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:
Example connection string:
AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;
To connect to OneLogin, set the AuthScheme to OneLogin, and set these properties:
To authenticate to OneLogin, set these SSOProperties:
The following example connection string uses an API key to connect to OneLogin:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;SSOProperties='OAuthClientID=3fc8394584f153ce3b7924d9cd4f686443a52b;OAuthClientSecret=ca9257fd5cc3277abb5818cea28c06fe9b3b285d73d06;Subdomain=OneLoginSubDomain;AppId=1433920';
This configuration requires two separate Azure AD applications:
To connect to Azure AD, set the AuthScheme to AzureAD, and set these properties:
To authenticate to Azure AD, set these SSOProperties:
Example connection string:
AuthScheme=AzureAD;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
There have been some changes made to the Sync App in the 2020 edition that should be taken into consideration.
Prior to the 2020 edition of the Sync App, connections to Microsoft Project using both the CSOM and OData interface were supported, which lead to difficulties in maintaining the two schemas concurrently.
By removing support for the CSOM, connections to Microsoft Project are streamlined due to the lack of special connection properties made specifically for each schema. Also, the OData interface can now perform all of the same CRUD operations that the CSOM is capable of. Lastly, the CSOM is poorly documented and more error-prone than OData.
For these reasons, the decision was made to deprecate support for the CSOM in favor of exclusively supporting the OData interface.
This section details a selection of advanced features of the Microsoft Project Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Microsoft Project objects as relational tables and views. A Microsoft Project object has relationships to other objects; in the tables, these relationships are expressed through foreign keys.
The ODataV2 Data Model (default) can be used for full CRUD operations. Main columns metadata is dynamically retrieved for each entity, but the schema is fixed and custom fields are not included.
Tables and Views describe a sample the tables available in the ODataV2 API.
The ODataV1 Data Model can only be used for reading data. Metadata is dynamically retrieved, including the custom fields for this schema.
Views describe a sample the views available in the ODataV1 API.
The ODataV2 schema implements the ProjectServer service endpoints, which has support for full CRUD operations.
Tables are retrieved dynamically from the authenticated Microsoft Project account.
Read-only Views are retrieved dynamically from the authenticated Microsoft Project account.
Stored Procedures are function-like interfaces to Microsoft Project. Stored procedures allow you to execute operations to Microsoft Project.
The Sync App models the data in Microsoft Project as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Calendars | Retrieve and modify calendars. |
| DraftAssignments | Retrieve and modify draft assignments. |
| DraftProjectResources | Retrieve and modify draft project resources. |
| DraftProjects | Retrieve and modify draft projects. |
| DraftTaskLinks | Retrieve and modify draft task links. |
| DraftTasks | Retrieve and modify draft tasks. |
| EnterpriseProjectTypes | Retrieve and modify project types. |
| EnterpriseResources | Retrieve and modify resources. |
| EventHandlers | Retrieve and modify project event handlers. |
| Phases | Retrieve and modify project phases. |
| PublishedProjects | Retrieve and modify published projects. |
| Stages | Retrieve and modify project stages. |
| StagesProjectDetailPages | Retrieve and modify project detail pages. |
| TimeSheetLines | Retrieve and modify timesheet lines. |
| TimeSheets | Retrieve and modify timesheets. |
| WorkflowActivities | Retrieve and modify workflow activities. |
Retrieve and modify calendars.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| Created | Datetime | False | False | ||
| IsStandardCalendar | Bool | False | False | ||
| Modified | Datetime | False | False | ||
| Name | String | False | False | ||
| OriginalId | String | False | False | ||
| LinkedBaseCalendarExceptions | String | False | False |
Retrieve and modify draft assignments.
To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.
SELECT * FROM DraftAssignments WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| ActualCostWorkPerformed | Double | False | False | ||
| ActualOvertimeCost | Double | False | False | ||
| BaselineCost | Double | False | False | ||
| BaselineCostPerUse | Double | False | False | ||
| BaselineFinish | Datetime | False | False | ||
| BaselineStart | Datetime | False | False | ||
| BaselineWork | String | False | False | ||
| BaselineWorkMilliseconds | Int | False | False | ||
| BaselineWorkTimeSpan | Time | False | False | ||
| BudgetedCostWorkPerformed | Double | False | False | ||
| BudgetedCostWorkScheduled | Double | False | False | ||
| CostVariance | Double | False | False | ||
| CostVarianceAtCompletion | Double | False | False | ||
| Created | Datetime | False | False | ||
| CurrentCostVariance | Double | False | False | ||
| Finish | Datetime | False | False | ||
| FinishVariance | String | False | False | ||
| FinishVarianceMilliseconds | Int | False | False | ||
| FinishVarianceTimeSpan | Time | False | False | ||
| IsConfirmed | Bool | False | False | ||
| IsOverAllocated | Bool | False | False | ||
| IsPublished | Bool | False | False | ||
| IsResponsePending | Bool | False | False | ||
| IsUpdateNeeded | Bool | False | False | ||
| LevelingDelay | String | False | False | ||
| LevelingDelayMilliseconds | Int | False | False | ||
| LevelingDelayTimeSpan | Time | False | False | ||
| Modified | Datetime | False | False | ||
| Notes | String | False | False | ||
| OvertimeCost | Double | False | False | ||
| RemainingCost | Double | False | False | ||
| RemainingOvertimeCost | Double | False | False | ||
| Resume | Datetime | False | False | ||
| ScheduleCostVariance | Double | False | False | ||
| Start | Datetime | False | False | ||
| StartVariance | String | False | False | ||
| StartVarianceMilliseconds | Int | False | False | ||
| StartVarianceTimeSpan | Time | False | False | ||
| Stop | Datetime | False | False | ||
| WorkContourType | Int | False | False | ||
| WorkVariance | String | False | False | ||
| WorkVarianceMilliseconds | Int | False | False | ||
| WorkVarianceTimeSpan | Time | False | False | ||
| LinkedCustomFields | String | False | False | ||
| ActualCost | Double | False | False | ||
| ActualFinish | Datetime | False | False | ||
| ActualOvertimeWork | String | False | False | ||
| ActualOvertimeWorkMilliseconds | Int | False | False | ||
| ActualOvertimeWorkTimeSpan | Time | False | False | ||
| ActualStart | Datetime | False | False | ||
| ActualWork | String | False | False | ||
| ActualWorkMilliseconds | Int | False | False | ||
| ActualWorkTimeSpan | Time | False | False | ||
| BudgetedCost | Double | False | False | ||
| BudgetedWork | String | False | False | ||
| BudgetedWorkMilliseconds | Int | False | False | ||
| BudgetedWorkTimeSpan | Time | False | False | ||
| Cost | Double | False | False | ||
| CostRateTable | Int | False | False | ||
| DefaultBookingType | Int | False | False | ||
| Delay | String | False | False | ||
| DelayMilliseconds | Int | False | False | ||
| DelayTimeSpan | Time | False | False | ||
| IsLockedByManager | Bool | False | False | ||
| IsWorkResource | Bool | False | False | ||
| OvertimeWork | String | False | False | ||
| OvertimeWorkMilliseconds | Int | False | False | ||
| OvertimeWorkTimeSpan | Time | False | False | ||
| PercentWorkComplete | Int | False | False | ||
| RegularWork | String | False | False | ||
| RegularWorkMilliseconds | Int | False | False | ||
| RegularWorkTimeSpan | Time | False | False | ||
| RemainingOvertimeWork | String | False | False | ||
| RemainingOvertimeWorkMilliseconds | Int | False | False | ||
| RemainingOvertimeWorkTimeSpan | Time | False | False | ||
| RemainingWork | String | False | False | ||
| RemainingWorkMilliseconds | Int | False | False | ||
| RemainingWorkTimeSpan | Time | False | False | ||
| ResourceCapacity | Double | False | False | ||
| ResourceId | String | False | False | ||
| TaskId | String | False | False | ||
| Work | String | False | False | ||
| WorkMilliseconds | Int | False | False | ||
| WorkTimeSpan | Time | False | False | ||
| Owner_Id | Int | True | False | ||
| Parent_Id | String | True | False | ||
| Resource_Id | String | True | False | ||
| Task_Id | String | True | False | ||
| LinkedOwner | String | False | False | ||
| LinkedParent | String | False | False | ||
| LinkedResource | String | False | False | ||
| LinkedTask | String | False | False | ||
| ProjectId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify draft project resources.
To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.
SELECT * FROM DraftProjectResources WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| ActualCost | Double | False | False | ||
| ActualCostWorkPerformed | String | False | False | ||
| ActualCostWorkPerformedMilliseconds | Int | False | False | ||
| ActualCostWorkPerformedTimeSpan | Time | False | False | ||
| ActualOvertimeCost | Double | False | False | ||
| ActualOvertimeWork | String | False | False | ||
| ActualOvertimeWorkMilliseconds | Int | False | False | ||
| ActualOvertimeWorkTimeSpan | Time | False | False | ||
| ActualWork | String | False | False | ||
| ActualWorkMilliseconds | Int | False | False | ||
| ActualWorkTimeSpan | Time | False | False | ||
| AvailableFrom | Datetime | False | False | ||
| AvailableTo | Datetime | False | False | ||
| BaselineCost | Double | False | False | ||
| BaselineWork | String | False | False | ||
| BaselineWorkMilliseconds | Int | False | False | ||
| BaselineWorkTimeSpan | Time | False | False | ||
| BudetCostWorkPerformed | Double | False | False | ||
| BudgetedCost | Double | False | False | ||
| BudgetedCostWorkScheduled | Double | False | False | ||
| BudgetedWork | String | False | False | ||
| BudgetedWorkMilliseconds | Int | False | False | ||
| BudgetedWorkTimeSpan | Time | False | False | ||
| Cost | Double | False | False | ||
| CostVariance | Double | False | False | ||
| CostVarianceAtCompletion | Double | False | False | ||
| Created | Datetime | False | False | ||
| CurrentCostVariance | Double | False | False | ||
| Finish | Datetime | False | False | ||
| IsBudgeted | Bool | False | False | ||
| IsGenericResource | Bool | False | False | ||
| IsOverAllocated | Bool | False | False | ||
| Modified | Datetime | False | False | ||
| Notes | String | False | False | ||
| OvertimeCost | Double | False | False | ||
| OvertimeWork | String | False | False | ||
| OvertimeWorkMilliseconds | Int | False | False | ||
| OvertimeWorkTimeSpan | Time | False | False | ||
| PeakWork | String | False | False | ||
| PeakWorkMilliseconds | Int | False | False | ||
| PeakWorkTimeSpan | Time | False | False | ||
| PercentWorkComplete | Int | False | False | ||
| RegularWork | String | False | False | ||
| RegularWorkMilliseconds | Int | False | False | ||
| RegularWorkTimeSpan | Time | False | False | ||
| RemainingCost | Double | False | False | ||
| RemainingOvertimeCost | Double | False | False | ||
| RemainingOvertimeWork | String | False | False | ||
| RemainingOvertimeWorkMilliseconds | Int | False | False | ||
| RemainingOvertimeWorkTimeSpan | Time | False | False | ||
| RemainingWork | String | False | False | ||
| RemainingWorkMilliseconds | Int | False | False | ||
| RemainingWorkTimeSpan | Time | False | False | ||
| ScheduleCostVariance | Double | False | False | ||
| Start | Datetime | False | False | ||
| Work | String | False | False | ||
| WorkMilliseconds | Int | False | False | ||
| WorkTimeSpan | Time | False | False | ||
| WorkVariance | String | False | False | ||
| WorkVarianceMilliseconds | Int | False | False | ||
| WorkVarianceTimeSpan | Time | False | False | ||
| EnterpriseResource_Id | String | True | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedEnterpriseResource | String | False | False | ||
| CanLevel | Bool | False | False | ||
| Code | String | False | False | ||
| CostAccrual | Int | False | False | ||
| CostCenter | String | False | False | ||
| CostPerUse | Double | False | False | ||
| DefaultBookingType | Int | False | False | ||
| String | False | False | |||
| Group | String | False | False | ||
| Initials | String | False | False | ||
| MaterialLabel | String | False | False | ||
| MaximumCapacity | Double | False | False | ||
| Name | String | False | False | ||
| OvertimeRate | Double | False | False | ||
| OvertimeRateUnits | Int | False | False | ||
| Phonetics | String | False | False | ||
| StandardRate | Double | False | False | ||
| StandardRateUnits | Int | False | False | ||
| DefaultAssignmentOwner_Id | Int | True | False | ||
| LinkedAssignments | String | False | False | ||
| LinkedDefaultAssignmentOwner | String | False | False | ||
| ProjectId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify draft projects.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| ApprovedEnd | Datetime | False | False | ||
| ApprovedStart | Datetime | False | False | ||
| CalculateActualCosts | Bool | False | False | ||
| CalculatesActualCosts | Bool | False | False | ||
| CheckedOutDate | Datetime | False | False | ||
| CheckOutDescription | String | False | False | ||
| CheckOutId | String | False | False | ||
| CreatedDate | Datetime | False | False | ||
| CriticalSlackLimit | Int | False | False | ||
| DefaultFinishTime | Datetime | False | False | ||
| DefaultOvertimeRateUnits | Int | False | False | ||
| DefaultStandardRateUnits | Int | False | False | ||
| DefaultStartTime | Datetime | False | False | ||
| HasMppPendingImport | Bool | False | False | ||
| HonorConstraints | Bool | False | False | ||
| IsCheckedOut | Bool | False | False | ||
| LastPublishedDate | Datetime | False | False | ||
| LastSavedDate | Datetime | False | False | ||
| ListId | String | False | False | ||
| MoveActualIfLater | Bool | False | False | ||
| MoveActualToStatus | Bool | False | False | ||
| MoveRemainingIfEarlier | Bool | False | False | ||
| MoveRemainingToStatus | Bool | False | False | ||
| MultipleCriticalPaths | Bool | False | False | ||
| OptimizerDecision | Int | False | False | ||
| PercentComplete | Int | False | False | ||
| PlannerDecision | Int | False | False | ||
| ProjectSiteUrl | String | False | False | ||
| ProjectType | Int | False | False | ||
| SplitInProgress | Bool | False | False | ||
| SpreadActualCostsToStatus | Bool | False | False | ||
| SpreadPercentCompleteToStatus | Bool | False | False | ||
| SummaryTaskId | String | False | False | ||
| TaskListId | String | False | False | ||
| WebId | String | False | False | ||
| CheckedOutBy_Id | Int | True | False | ||
| EnterpriseProjectType_Id | String | True | False | ||
| Phase_Id | String | True | False | ||
| ProjectSummaryTask_Id | String | True | False | ||
| Stage_Id | String | True | False | ||
| LinkedCheckedOutBy | String | False | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedEngagements | String | False | False | ||
| LinkedEnterpriseProjectType | String | False | False | ||
| LinkedPhase | String | False | False | ||
| LinkedProjectSummaryTask | String | False | False | ||
| LinkedQueueJobs | String | False | False | ||
| LinkedStage | String | False | False | ||
| LinkedUserPermissions | String | False | False | ||
| CurrencyCode | String | False | False | ||
| CurrencyDigits | Int | False | False | ||
| CurrencyPosition | Int | False | False | ||
| CurrencySymbol | String | False | False | ||
| CurrentDate | Datetime | False | False | ||
| DaysPerMonth | Int | False | False | ||
| DefaultEffortDriven | Bool | False | False | ||
| DefaultEstimatedDuration | Bool | False | False | ||
| DefaultFixedCostAccrual | Int | False | False | ||
| DefaultOvertimeRate | Double | False | False | ||
| DefaultStandardRate | Double | False | False | ||
| DefaultTaskType | Int | False | False | ||
| DefaultWorkFormat | Int | False | False | ||
| Description | String | False | False | ||
| FinishDate | Datetime | False | False | ||
| FiscalYearStartMonth | Int | False | False | ||
| MinutesPerDay | Int | False | False | ||
| MinutesPerWeek | Int | False | False | ||
| Name | String | False | False | ||
| NewTasksAreManual | Bool | False | False | ||
| NumberFiscalYearFromStart | Bool | False | False | ||
| OwnerId | String | False | False | ||
| ProjectIdentifier | String | False | False | ||
| ProtectedActualsSynch | Bool | False | False | ||
| ScheduledFromStart | Bool | False | False | ||
| ShowEstimatedDurations | Bool | False | False | ||
| StartDate | Datetime | False | False | ||
| StatusDate | Datetime | False | False | ||
| TrackingMode | Int | False | False | ||
| UtilizationDate | Datetime | False | False | ||
| UtilizationType | Int | False | False | ||
| WeekStartDay | Int | False | False | ||
| WinprojVersion | Decimal | False | False | ||
| Calendar_Id | String | True | False | ||
| IncludeCustomFields_Id | String | True | False | ||
| Owner_Id | Int | True | False | ||
| LinkedAssignments | String | False | False | ||
| LinkedCalendar | String | False | False | ||
| LinkedIncludeCustomFields | String | False | False | ||
| LinkedOwner | String | False | False | ||
| LinkedProjectResources | String | False | False | ||
| LinkedTaskLinks | String | False | False | ||
| LinkedTasks | String | False | False |
Retrieve and modify draft task links.
To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.
SELECT * FROM DraftTaskLinks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| DependencyType | Int | False | False | ||
| EndId | String | False | False | ||
| LinkLagDuration | String | False | False | ||
| PredecessorTaskId | String | False | False | ||
| StartId | String | False | False | ||
| SuccessorTaskId | String | False | False | ||
| End_Id | String | True | False | ||
| Start_Id | String | True | False | ||
| LinkedEnd | String | False | False | ||
| LinkedStart | String | False | False | ||
| ProjectId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify draft tasks.
To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.
SELECT * FROM DraftTasks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| ActualCostWorkPerformed | Double | False | False | ||
| ActualDuration | String | False | False | ||
| ActualDurationMilliseconds | Int | False | False | ||
| ActualDurationTimeSpan | Time | False | False | ||
| ActualOvertimeCost | Double | False | False | ||
| ActualOvertimeWork | String | False | False | ||
| ActualOvertimeWorkMilliseconds | Int | False | False | ||
| ActualOvertimeWorkTimeSpan | Time | False | False | ||
| BaselineCost | Double | False | False | ||
| BaselineDuration | String | False | False | ||
| BaselineDurationMilliseconds | Int | False | False | ||
| BaselineDurationTimeSpan | Time | False | False | ||
| BaselineFinish | Datetime | False | False | ||
| BaselineStart | Datetime | False | False | ||
| BaselineWork | String | False | False | ||
| BaselineWorkMilliseconds | Int | False | False | ||
| BaselineWorkTimeSpan | Time | False | False | ||
| BudgetCost | Double | False | False | ||
| BudgetedCostWorkPerformed | Double | False | False | ||
| BudgetedCostWorkScheduled | Double | False | False | ||
| Contact | String | False | False | ||
| CostPerformanceIndex | Double | False | False | ||
| CostVariance | Double | False | False | ||
| CostVarianceAtCompletion | Double | False | False | ||
| CostVariancePercentage | Int | False | False | ||
| Created | Datetime | False | False | ||
| CurrentCostVariance | Double | False | False | ||
| DurationVariance | String | False | False | ||
| DurationVarianceMilliseconds | Int | False | False | ||
| DurationVarianceTimeSpan | Time | False | False | ||
| EarliestFinish | Datetime | False | False | ||
| EarliestStart | Datetime | False | False | ||
| EstimateAtCompletion | Double | False | False | ||
| ExternalProjectUid | String | False | False | ||
| ExternalTaskUid | String | False | False | ||
| FinishSlack | String | False | False | ||
| FinishSlackMilliseconds | Int | False | False | ||
| FinishSlackTimeSpan | Time | False | False | ||
| FinishVariance | String | False | False | ||
| FinishVarianceMilliseconds | Int | False | False | ||
| FinishVarianceTimeSpan | Time | False | False | ||
| FreeSlack | String | False | False | ||
| FreeSlackMilliseconds | Int | False | False | ||
| FreeSlackTimeSpan | Time | False | False | ||
| IgnoreResourceCalendar | Bool | False | False | ||
| IsCritical | Bool | False | False | ||
| IsDurationEstimate | Bool | False | False | ||
| IsExternalTask | Bool | False | False | ||
| IsOverAllocated | Bool | False | False | ||
| IsRecurring | Bool | False | False | ||
| IsRecurringSummary | Bool | False | False | ||
| IsRolledUp | Bool | False | False | ||
| IsSubProject | Bool | False | False | ||
| IsSubProjectReadOnly | Bool | False | False | ||
| IsSubProjectScheduledFromFinish | Bool | False | False | ||
| IsSummary | Bool | False | False | ||
| LatestFinish | Datetime | False | False | ||
| LatestStart | Datetime | False | False | ||
| LevelingDelay | String | False | False | ||
| LevelingDelayMilliseconds | Int | False | False | ||
| LevelingDelayTimeSpan | Time | False | False | ||
| Modified | Datetime | False | False | ||
| Notes | String | False | False | ||
| OutlinePosition | String | False | False | ||
| OvertimeCost | Double | False | False | ||
| OvertimeWork | String | False | False | ||
| OvertimeWorkMilliseconds | Int | False | False | ||
| OvertimeWorkTimeSpan | Time | False | False | ||
| PercentWorkComplete | Int | False | False | ||
| PreLevelingFinish | Datetime | False | False | ||
| PreLevelingStart | Datetime | False | False | ||
| RegularWork | String | False | False | ||
| RegularWorkMilliseconds | Int | False | False | ||
| RegularWorkTimeSpan | Time | False | False | ||
| RemainingCost | Double | False | False | ||
| RemainingOvertimeCost | Double | False | False | ||
| RemainingOvertimeWork | String | False | False | ||
| RemainingOvertimeWorkMilliseconds | Int | False | False | ||
| RemainingOvertimeWorkTimeSpan | Time | False | False | ||
| RemainingWork | String | False | False | ||
| RemainingWorkMilliseconds | Int | False | False | ||
| RemainingWorkTimeSpan | Time | False | False | ||
| Resume | Datetime | False | False | ||
| ScheduleCostVariance | Double | False | False | ||
| ScheduledDuration | String | False | False | ||
| ScheduledDurationMilliseconds | Int | False | False | ||
| ScheduledDurationTimeSpan | Time | False | False | ||
| ScheduledFinish | Datetime | False | False | ||
| ScheduledStart | Datetime | False | False | ||
| SchedulePerformanceIndex | Double | False | False | ||
| ScheduleVariancePercentage | Int | False | False | ||
| StartSlack | String | False | False | ||
| StartSlackMilliseconds | Int | False | False | ||
| StartSlackTimeSpan | Time | False | False | ||
| StartVariance | String | False | False | ||
| StartVarianceMilliseconds | Int | False | False | ||
| StartVarianceTimeSpan | Time | False | False | ||
| Stop | Datetime | False | False | ||
| ToCompletePerformanceIndex | Double | False | False | ||
| TotalSlack | String | False | False | ||
| TotalSlackMilliseconds | Int | False | False | ||
| TotalSlackTimeSpan | Time | False | False | ||
| WorkBreakdownStructure | String | False | False | ||
| WorkVariance | String | False | False | ||
| WorkVarianceMilliseconds | Int | False | False | ||
| WorkVarianceTimeSpan | Time | False | False | ||
| SubProject_Id | String | True | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedSubProject | String | False | False | ||
| ActualCost | Double | False | False | ||
| ActualFinish | Datetime | False | False | ||
| ActualStart | Datetime | False | False | ||
| ActualWork | String | False | False | ||
| ActualWorkMilliseconds | Int | False | False | ||
| ActualWorkTimeSpan | Time | False | False | ||
| AddAfterId | String | False | False | ||
| BudgetWork | String | False | False | ||
| BudgetWorkMilliseconds | Int | False | False | ||
| BudgetWorkTimeSpan | Time | False | False | ||
| Completion | Datetime | False | False | ||
| ConstraintStartEnd | Datetime | False | False | ||
| ConstraintType | Int | False | False | ||
| Cost | Double | False | False | ||
| Deadline | Datetime | False | False | ||
| Duration | String | False | False | ||
| DurationMilliseconds | Int | False | False | ||
| DurationTimeSpan | Time | False | False | ||
| Finish | Datetime | False | False | ||
| FinishText | String | False | False | ||
| FixedCost | Double | False | False | ||
| FixedCostAccrual | Int | False | False | ||
| IsActive | Bool | False | False | ||
| IsEffortDriven | Bool | False | False | ||
| IsLockedByManager | Bool | False | False | ||
| IsManual | Bool | False | False | ||
| IsMarked | Bool | False | False | ||
| IsMilestone | Bool | False | False | ||
| LevelingAdjustsAssignments | Bool | False | False | ||
| LevelingCanSplit | Bool | False | False | ||
| Name | String | False | False | ||
| OutlineLevel | Int | False | False | ||
| ParentId | String | False | False | ||
| PercentComplete | Int | False | False | ||
| PercentPhysicalWorkComplete | Int | False | False | ||
| Priority | Int | False | False | ||
| RemainingDuration | String | False | False | ||
| RemainingDurationMilliseconds | Int | False | False | ||
| RemainingDurationTimeSpan | Time | False | False | ||
| Start | Datetime | False | False | ||
| StartText | String | False | False | ||
| TaskType | Int | False | False | ||
| UsePercentPhysicalWorkComplete | Bool | False | False | ||
| Work | String | False | False | ||
| WorkMilliseconds | Int | False | False | ||
| WorkTimeSpan | Time | False | False | ||
| Calendar_Id | String | True | False | ||
| Parent_Id | String | True | False | ||
| StatusManager_Id | Int | True | False | ||
| LinkedAssignments | String | False | False | ||
| LinkedCalendar | String | False | False | ||
| LinkedParent | String | False | False | ||
| LinkedPredecessors | String | False | False | ||
| LinkedStatusManager | String | False | False | ||
| LinkedSuccessors | String | False | False | ||
| ProjectId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify project types.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| Departments | String | False | False | ||
| Description | String | False | False | ||
| ImageUrl | String | False | False | ||
| IsDefault | Bool | False | False | ||
| IsManaged | Bool | False | False | ||
| Name | String | False | False | ||
| Order | Int | False | False | ||
| PermissionSyncEnable | Bool | False | False | ||
| ProjectPlanTemplateId | String | False | False | ||
| SiteCreationOption | Int | False | False | ||
| SiteCreationURL | String | False | False | ||
| TaskListSyncEnable | Bool | False | False | ||
| WorkflowAssociationId | String | False | False | ||
| WorkflowAssociationName | String | False | False | ||
| WorkspaceTemplateLCID | Int | False | False | ||
| WorkspaceTemplateName | String | False | False | ||
| LinkedProjectDetailPages | String | False | False |
Retrieve and modify resources.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| CanLevel | Bool | False | False | ||
| Code | String | False | False | ||
| CostAccrual | Int | False | False | ||
| CostCenter | String | False | False | ||
| Created | Datetime | False | False | ||
| DefaultBookingType | Int | False | False | ||
| String | False | False | |||
| ExternalId | String | False | False | ||
| Group | String | False | False | ||
| HireDate | Datetime | False | False | ||
| HyperlinkName | String | False | False | ||
| HyperlinkUrl | String | False | False | ||
| Initials | String | False | False | ||
| IsActive | Bool | False | False | ||
| IsBudget | Bool | False | False | ||
| IsCheckedOut | Bool | False | False | ||
| IsGeneric | Bool | False | False | ||
| IsTeam | Bool | False | False | ||
| MaterialLabel | String | False | False | ||
| Modified | Datetime | False | False | ||
| Name | String | False | False | ||
| Phonetics | String | False | False | ||
| RequiresEngagements | Bool | False | False | ||
| ResourceIdentifier | Int | False | False | ||
| ResourceType | Int | False | False | ||
| TerminationDate | Datetime | False | False | ||
| BaseCalendar_Id | String | True | False | ||
| DefaultAssignmentOwner_Id | Int | True | False | ||
| Self_Id | String | True | False | ||
| TimesheetManager_Id | Int | True | False | ||
| User_Id | Int | True | False | ||
| LinkedAssignments | String | False | False | ||
| LinkedBaseCalendar | String | False | False | ||
| LinkedCostRateTables | String | False | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedDefaultAssignmentOwner | String | False | False | ||
| LinkedEngagements | String | False | False | ||
| LinkedResourceCalendarExceptions | String | False | False | ||
| LinkedSelf | String | False | False | ||
| LinkedTimesheetManager | String | False | False | ||
| LinkedUser | String | False | False | ||
| LinkedUserPermissions | String | False | False |
Retrieve and modify project event handlers.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| AssemblyName | String | False | False | ||
| ClassName | String | False | False | ||
| Description | String | False | False | ||
| EndpointUrl | String | False | False | ||
| EventId | Int | False | False | ||
| Name | String | False | False | ||
| Order | Int | False | False | ||
| Event_Id | Int | True | False | ||
| LinkedEvent | String | False | False |
Retrieve and modify project phases.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| Description | String | False | False | ||
| Name | String | False | False | ||
| LinkedStages | String | False | False |
Retrieve and modify published projects.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| ApprovedEnd | Datetime | False | False | ||
| ApprovedStart | Datetime | False | False | ||
| CalculateActualCosts | Bool | False | False | ||
| CalculatesActualCosts | Bool | False | False | ||
| CheckedOutDate | Datetime | False | False | ||
| CheckOutDescription | String | False | False | ||
| CheckOutId | String | False | False | ||
| CreatedDate | Datetime | False | False | ||
| CriticalSlackLimit | Int | False | False | ||
| DefaultFinishTime | Datetime | False | False | ||
| DefaultOvertimeRateUnits | Int | False | False | ||
| DefaultStandardRateUnits | Int | False | False | ||
| DefaultStartTime | Datetime | False | False | ||
| HasMppPendingImport | Bool | False | False | ||
| HonorConstraints | Bool | False | False | ||
| IsCheckedOut | Bool | False | False | ||
| LastPublishedDate | Datetime | False | False | ||
| LastSavedDate | Datetime | False | False | ||
| ListId | String | False | False | ||
| MoveActualIfLater | Bool | False | False | ||
| MoveActualToStatus | Bool | False | False | ||
| MoveRemainingIfEarlier | Bool | False | False | ||
| MoveRemainingToStatus | Bool | False | False | ||
| MultipleCriticalPaths | Bool | False | False | ||
| OptimizerDecision | Int | False | False | ||
| PercentComplete | Int | False | False | ||
| PlannerDecision | Int | False | False | ||
| ProjectSiteUrl | String | False | False | ||
| ProjectType | Int | False | False | ||
| SplitInProgress | Bool | False | False | ||
| SpreadActualCostsToStatus | Bool | False | False | ||
| SpreadPercentCompleteToStatus | Bool | False | False | ||
| SummaryTaskId | String | False | False | ||
| TaskListId | String | False | False | ||
| WebId | String | False | False | ||
| CheckedOutBy_Id | Int | True | False | ||
| EnterpriseProjectType_Id | String | True | False | ||
| Phase_Id | String | True | False | ||
| ProjectSummaryTask_Id | String | True | False | ||
| Stage_Id | String | True | False | ||
| LinkedCheckedOutBy | String | False | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedEngagements | String | False | False | ||
| LinkedEnterpriseProjectType | String | False | False | ||
| LinkedPhase | String | False | False | ||
| LinkedProjectSummaryTask | String | False | False | ||
| LinkedQueueJobs | String | False | False | ||
| LinkedStage | String | False | False | ||
| LinkedUserPermissions | String | False | False | ||
| CurrencyCode | String | False | False | ||
| CurrencyDigits | Int | False | False | ||
| CurrencyPosition | Int | False | False | ||
| CurrencySymbol | String | False | False | ||
| CurrentDate | Datetime | False | False | ||
| DaysPerMonth | Int | False | False | ||
| DefaultEffortDriven | Bool | False | False | ||
| DefaultEstimatedDuration | Bool | False | False | ||
| DefaultFixedCostAccrual | Int | False | False | ||
| DefaultOvertimeRate | Double | False | False | ||
| DefaultStandardRate | Double | False | False | ||
| DefaultTaskType | Int | False | False | ||
| DefaultWorkFormat | Int | False | False | ||
| Description | String | False | False | ||
| EnterpriseProjectTypeId | String | False | False | ||
| FinishDate | Datetime | False | False | ||
| FiscalYearStartMonth | Int | False | False | ||
| IsEnterpriseProject | Bool | False | False | ||
| MinutesPerDay | Int | False | False | ||
| MinutesPerWeek | Int | False | False | ||
| Name | String | False | False | ||
| NewTasksAreManual | Bool | False | False | ||
| NumberFiscalYearFromStart | Bool | False | False | ||
| OwnerId | String | False | False | ||
| ProjectIdentifier | String | False | False | ||
| ProtectedActualsSynch | Bool | False | False | ||
| ScheduledFromStart | Bool | False | False | ||
| ShowEstimatedDurations | Bool | False | False | ||
| StartDate | Datetime | False | False | ||
| StatusDate | Datetime | False | False | ||
| TrackingMode | Int | False | False | ||
| UtilizationDate | Datetime | False | False | ||
| UtilizationType | Int | False | False | ||
| WeekStartDay | Int | False | False | ||
| WinprojVersion | Decimal | False | False | ||
| Calendar_Id | String | True | False | ||
| Draft_Id | String | True | False | ||
| IncludeCustomFields_Id | String | True | False | ||
| Owner_Id | Int | True | False | ||
| ProjectWorkflowInstance_Id | String | True | False | ||
| LinkedAssignments | String | False | False | ||
| LinkedCalendar | String | False | False | ||
| LinkedDraft | String | False | False | ||
| LinkedEntityLinks | String | False | False | ||
| LinkedIncludeCustomFields | String | False | False | ||
| LinkedOwner | String | False | False | ||
| LinkedProjectResources | String | False | False | ||
| LinkedProjectWorkflowInstance | String | False | False | ||
| LinkedTaskLinks | String | False | False | ||
| LinkedTasks | String | False | False |
Retrieve and modify project stages.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| Behavior | Int | False | False | ||
| CheckInRequired | Bool | False | False | ||
| Description | String | False | False | ||
| Name | String | False | False | ||
| SubmitDescription | String | False | False | ||
| Phase_Id | String | True | False | ||
| WorkflowStatusPage_Id | String | True | False | ||
| LinkedCustomFields | String | False | False | ||
| LinkedPhase | String | False | False | ||
| LinkedProjectDetailPages | String | False | False | ||
| LinkedWorkflowStatusPage | String | False | False |
Retrieve and modify project detail pages.
| Name | Type | ReadOnly | References | Required | Description |
| StageId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify timesheet lines.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False | ||
| Comment | String | False | False | ||
| LineClass | Int | False | False | ||
| ProjectName | String | False | False | ||
| Status | Int | False | False | ||
| TaskName | String | False | False | ||
| TotalWork | String | False | False | ||
| TotalWorkMilliseconds | Int | False | False | ||
| TotalWorkTimeSpan | Time | False | False | ||
| ValidationType | Int | False | False | ||
| Assignment_Id | String | True | False | ||
| TimeSheet_Id | String | True | False | ||
| LinkedAssignment | String | False | False | ||
| LinkedTimeSheet | String | False | False | ||
| LinkedWork | String | False | False | ||
| PeriodId [KEY] | String | True | False |
Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify timesheets.
| Name | Type | ReadOnly | References | Required | Description |
| PeriodId [KEY] | String | False | False | ||
| Comments | String | False | False | ||
| EntryMode | Int | False | False | ||
| IsControlledByOwner | Bool | False | False | ||
| IsProcessed | Bool | False | False | ||
| Name | String | False | False | ||
| Status | Int | False | False | ||
| TotalActualWork | String | False | False | ||
| TotalActualWorkMilliseconds | Int | False | False | ||
| TotalActualWorkTimeSpan | Time | False | False | ||
| TotalNonBillableOvertimeWork | String | False | False | ||
| TotalNonBillableOvertimeWorkMilliseconds | Int | False | False | ||
| TotalNonBillableOvertimeWorkTimeSpan | Time | False | False | ||
| TotalNonBillableWork | String | False | False | ||
| TotalNonBillableWorkMilliseconds | Int | False | False | ||
| TotalNonBillableWorkTimeSpan | Time | False | False | ||
| TotalOvertimeWork | String | False | False | ||
| TotalOvertimeWorkMilliseconds | Int | False | False | ||
| TotalOvertimeWorkTimeSpan | Time | False | False | ||
| TotalWork | String | False | False | ||
| TotalWorkMilliseconds | Int | False | False | ||
| TotalWorkTimeSpan | Time | False | False | ||
| WeekStartsOn | Int | False | False | ||
| Creator_Id | Int | True | False | ||
| Manager_Id | Int | True | False | ||
| Period_Id | String | True | False | ||
| LinkedCreator | String | False | False | ||
| LinkedLines | String | False | False | ||
| LinkedManager | String | False | False | ||
| LinkedPeriod | String | False | False |
Retrieve and modify workflow activities.
| Name | Type | ReadOnly | References | Required | Description |
| Id [KEY] | String | False | False |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Assignment_Resource | Retrieve and modify assignments. |
| Assignment_Task | Retrieve and modify assignments. |
| Events | Retrieve project events. |
| ProjectDetailPages | Retrieve project detail pages. |
| PublishedAssignments | Retrieve published assignments. |
| PublishedProjectResources | Retrieve published project resources. |
| PublishedTaskLinks | Retrieve published task links. |
| PublishedTasks | Retrieve published tasks. |
| Tasks_Assignments | Retrieve and modify assignments. |
| Tasks_Calendar | Retrieve and modify assignments. |
| TimeSheetPeriods | Retrieve timesheets. |
| WorkflowDesigner | Retrieve workflow designers. |
Retrieve and modify assignments.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the table. | |
| Name | String | The name of the association. | |
| ProjectId | String | The project Id. | |
| AssignmentId | String | The assignment Id. |
Retrieve and modify assignments.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the table. | |
| Name | String | The name of the association. | |
| ProjectId | String | The project Id. | |
| AssignmentId | String | The assignment Id. |
Retrieve project events.
| Name | Type | References | Description |
| Id [KEY] | Int | ||
| EventName | String | ||
| SourceName | String |
Retrieve project detail pages.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| Name | String | ||
| PageType | Int | ||
| Item_HasUniqueRoleAssignments | Bool | ||
| LinkedItem | String |
Retrieve published assignments.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| ActualCostWorkPerformed | Double | ||
| ActualOvertimeCost | Double | ||
| BaselineCost | Double | ||
| BaselineCostPerUse | Double | ||
| BaselineFinish | Datetime | ||
| BaselineStart | Datetime | ||
| BaselineWork | String | ||
| BaselineWorkMilliseconds | Int | ||
| BaselineWorkTimeSpan | Time | ||
| BudgetedCostWorkPerformed | Double | ||
| BudgetedCostWorkScheduled | Double | ||
| CostVariance | Double | ||
| CostVarianceAtCompletion | Double | ||
| Created | Datetime | ||
| CurrentCostVariance | Double | ||
| Finish | Datetime | ||
| FinishVariance | String | ||
| FinishVarianceMilliseconds | Int | ||
| FinishVarianceTimeSpan | Time | ||
| IsConfirmed | Bool | ||
| IsOverAllocated | Bool | ||
| IsPublished | Bool | ||
| IsResponsePending | Bool | ||
| IsUpdateNeeded | Bool | ||
| LevelingDelay | String | ||
| LevelingDelayMilliseconds | Int | ||
| LevelingDelayTimeSpan | Time | ||
| Modified | Datetime | ||
| Notes | String | ||
| OvertimeCost | Double | ||
| RemainingCost | Double | ||
| RemainingOvertimeCost | Double | ||
| Resume | Datetime | ||
| ScheduleCostVariance | Double | ||
| Start | Datetime | ||
| StartVariance | String | ||
| StartVarianceMilliseconds | Int | ||
| StartVarianceTimeSpan | Time | ||
| Stop | Datetime | ||
| WorkContourType | Int | ||
| WorkVariance | String | ||
| WorkVarianceMilliseconds | Int | ||
| WorkVarianceTimeSpan | Time | ||
| LinkedCustomFields | String | ||
| ActualCost | Double | ||
| ActualFinish | Datetime | ||
| ActualOvertimeWork | String | ||
| ActualOvertimeWorkMilliseconds | Int | ||
| ActualOvertimeWorkTimeSpan | Time | ||
| ActualStart | Datetime | ||
| ActualWork | String | ||
| ActualWorkMilliseconds | Int | ||
| ActualWorkTimeSpan | Time | ||
| BudgetedCost | Double | ||
| BudgetedWork | String | ||
| BudgetedWorkMilliseconds | Int | ||
| BudgetedWorkTimeSpan | Time | ||
| Cost | Double | ||
| CostRateTable | Int | ||
| DefaultBookingType | Int | ||
| Delay | String | ||
| DelayMilliseconds | Int | ||
| DelayTimeSpan | Time | ||
| IsLockedByManager | Bool | ||
| IsWorkResource | Bool | ||
| OvertimeWork | String | ||
| OvertimeWorkMilliseconds | Int | ||
| OvertimeWorkTimeSpan | Time | ||
| PercentWorkComplete | Int | ||
| RegularWork | String | ||
| RegularWorkMilliseconds | Int | ||
| RegularWorkTimeSpan | Time | ||
| RemainingOvertimeWork | String | ||
| RemainingOvertimeWorkMilliseconds | Int | ||
| RemainingOvertimeWorkTimeSpan | Time | ||
| RemainingWork | String | ||
| RemainingWorkMilliseconds | Int | ||
| RemainingWorkTimeSpan | Time | ||
| ResourceCapacity | Double | ||
| Work | String | ||
| WorkMilliseconds | Int | ||
| WorkTimeSpan | Time | ||
| Owner_Id | Int | ||
| Parent_Id | String | ||
| Resource_Id | String | ||
| Task_Id | String | ||
| LinkedOwner | String | ||
| LinkedParent | String | ||
| LinkedResource | String | ||
| LinkedTask | String | ||
| ProjectId [KEY] | String | Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve published project resources.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| ActualCost | Double | ||
| ActualCostWorkPerformed | String | ||
| ActualCostWorkPerformedMilliseconds | Int | ||
| ActualCostWorkPerformedTimeSpan | Time | ||
| ActualOvertimeCost | Double | ||
| ActualOvertimeWork | String | ||
| ActualOvertimeWorkMilliseconds | Int | ||
| ActualOvertimeWorkTimeSpan | Time | ||
| ActualWork | String | ||
| ActualWorkMilliseconds | Int | ||
| ActualWorkTimeSpan | Time | ||
| AvailableFrom | Datetime | ||
| AvailableTo | Datetime | ||
| BaselineCost | Double | ||
| BaselineWork | String | ||
| BaselineWorkMilliseconds | Int | ||
| BaselineWorkTimeSpan | Time | ||
| BudetCostWorkPerformed | Double | ||
| BudgetedCost | Double | ||
| BudgetedCostWorkScheduled | Double | ||
| BudgetedWork | String | ||
| BudgetedWorkMilliseconds | Int | ||
| BudgetedWorkTimeSpan | Time | ||
| Cost | Double | ||
| CostVariance | Double | ||
| CostVarianceAtCompletion | Double | ||
| Created | Datetime | ||
| CurrentCostVariance | Double | ||
| Finish | Datetime | ||
| IsBudgeted | Bool | ||
| IsGenericResource | Bool | ||
| IsOverAllocated | Bool | ||
| Modified | Datetime | ||
| Notes | String | ||
| OvertimeCost | Double | ||
| OvertimeWork | String | ||
| OvertimeWorkMilliseconds | Int | ||
| OvertimeWorkTimeSpan | Time | ||
| PeakWork | String | ||
| PeakWorkMilliseconds | Int | ||
| PeakWorkTimeSpan | Time | ||
| PercentWorkComplete | Int | ||
| RegularWork | String | ||
| RegularWorkMilliseconds | Int | ||
| RegularWorkTimeSpan | Time | ||
| RemainingCost | Double | ||
| RemainingOvertimeCost | Double | ||
| RemainingOvertimeWork | String | ||
| RemainingOvertimeWorkMilliseconds | Int | ||
| RemainingOvertimeWorkTimeSpan | Time | ||
| RemainingWork | String | ||
| RemainingWorkMilliseconds | Int | ||
| RemainingWorkTimeSpan | Time | ||
| ScheduleCostVariance | Double | ||
| Start | Datetime | ||
| Work | String | ||
| WorkMilliseconds | Int | ||
| WorkTimeSpan | Time | ||
| WorkVariance | String | ||
| WorkVarianceMilliseconds | Int | ||
| WorkVarianceTimeSpan | Time | ||
| EnterpriseResource_Id | String | ||
| LinkedCustomFields | String | ||
| LinkedEnterpriseResource | String | ||
| CanLevel | Bool | ||
| Code | String | ||
| CostAccrual | Int | ||
| CostCenter | String | ||
| CostPerUse | Double | ||
| DefaultBookingType | Int | ||
| String | |||
| Group | String | ||
| Initials | String | ||
| MaterialLabel | String | ||
| MaximumCapacity | Double | ||
| Name | String | ||
| OvertimeRate | Double | ||
| OvertimeRateUnits | Int | ||
| Phonetics | String | ||
| StandardRate | Double | ||
| StandardRateUnits | Int | ||
| DefaultAssignmentOwner_Id | Int | ||
| LinkedAssignments | String | ||
| LinkedDefaultAssignmentOwner | String | ||
| ProjectId [KEY] | String | Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve published task links.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| DependencyType | Int | ||
| LinkLag | Int | ||
| LinkLagDuration | String | ||
| LinkLagFmt | Int | ||
| PredecessorTaskId | String | ||
| ProjUid | String | ||
| SuccessorTaskId | String | ||
| End_Id | String | ||
| Start_Id | String | ||
| LinkedEnd | String | ||
| LinkedStart | String | ||
| ProjectId [KEY] | String | Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve published tasks.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| ActualCostWorkPerformed | Double | ||
| ActualDuration | String | ||
| ActualDurationMilliseconds | Int | ||
| ActualDurationTimeSpan | Time | ||
| ActualOvertimeCost | Double | ||
| ActualOvertimeWork | String | ||
| ActualOvertimeWorkMilliseconds | Int | ||
| ActualOvertimeWorkTimeSpan | Time | ||
| BaselineCost | Double | ||
| BaselineDuration | String | ||
| BaselineDurationMilliseconds | Int | ||
| BaselineDurationTimeSpan | Time | ||
| BaselineFinish | Datetime | ||
| BaselineStart | Datetime | ||
| BaselineWork | String | ||
| BaselineWorkMilliseconds | Int | ||
| BaselineWorkTimeSpan | Time | ||
| BudgetCost | Double | ||
| BudgetedCostWorkPerformed | Double | ||
| BudgetedCostWorkScheduled | Double | ||
| Contact | String | ||
| CostPerformanceIndex | Double | ||
| CostVariance | Double | ||
| CostVarianceAtCompletion | Double | ||
| CostVariancePercentage | Int | ||
| Created | Datetime | ||
| CurrentCostVariance | Double | ||
| DurationVariance | String | ||
| DurationVarianceMilliseconds | Int | ||
| DurationVarianceTimeSpan | Time | ||
| EarliestFinish | Datetime | ||
| EarliestStart | Datetime | ||
| EstimateAtCompletion | Double | ||
| ExternalProjectUid | String | ||
| ExternalTaskUid | String | ||
| FinishSlack | String | ||
| FinishSlackMilliseconds | Int | ||
| FinishSlackTimeSpan | Time | ||
| FinishVariance | String | ||
| FinishVarianceMilliseconds | Int | ||
| FinishVarianceTimeSpan | Time | ||
| FreeSlack | String | ||
| FreeSlackMilliseconds | Int | ||
| FreeSlackTimeSpan | Time | ||
| IgnoreResourceCalendar | Bool | ||
| IsCritical | Bool | ||
| IsDurationEstimate | Bool | ||
| IsExternalTask | Bool | ||
| IsOverAllocated | Bool | ||
| IsRecurring | Bool | ||
| IsRecurringSummary | Bool | ||
| IsRolledUp | Bool | ||
| IsSubProject | Bool | ||
| IsSubProjectReadOnly | Bool | ||
| IsSubProjectScheduledFromFinish | Bool | ||
| IsSummary | Bool | ||
| LatestFinish | Datetime | ||
| LatestStart | Datetime | ||
| LevelingDelay | String | ||
| LevelingDelayMilliseconds | Int | ||
| LevelingDelayTimeSpan | Time | ||
| Modified | Datetime | ||
| Notes | String | ||
| OutlinePosition | String | ||
| OvertimeCost | Double | ||
| OvertimeWork | String | ||
| OvertimeWorkMilliseconds | Int | ||
| OvertimeWorkTimeSpan | Time | ||
| PercentWorkComplete | Int | ||
| PreLevelingFinish | Datetime | ||
| PreLevelingStart | Datetime | ||
| RegularWork | String | ||
| RegularWorkMilliseconds | Int | ||
| RegularWorkTimeSpan | Time | ||
| RemainingCost | Double | ||
| RemainingOvertimeCost | Double | ||
| RemainingOvertimeWork | String | ||
| RemainingOvertimeWorkMilliseconds | Int | ||
| RemainingOvertimeWorkTimeSpan | Time | ||
| RemainingWork | String | ||
| RemainingWorkMilliseconds | Int | ||
| RemainingWorkTimeSpan | Time | ||
| Resume | Datetime | ||
| ScheduleCostVariance | Double | ||
| ScheduledDuration | String | ||
| ScheduledDurationMilliseconds | Int | ||
| ScheduledDurationTimeSpan | Time | ||
| ScheduledFinish | Datetime | ||
| ScheduledStart | Datetime | ||
| SchedulePerformanceIndex | Double | ||
| ScheduleVariancePercentage | Int | ||
| StartSlack | String | ||
| StartSlackMilliseconds | Int | ||
| StartSlackTimeSpan | Time | ||
| StartVariance | String | ||
| StartVarianceMilliseconds | Int | ||
| StartVarianceTimeSpan | Time | ||
| Stop | Datetime | ||
| ToCompletePerformanceIndex | Double | ||
| TotalSlack | String | ||
| TotalSlackMilliseconds | Int | ||
| TotalSlackTimeSpan | Time | ||
| WorkBreakdownStructure | String | ||
| WorkVariance | String | ||
| WorkVarianceMilliseconds | Int | ||
| WorkVarianceTimeSpan | Time | ||
| SubProject_Id | String | ||
| LinkedCustomFields | String | ||
| LinkedSubProject | String | ||
| ActualCost | Double | ||
| ActualFinish | Datetime | ||
| ActualStart | Datetime | ||
| ActualWork | String | ||
| ActualWorkMilliseconds | Int | ||
| ActualWorkTimeSpan | Time | ||
| BudgetWork | String | ||
| BudgetWorkMilliseconds | Int | ||
| BudgetWorkTimeSpan | Time | ||
| Completion | Datetime | ||
| ConstraintStartEnd | Datetime | ||
| ConstraintType | Int | ||
| Cost | Double | ||
| Deadline | Datetime | ||
| Duration | String | ||
| DurationMilliseconds | Int | ||
| DurationTimeSpan | Time | ||
| Finish | Datetime | ||
| FinishText | String | ||
| FixedCost | Double | ||
| FixedCostAccrual | Int | ||
| IsActive | Bool | ||
| IsEffortDriven | Bool | ||
| IsLockedByManager | Bool | ||
| IsManual | Bool | ||
| IsMarked | Bool | ||
| IsMilestone | Bool | ||
| LevelingAdjustsAssignments | Bool | ||
| LevelingCanSplit | Bool | ||
| Name | String | ||
| OutlineLevel | Int | ||
| PercentComplete | Int | ||
| PercentPhysicalWorkComplete | Int | ||
| Priority | Int | ||
| RemainingDuration | String | ||
| RemainingDurationMilliseconds | Int | ||
| RemainingDurationTimeSpan | Time | ||
| Start | Datetime | ||
| StartText | String | ||
| TaskType | Int | ||
| UsePercentPhysicalWorkComplete | Bool | ||
| Work | String | ||
| WorkMilliseconds | Int | ||
| WorkTimeSpan | Time | ||
| Calendar_Id | String | ||
| Parent_Id | String | ||
| StatusManager_Id | Int | ||
| TaskPlanLink_Id | String | ||
| LinkedAssignments | String | ||
| LinkedCalendar | String | ||
| LinkedEntityLinks | String | ||
| LinkedParent | String | ||
| LinkedPredecessors | String | ||
| LinkedStatusManager | String | ||
| LinkedSuccessors | String | ||
| LinkedTaskPlanLink | String | ||
| ProjectId [KEY] | String | Id of the parent. This column only supports equality (=) and IN filters. |
Retrieve and modify assignments.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the table. | |
| ProjectId | String | The project Id. | |
| TaskId | String | The task Id. |
Retrieve and modify assignments.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the table. | |
| Name | String | The name of the association. | |
| ProjectId | String | The project Id. | |
| TaskId | String | The task Id. |
Retrieve timesheets.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| End | Datetime | ||
| Name | String | ||
| Start | Datetime | ||
| TimeSheet_Id | String | ||
| LinkedTimeSheet | String |
Retrieve workflow designers.
| Name | Type | References | Description |
| Id [KEY] | String | ||
| LinkedFields | String |
The ODataV1 schema implement the ProjectData service endpoints, which is read-only and can only be used for reporting.
Read-only Views are retrieved dynamically from the authenticated Microsoft Project account.
Stored Procedures are function-like interfaces to Microsoft Project. Stored procedures allow you to execute operations to Microsoft Project.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AssignmentBaselines | Retrieve assignment baselines. |
| AssignmentBaselineTimephasedDataSet | Retrieve assignment baseline timephased dataset. |
| Assignments | Retrieve assignments. |
| AssignmentTimephasedDataSet | Retrieve assignment timephased dataset. |
| BusinessDriverDepartments | Retrieve business driver departments. |
| BusinessDrivers | Retrieve business drivers. |
| CostConstraintScenarios | Retrieve cost constraint scenarios. |
| CostScenarioProjects | Retrieve cost scenario projects. |
| Deliverables | Retrieve deliverables. |
| Engagements | Retrieve engagements. |
| EngagementsComments | Retrieve engagements comments. |
| EngagementsTimephasedDataSet | Retrieve engagements timephased dataset. |
| FiscalPeriods | Retrieve fiscal periods. |
| Issues | Retrieve issues. |
| IssueTaskAssociations | Retrieve issue-task associations. |
| PortfolioAnalyses | Retrieve portfolio analyses. |
| PortfolioAnalysisProjects | Retrieve portfolio analysis projects. |
| PrioritizationDriverRelations | Retrieve prioritization driver relations. |
| PrioritizationDrivers | Retrieve prioritization drivers. |
| Prioritizations | Retrieve prioritizations. |
| ProjectBaselines | Retrieve project baselines. |
| Projects | Retrieve projects. |
| ProjectWorkflowStageDataSet | Retrieve project workflow stage dataset. |
| ResourceConstraintScenarios | Retrieve resource constraint scenarios. |
| ResourceDemandTimephasedDataSet | Retrieve resource demand timephased dataset. |
| Resources | Retrieve resources. |
| ResourceScenarioProjects | Retrieve resource scenario projects. |
| ResourceTimephasedDataSet | Retrieve resource timephased dataset. |
| Risks | Retrieve risks. |
| RiskTaskAssociations | Retrieve risk task associations. |
| TaskBaselines | Retrieve task baselines. |
| TaskBaselineTimephasedDataSet | Retrieve task baseline timephased dataset. |
| Tasks | Retrieve tasks. |
| TaskTimephasedDataSet | Retrieve task timephased dataset. |
| TimeSet | Retrieve timeset. |
| TimesheetClasses | Retrieve timesheet classes. |
| TimesheetLineActualDataSet | Retrieve timesheet line actual dataset. |
| TimesheetLines | Retrieve timesheet lines. |
| TimesheetPeriods | Retrieve timesheet periods. |
| Timesheets | Retrieve timesheets. |
Retrieve assignment baselines.
| Name | Type | References | Description |
| AssignmentId [KEY] | String | ||
| BaselineNumber [KEY] | Int | ||
| ProjectId [KEY] | String | ||
| AssignmentBaselineBudgetCost | Decimal | ||
| AssignmentBaselineBudgetMaterialWork | Decimal | ||
| AssignmentBaselineBudgetWork | Decimal | ||
| AssignmentBaselineCost | Decimal | ||
| AssignmentBaselineFinishDate | Datetime | ||
| AssignmentBaselineMaterialWork | Decimal | ||
| AssignmentBaselineModifiedDate | Datetime | ||
| AssignmentBaselineStartDate | Datetime | ||
| AssignmentBaselineWork | Decimal | ||
| AssignmentType | Int | ||
| ProjectName | String | ||
| TaskId | String | ||
| TaskName | String | ||
| LinkedAssignment | String | ||
| LinkedAssignmentBaselineTimephasedDataSet | String | ||
| LinkedProject | String | ||
| LinkedTask | String |
Retrieve assignment baseline timephased dataset.
| Name | Type | References | Description |
| AssignmentId [KEY] | String | ||
| BaselineNumber [KEY] | Int | ||
| ProjectId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| AssignmentBaselineBudgetCost | Decimal | ||
| AssignmentBaselineBudgetMaterialWork | Decimal | ||
| AssignmentBaselineBudgetWork | Decimal | ||
| AssignmentBaselineCost | Decimal | ||
| AssignmentBaselineMaterialWork | Decimal | ||
| AssignmentBaselineModifiedDate | Datetime | ||
| AssignmentBaselineWork | Decimal | ||
| FiscalPeriodId | String | ||
| ProjectName | String | ||
| ResourceId | String | ||
| TaskId | String | ||
| TaskName | String | ||
| LinkedAssignment | String | ||
| LinkedBaseline | String | ||
| LinkedProject | String | ||
| LinkedTasks | String | ||
| LinkedTime | String |
Retrieve assignments.
| Name | Type | References | Description |
| AssignmentId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| AssignmentActualCost | Decimal | ||
| AssignmentActualFinishDate | Datetime | ||
| AssignmentActualOvertimeCost | Decimal | ||
| AssignmentActualOvertimeWork | Decimal | ||
| AssignmentActualRegularCost | Decimal | ||
| AssignmentActualRegularWork | Decimal | ||
| AssignmentActualStartDate | Datetime | ||
| AssignmentActualWork | Decimal | ||
| AssignmentACWP | Decimal | ||
| AssignmentAllUpdatesApplied | Bool | ||
| AssignmentBCWP | Decimal | ||
| AssignmentBCWS | Decimal | ||
| AssignmentBookingDescription | String | ||
| AssignmentBookingId | Int | ||
| AssignmentBookingName | String | ||
| AssignmentBudgetCost | Decimal | ||
| AssignmentBudgetMaterialWork | Decimal | ||
| AssignmentBudgetWork | Decimal | ||
| AssignmentCost | Decimal | ||
| AssignmentCostVariance | Decimal | ||
| AssignmentCreatedDate | Datetime | ||
| AssignmentCreatedRevisionCounter | Int | ||
| AssignmentCV | Decimal | ||
| AssignmentDelay | Decimal | ||
| AssignmentFinishDate | Datetime | ||
| AssignmentFinishVariance | Decimal | ||
| AssignmentIsOverallocated | Bool | ||
| AssignmentIsPublished | Bool | ||
| AssignmentMaterialActualWork | Decimal | ||
| AssignmentMaterialWork | Decimal | ||
| AssignmentModifiedDate | Datetime | ||
| AssignmentModifiedRevisionCounter | Int | ||
| AssignmentOvertimeCost | Decimal | ||
| AssignmentOvertimeWork | Decimal | ||
| AssignmentPeakUnits | Decimal | ||
| AssignmentPercentWorkCompleted | Int | ||
| AssignmentRegularCost | Decimal | ||
| AssignmentRegularWork | Decimal | ||
| AssignmentRemainingCost | Decimal | ||
| AssignmentRemainingOvertimeCost | Decimal | ||
| AssignmentRemainingOvertimeWork | Decimal | ||
| AssignmentRemainingRegularCost | Decimal | ||
| AssignmentRemainingRegularWork | Decimal | ||
| AssignmentRemainingWork | Decimal | ||
| AssignmentResourcePlanWork | Decimal | ||
| AssignmentResourceType | Int | ||
| AssignmentStartDate | Datetime | ||
| AssignmentStartVariance | Decimal | ||
| AssignmentSV | Decimal | ||
| AssignmentType | Int | ||
| AssignmentUpdatesAppliedDate | Datetime | ||
| AssignmentVAC | Decimal | ||
| AssignmentWork | Decimal | ||
| AssignmentWorkVariance | Decimal | ||
| CostType_R | String | ||
| FlagStatus_T | Bool | ||
| Health_T | String | ||
| IsPublic | Bool | ||
| ProjectName | String | ||
| RBS_R | String | ||
| ResourceId | String | ||
| ResourceName | String | ||
| TaskId | String | ||
| TaskIsActive | Bool | ||
| TaskName | String | ||
| TimesheetClassId | String | ||
| TypeDescription | String | ||
| TypeName | String | ||
| LinkedBaseline | String | ||
| LinkedProject | String | ||
| LinkedResource | String | ||
| LinkedTask | String | ||
| LinkedTimephasedData | String |
Retrieve assignment timephased dataset.
| Name | Type | References | Description |
| AssignmentId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| AssignmentActualCost | Decimal | ||
| AssignmentActualOvertimeCost | Decimal | ||
| AssignmentActualOvertimeWork | Decimal | ||
| AssignmentActualRegularCost | Decimal | ||
| AssignmentActualRegularWork | Decimal | ||
| AssignmentActualWork | Decimal | ||
| AssignmentBudgetCost | Decimal | ||
| AssignmentBudgetMaterialWork | Decimal | ||
| AssignmentBudgetWork | Decimal | ||
| AssignmentCombinedWork | Decimal | ||
| AssignmentCost | Decimal | ||
| AssignmentMaterialActualWork | Decimal | ||
| AssignmentMaterialWork | Decimal | ||
| AssignmentModifiedDate | Datetime | ||
| AssignmentOvertimeCost | Decimal | ||
| AssignmentOvertimeWork | Decimal | ||
| AssignmentRegularCost | Decimal | ||
| AssignmentRegularWork | Decimal | ||
| AssignmentRemainingCost | Decimal | ||
| AssignmentRemainingOvertimeCost | Decimal | ||
| AssignmentRemainingOvertimeWork | Decimal | ||
| AssignmentRemainingRegularCost | Decimal | ||
| AssignmentRemainingRegularWork | Decimal | ||
| AssignmentRemainingWork | Decimal | ||
| AssignmentResourcePlanWork | Decimal | ||
| AssignmentWork | Decimal | ||
| FiscalPeriodId | String | ||
| ProjectName | String | ||
| ResourceId | String | ||
| TaskId | String | ||
| TaskIsActive | Bool | ||
| TaskName | String | ||
| LinkedAssignment | String | ||
| LinkedProject | String | ||
| LinkedTask | String | ||
| LinkedTime | String |
Retrieve business driver departments.
| Name | Type | References | Description |
| BusinessDriverId [KEY] | String | ||
| DepartmentId [KEY] | String | ||
| BusinessDriverName | String | ||
| DepartmentName | String | ||
| LinkedBusinessDriver | String |
Retrieve business drivers.
| Name | Type | References | Description |
| BusinessDriverId [KEY] | String | ||
| BusinessDriverCreatedDate | Datetime | ||
| BusinessDriverDescription | String | ||
| BusinessDriverIsActive | Bool | ||
| BusinessDriverModifiedDate | Datetime | ||
| BusinessDriverName | String | ||
| CreatedByResourceId | String | ||
| CreatedByResourceName | String | ||
| ImpactDescriptionExtreme | String | ||
| ImpactDescriptionLow | String | ||
| ImpactDescriptionModerate | String | ||
| ImpactDescriptionNone | String | ||
| ImpactDescriptionStrong | String | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| LinkedCreatedByResource | String | ||
| LinkedDepartments | String | ||
| LinkedModifiedByResource | String |
Retrieve cost constraint scenarios.
| Name | Type | References | Description |
| ScenarioId [KEY] | String | ||
| AnalysisId | String | ||
| AnalysisName | String | ||
| CreatedByResourceId | String | ||
| CreatedByResourceName | String | ||
| CreatedDate | Datetime | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| ModifiedDate | Datetime | ||
| ScenarioDescription | String | ||
| ScenarioName | String | ||
| SelectedProjectsCost | Decimal | ||
| SelectedProjectsPriority | Double | ||
| UnselectedProjectsCost | Decimal | ||
| UnselectedProjectsPriority | Double | ||
| UseDependencies | Bool | ||
| LinkedAnalysis | String | ||
| LinkedCostScenarioProjects | String | ||
| LinkedCreatedByResource | String | ||
| LinkedModifiedByResource | String | ||
| LinkedResourceConstraintScenarios | String |
Retrieve cost scenario projects.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| ScenarioId [KEY] | String | ||
| AbsolutePriority | Double | ||
| AnalysisId | String | ||
| AnalysisName | String | ||
| ForceAliasLookupTableId | String | ||
| ForceAliasLookupTableName | String | ||
| ForceStatus | Int | ||
| HardConstraintValue | Decimal | ||
| Priority | Double | ||
| ProjectName | String | ||
| ScenarioName | String | ||
| Status | Int | ||
| LinkedAnalysis | String | ||
| LinkedCostConstraintScenario | String | ||
| LinkedProject | String |
Retrieve deliverables.
| Name | Type | References | Description |
| DeliverableId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| CreateByResource | String | ||
| CreatedDate | Datetime | ||
| Description | String | ||
| FinishDate | Datetime | ||
| IsFolder | Bool | ||
| ItemRelativeUrlPath | String | ||
| ModifiedByResource | String | ||
| ModifiedDate | Datetime | ||
| ProjectName | String | ||
| StartDate | Datetime | ||
| Title | String | ||
| LinkedDependentProjects | String | ||
| LinkedDependentTasks | String | ||
| LinkedParentProjects | String | ||
| LinkedParentTasks | String | ||
| LinkedProject | String |
Retrieve engagements.
| Name | Type | References | Description |
| EngagementId [KEY] | String | ||
| CommittedFinishDate | Datetime | ||
| CommittedMaxUnits | Decimal | ||
| CommittedStartDate | Datetime | ||
| CommittedWork | Decimal | ||
| EngagementCreatedDate | Datetime | ||
| EngagementModifiedDate | Datetime | ||
| EngagementName | String | ||
| EngagementReviewedDate | Datetime | ||
| EngagementStatus | Int | ||
| EngagementSubmittedDate | Datetime | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| ProjectId | String | ||
| ProjectName | String | ||
| ProposedFinishDate | Datetime | ||
| ProposedMaxUnits | Decimal | ||
| ProposedStartDate | Datetime | ||
| ProposedWork | Decimal | ||
| ResourceId | String | ||
| ResourceName | String | ||
| ReviewedByResourceId | String | ||
| ReviewedByResourceName | String | ||
| SubmittedByResourceId | String | ||
| SubmittedByResourceName | String | ||
| LinkedComment | String | ||
| LinkedTimephasedInfo | String |
Retrieve engagements comments.
| Name | Type | References | Description |
| CommentId [KEY] | String | ||
| AuthorId | String | ||
| AuthorName | String | ||
| CommentCreatedDate | Datetime | ||
| CommentMessage | String | ||
| EngagementId | String | ||
| EngagementName | String | ||
| LinkedEngagement | String |
Retrieve engagements timephased dataset.
| Name | Type | References | Description |
| EngagementId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| CommittedMaxUnits | Decimal | ||
| CommittedWork | Decimal | ||
| EngagementModifiedDate | Datetime | ||
| EngagementName | String | ||
| ProjectId | String | ||
| ProjectName | String | ||
| ProposedMaxUnits | Decimal | ||
| ProposedWork | Decimal | ||
| ResourceId | String | ||
| ResourceName | String | ||
| LinkedEngagement | String |
Retrieve fiscal periods.
| Name | Type | References | Description |
| FiscalPeriodId [KEY] | String | ||
| CreatedDate | Datetime | ||
| FiscalPeriodFinish | Datetime | ||
| FiscalPeriodModifiedDate | Datetime | ||
| FiscalPeriodName | String | ||
| FiscalPeriodQuarter | Int | ||
| FiscalPeriodStart | Datetime | ||
| FiscalPeriodYear | Int |
Retrieve issues.
| Name | Type | References | Description |
| IssueId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| AssignedToResource | String | ||
| Category | String | ||
| CreateByResource | String | ||
| CreatedDate | Datetime | ||
| Discussion | String | ||
| DueDate | Datetime | ||
| IsFolder | Bool | ||
| ItemRelativeUrlPath | String | ||
| ModifiedByResource | String | ||
| ModifiedDate | Datetime | ||
| NumberOfAttachments | Int | ||
| Owner | String | ||
| Priority | String | ||
| ProjectName | String | ||
| Resolution | String | ||
| Status | String | ||
| Title | String | ||
| LinkedProject | String | ||
| LinkedRelatedRisks | String | ||
| LinkedSubIssues | String | ||
| LinkedTasks | String |
Retrieve issue-task associations.
| Name | Type | References | Description |
| IssueId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| RelationshipType [KEY] | Int | ||
| TaskId [KEY] | String | ||
| ProjectName | String | ||
| RelatedProjectId | String | ||
| RelatedProjectName | String | ||
| TaskName | String | ||
| Title | String | ||
| LinkedIssue | String | ||
| LinkedProject | String | ||
| LinkedRelatedProject | String | ||
| LinkedTask | String |
Retrieve portfolio analyses.
| Name | Type | References | Description |
| AnalysisId [KEY] | String | ||
| AnalysisDescription | String | ||
| AnalysisName | String | ||
| AnalysisType | Int | ||
| BookingType | Int | ||
| CreatedByResourceId | String | ||
| CreatedByResourceName | String | ||
| CreatedDate | Datetime | ||
| DepartmentId | String | ||
| DepartmentName | String | ||
| FilterResourcesByDepartment | Bool | ||
| FilterResourcesByRBS | Bool | ||
| FilterResourcesByRBSValueId | String | ||
| FilterResourcesByRBSValueText | String | ||
| ForcedInAliasLookupTableId | String | ||
| ForcedInAliasLookupTableName | String | ||
| ForcedOutAliasLookupTableId | String | ||
| ForcedOutAliasLookupTableName | String | ||
| HardConstraintCustomFieldId | String | ||
| HardConstraintCustomFieldName | String | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| ModifiedDate | Datetime | ||
| PlanningHorizonEndDate | Datetime | ||
| PlanningHorizonStartDate | Datetime | ||
| PrioritizationId | String | ||
| PrioritizationName | String | ||
| PrioritizationType | Int | ||
| RoleCustomFieldId | String | ||
| RoleCustomFieldName | String | ||
| TimeScale | Int | ||
| UseAlternateProjectDatesForResourcePlans | Bool | ||
| LinkedAnalysisProjects | String | ||
| LinkedCostConstraintScenarios | String | ||
| LinkedCreatedByResource | String | ||
| LinkedModifiedByResource | String | ||
| LinkedPrioritization | String | ||
| LinkedResourceConstraintScenarios | String |
Retrieve portfolio analysis projects.
| Name | Type | References | Description |
| AnalysisId [KEY] | String | ||
| ProjectId [KEY] | String | ||
| AbsolutePriority | Double | ||
| AnalysisName | String | ||
| Duration | Decimal | ||
| FinishNoLaterThan | Datetime | ||
| Locked | Int | ||
| OriginalEndDate | Datetime | ||
| OriginalStartDate | Datetime | ||
| Priority | Double | ||
| ProjectName | String | ||
| StartDate | Datetime | ||
| StartNoEarlierThan | Datetime | ||
| LinkedAnalysis | String | ||
| LinkedProject | String |
Retrieve prioritization driver relations.
| Name | Type | References | Description |
| BusinessDriver1Id [KEY] | String | ||
| BusinessDriver2Id [KEY] | String | ||
| PrioritizationId [KEY] | String | ||
| BusinessDriver1Name | String | ||
| BusinessDriver2Name | String | ||
| PrioritizationName | String | ||
| RelationValue | String | ||
| LinkedBusinessDriver1 | String | ||
| LinkedBusinessDriver2 | String | ||
| LinkedPrioritization | String |
Retrieve prioritization drivers.
| Name | Type | References | Description |
| BusinessDriverId [KEY] | String | ||
| PrioritizationId [KEY] | String | ||
| BusinessDriverName | String | ||
| BusinessDriverPriority | Double | ||
| PrioritizationName | String | ||
| LinkedBusinessDriver | String | ||
| LinkedPrioritization | String |
Retrieve prioritizations.
| Name | Type | References | Description |
| PrioritizationId [KEY] | String | ||
| ConsistencyRatio | Double | ||
| CreatedByResourceId | String | ||
| CreatedByResourceName | String | ||
| DepartmentId | String | ||
| DepartmentName | String | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| PrioritizationCreatedDate | Datetime | ||
| PrioritizationDescription | String | ||
| PrioritizationIsManual | Bool | ||
| PrioritizationModifiedDate | Datetime | ||
| PrioritizationName | String | ||
| LinkedCreatedByResource | String | ||
| LinkedModifiedByResource | String | ||
| LinkedPrioritizationDriverRelations | String | ||
| LinkedPrioritizationDrivers | String |
Retrieve project baselines.
| Name | Type | References | Description |
| BaselineNumber [KEY] | Int | ||
| ProjectId [KEY] | String | ||
| ProjectBaselineBudgetCost | Decimal | ||
| ProjectBaselineBudgetWork | Decimal | ||
| ProjectBaselineCost | Decimal | ||
| ProjectBaselineDeliverableFinishDate | Datetime | ||
| ProjectBaselineDeliverableStartDate | Datetime | ||
| ProjectBaselineDuration | Decimal | ||
| ProjectBaselineDurationString | String | ||
| ProjectBaselineFinishDate | Datetime | ||
| ProjectBaselineFinishDateString | String | ||
| ProjectBaselineFixedCost | Decimal | ||
| ProjectBaselineModifiedDate | Datetime | ||
| ProjectBaselineStartDate | Datetime | ||
| ProjectBaselineStartDateString | String | ||
| ProjectBaselineWork | Decimal | ||
| ProjectName | String | ||
| TaskId | String | ||
| LinkedProject | String |
Retrieve projects.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| EnterpriseProjectTypeDescription | String | ||
| EnterpriseProjectTypeId | String | ||
| EnterpriseProjectTypeIsDefault | Bool | ||
| EnterpriseProjectTypeName | String | ||
| OptimizerCommitDate | Datetime | ||
| OptimizerDecisionAliasLookupTableId | String | ||
| OptimizerDecisionAliasLookupTableValueId | String | ||
| OptimizerDecisionID | Int | ||
| OptimizerDecisionName | String | ||
| OptimizerSolutionName | String | ||
| ParentProjectId | String | ||
| PlannerCommitDate | Datetime | ||
| PlannerDecisionAliasLookupTableId | String | ||
| PlannerDecisionAliasLookupTableValueId | String | ||
| PlannerDecisionID | Int | ||
| PlannerDecisionName | String | ||
| PlannerEndDate | Datetime | ||
| PlannerSolutionName | String | ||
| PlannerStartDate | Datetime | ||
| ProjectActualCost | Decimal | ||
| ProjectActualDuration | Decimal | ||
| ProjectActualFinishDate | Datetime | ||
| ProjectActualOvertimeCost | Decimal | ||
| ProjectActualOvertimeWork | Decimal | ||
| ProjectActualRegularCost | Decimal | ||
| ProjectActualRegularWork | Decimal | ||
| ProjectActualStartDate | Datetime | ||
| ProjectActualWork | Decimal | ||
| ProjectACWP | Decimal | ||
| ProjectAuthorName | String | ||
| ProjectBCWP | Decimal | ||
| ProjectBCWS | Decimal | ||
| ProjectBudgetCost | Decimal | ||
| ProjectBudgetWork | Decimal | ||
| ProjectCalculationsAreStale | Bool | ||
| ProjectCalendarDuration | Int | ||
| ProjectCategoryName | String | ||
| ProjectCompanyName | String | ||
| ProjectCost | Decimal | ||
| ProjectCostVariance | Decimal | ||
| ProjectCPI | Decimal | ||
| ProjectCreatedDate | Datetime | ||
| ProjectCurrency | String | ||
| ProjectCV | Decimal | ||
| ProjectCVP | Decimal | ||
| ProjectDepartments | String | ||
| ProjectDescription | String | ||
| ProjectDuration | Decimal | ||
| ProjectDurationVariance | Decimal | ||
| ProjectEAC | Decimal | ||
| ProjectEarlyFinish | Datetime | ||
| ProjectEarlyStart | Datetime | ||
| ProjectEarnedValueIsStale | Bool | ||
| ProjectEnterpriseFeatures | Bool | ||
| ProjectFinishDate | Datetime | ||
| ProjectFinishVariance | Decimal | ||
| ProjectFixedCost | Decimal | ||
| ProjectIdentifier | String | ||
| ProjectKeywords | String | ||
| ProjectLastPublishedDate | Datetime | ||
| ProjectLateFinish | Datetime | ||
| ProjectLateStart | Datetime | ||
| ProjectManagerName | String | ||
| ProjectModifiedDate | Datetime | ||
| ProjectName | String | ||
| ProjectOvertimeCost | Decimal | ||
| ProjectOvertimeWork | Decimal | ||
| ProjectOwnerId | String | ||
| ProjectOwnerName | String | ||
| ProjectPercentCompleted | Int | ||
| ProjectPercentWorkCompleted | Int | ||
| ProjectRegularCost | Decimal | ||
| ProjectRegularWork | Decimal | ||
| ProjectRemainingCost | Decimal | ||
| ProjectRemainingDuration | Decimal | ||
| ProjectRemainingOvertimeCost | Decimal | ||
| ProjectRemainingOvertimeWork | Decimal | ||
| ProjectRemainingRegularCost | Decimal | ||
| ProjectRemainingRegularWork | Decimal | ||
| ProjectRemainingWork | Decimal | ||
| ProjectResourcePlanWork | Decimal | ||
| ProjectSPI | Decimal | ||
| ProjectStartDate | Datetime | ||
| ProjectStartVariance | Decimal | ||
| ProjectStatusDate | Datetime | ||
| ProjectSubject | String | ||
| ProjectSV | Decimal | ||
| ProjectSVP | Decimal | ||
| ProjectTCPI | Decimal | ||
| ProjectTimephased | String | ||
| ProjectTitle | String | ||
| ProjectType | Int | ||
| ProjectVAC | Decimal | ||
| ProjectWork | Decimal | ||
| ProjectWorkspaceInternalUrl | String | ||
| ProjectWorkVariance | Decimal | ||
| ResourcePlanUtilizationDate | Datetime | ||
| ResourcePlanUtilizationType | Int | ||
| WorkflowError | String | ||
| WorkflowErrorResponseCode | Int | ||
| WorkflowInstanceId | String | ||
| WorkflowOwnerId | String | ||
| WorkflowOwnerName | String | ||
| LinkedAssignmentBaselines | String | ||
| LinkedAssignments | String | ||
| LinkedDeliverables | String | ||
| LinkedDependencies | String | ||
| LinkedIssues | String | ||
| LinkedRisks | String | ||
| LinkedStagesInfo | String | ||
| LinkedTasks | String |
Retrieve project workflow stage dataset.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| StageId [KEY] | String | ||
| LastModifiedDate | Datetime | ||
| LCID | Int | ||
| PhaseDescription | String | ||
| PhaseName | String | ||
| ProjectName | String | ||
| StageCompletionDate | Datetime | ||
| StageDescription | String | ||
| StageEntryDate | Datetime | ||
| StageInformation | String | ||
| StageLastSubmittedDate | Datetime | ||
| StageName | String | ||
| StageOrder | Int | ||
| StageStateDescription | String | ||
| StageStatus | Int | ||
| LinkedProject | String |
Retrieve resource constraint scenarios.
| Name | Type | References | Description |
| ScenarioId [KEY] | String | ||
| AllocationThreshold | Decimal | ||
| AnalysisId | String | ||
| AnalysisName | String | ||
| ConstraintType | Int | ||
| ConstraintValue | Decimal | ||
| CostConstraintScenarioId | String | ||
| CostConstraintScenarioName | String | ||
| CreatedByResourceId | String | ||
| CreatedByResourceName | String | ||
| CreatedDate | Datetime | ||
| EnforceProjectDependencies | Bool | ||
| EnforceSchedulingConstraints | Bool | ||
| HiringType | Int | ||
| ModifiedByResourceId | String | ||
| ModifiedByResourceName | String | ||
| ModifiedDate | Datetime | ||
| RateTable | Int | ||
| ScenarioDescription | String | ||
| ScenarioName | String | ||
| LinkedAnalysis | String | ||
| LinkedCostConstraintScenario | String | ||
| LinkedCreatedByResource | String | ||
| LinkedModifiedByResource | String | ||
| LinkedResourceScenarioProjects | String |
Retrieve resource demand timephased dataset.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| ResourceId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| FiscalPeriodId | String | ||
| ProjectName | String | ||
| ResourceDemand | Decimal | ||
| ResourceDemandModifiedDate | Datetime | ||
| ResourceName | String | ||
| ResourcePlanUtilizationDate | Datetime | ||
| ResourcePlanUtilizationType | Int | ||
| LinkedProject | String | ||
| LinkedResource | String | ||
| LinkedTime | String |
Retrieve resources.
| Name | Type | References | Description |
| ResourceId [KEY] | String | ||
| CostType | String | ||
| RBS | String | ||
| ResourceBaseCalendar | String | ||
| ResourceBookingType | Int | ||
| ResourceCanLevel | Bool | ||
| ResourceCode | String | ||
| ResourceCostCenter | String | ||
| ResourceCostPerUse | Decimal | ||
| ResourceCreatedDate | Datetime | ||
| ResourceDepartments | String | ||
| ResourceEarliestAvailableFrom | Datetime | ||
| ResourceEmailAddress | String | ||
| ResourceGroup | String | ||
| ResourceHyperlink | String | ||
| ResourceHyperlinkHref | String | ||
| ResourceInitials | String | ||
| ResourceIsActive | Bool | ||
| ResourceIsGeneric | Bool | ||
| ResourceIsTeam | Bool | ||
| ResourceLatestAvailableTo | Datetime | ||
| ResourceMaterialLabel | String | ||
| ResourceMaxUnits | Decimal | ||
| ResourceModifiedDate | Datetime | ||
| ResourceName | String | ||
| ResourceNTAccount | String | ||
| ResourceOvertimeRate | Decimal | ||
| ResourceStandardRate | Decimal | ||
| ResourceStatusId | String | ||
| ResourceStatusName | String | ||
| ResourceTimesheetManageId | String | ||
| ResourceType | Int | ||
| ResourceWorkgroup | Int | ||
| TypeDescription | String | ||
| TypeName | String | ||
| LinkedAssignments | String | ||
| LinkedResourceDemandTimephasedInfo | String | ||
| LinkedTimephasedInfoDataSet | String |
Retrieve resource scenario projects.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| ScenarioId [KEY] | String | ||
| AbsolutePriority | Double | ||
| AnalysisId | String | ||
| AnalysisName | String | ||
| CostConstraintScenarioId | String | ||
| CostConstraintScenarioName | String | ||
| ForceAliasLookupTableId | String | ||
| ForceAliasLookupTableName | String | ||
| ForceStatus | Int | ||
| HardConstraintValue | Decimal | ||
| NewStartDate | Datetime | ||
| Priority | Double | ||
| ProjectName | String | ||
| ResourceCost | Decimal | ||
| ResourceWork | Decimal | ||
| ScenarioName | String | ||
| Status | Int | ||
| LinkedAnalysis | String | ||
| LinkedCostConstraintScenario | String | ||
| LinkedProject | String | ||
| LinkedResourceConstraintScenario | String |
Retrieve resource timephased dataset.
| Name | Type | References | Description |
| ResourceId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| BaseCapacity | Decimal | ||
| Capacity | Decimal | ||
| FiscalPeriodId | String | ||
| ResourceModifiedDate | Datetime | ||
| ResourceName | String | ||
| LinkedResource | String | ||
| LinkedTime | String |
Retrieve risks.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| RiskId [KEY] | String | ||
| AssignedToResource | String | ||
| Category | String | ||
| ContingencyPlan | String | ||
| Cost | Double | ||
| CostExposure | Double | ||
| CreateByResource | String | ||
| CreatedDate | Datetime | ||
| Description | String | ||
| DueDate | Datetime | ||
| Exposure | Double | ||
| Impact | Double | ||
| IsFolder | Bool | ||
| ItemRelativeUrlPath | String | ||
| MitigationPlan | String | ||
| ModifiedByResource | String | ||
| ModifiedDate | Datetime | ||
| NumberOfAttachments | Int | ||
| Owner | String | ||
| Probability | Double | ||
| ProjectName | String | ||
| Status | String | ||
| Title | String | ||
| TriggerDescription | String | ||
| TriggerTask | String | ||
| LinkedProject | String | ||
| LinkedRelatedIssues | String | ||
| LinkedSubRisks | String | ||
| LinkedTasks | String |
Retrieve risk task associations.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| RelationshipType [KEY] | Int | ||
| RiskId [KEY] | String | ||
| TaskId [KEY] | String | ||
| ProjectName | String | ||
| RelatedProjectId | String | ||
| RelatedProjectName | String | ||
| TaskName | String | ||
| Title | String | ||
| LinkedProject | String | ||
| LinkedRelatedProject | String | ||
| LinkedRisk | String | ||
| LinkedTask | String |
Retrieve task baselines.
| Name | Type | References | Description |
| BaselineNumber [KEY] | Int | ||
| ProjectId [KEY] | String | ||
| TaskId [KEY] | String | ||
| ProjectName | String | ||
| TaskBaselineBudgetCost | Decimal | ||
| TaskBaselineBudgetWork | Decimal | ||
| TaskBaselineCost | Decimal | ||
| TaskBaselineDeliverableFinishDate | Datetime | ||
| TaskBaselineDeliverableStartDate | Datetime | ||
| TaskBaselineDuration | Decimal | ||
| TaskBaselineDurationString | String | ||
| TaskBaselineFinishDate | Datetime | ||
| TaskBaselineFinishDateString | String | ||
| TaskBaselineFixedCost | Decimal | ||
| TaskBaselineModifiedDate | Datetime | ||
| TaskBaselineStartDate | Datetime | ||
| TaskBaselineStartDateString | String | ||
| TaskBaselineWork | Decimal | ||
| TaskName | String | ||
| LinkedProject | String | ||
| LinkedTask | String | ||
| LinkedTaskBaselineTimephasedDataSet | String |
Retrieve task baseline timephased dataset.
| Name | Type | References | Description |
| BaselineNumber [KEY] | Int | ||
| ProjectId [KEY] | String | ||
| TaskId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| FiscalPeriodId | String | ||
| ProjectName | String | ||
| TaskBaselineBudgetCost | Decimal | ||
| TaskBaselineBudgetWork | Decimal | ||
| TaskBaselineCost | Decimal | ||
| TaskBaselineFixedCost | Decimal | ||
| TaskBaselineModifiedDate | Datetime | ||
| TaskBaselineWork | Decimal | ||
| TaskName | String | ||
| LinkedProject | String | ||
| LinkedTask | String | ||
| LinkedTaskBaselines | String | ||
| LinkedTime | String |
Retrieve tasks.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| TaskId [KEY] | String | ||
| FlagStatus | Bool | ||
| Health | String | ||
| ParentTaskId | String | ||
| ParentTaskName | String | ||
| ProjectName | String | ||
| TaskActualCost | Decimal | ||
| TaskActualDuration | Decimal | ||
| TaskActualFinishDate | Datetime | ||
| TaskActualFixedCost | Decimal | ||
| TaskActualOvertimeCost | Decimal | ||
| TaskActualOvertimeWork | Decimal | ||
| TaskActualRegularCost | Decimal | ||
| TaskActualRegularWork | Decimal | ||
| TaskActualStartDate | Datetime | ||
| TaskActualWork | Decimal | ||
| TaskACWP | Decimal | ||
| TaskBCWP | Decimal | ||
| TaskBCWS | Decimal | ||
| TaskBudgetCost | Decimal | ||
| TaskBudgetWork | Decimal | ||
| TaskClientUniqueId | Int | ||
| TaskCost | Decimal | ||
| TaskCostVariance | Decimal | ||
| TaskCPI | Decimal | ||
| TaskCreatedDate | Datetime | ||
| TaskCreatedRevisionCounter | Int | ||
| TaskCV | Decimal | ||
| TaskCVP | Decimal | ||
| TaskDeadline | Datetime | ||
| TaskDeliverableFinishDate | Datetime | ||
| TaskDeliverableStartDate | Datetime | ||
| TaskDuration | Decimal | ||
| TaskDurationIsEstimated | Bool | ||
| TaskDurationString | String | ||
| TaskDurationVariance | Decimal | ||
| TaskEAC | Decimal | ||
| TaskEarlyFinish | Datetime | ||
| TaskEarlyStart | Datetime | ||
| TaskFinishDate | Datetime | ||
| TaskFinishDateString | String | ||
| TaskFinishVariance | Decimal | ||
| TaskFixedCost | Decimal | ||
| TaskFixedCostAssignmentId | String | ||
| TaskFreeSlack | Decimal | ||
| TaskHyperLinkAddress | String | ||
| TaskHyperLinkFriendlyName | String | ||
| TaskHyperLinkSubAddress | String | ||
| TaskIgnoresResourceCalendar | Bool | ||
| TaskIndex | Int | ||
| TaskIsActive | Bool | ||
| TaskIsCritical | Bool | ||
| TaskIsEffortDriven | Bool | ||
| TaskIsExternal | Bool | ||
| TaskIsManuallyScheduled | Bool | ||
| TaskIsMarked | Bool | ||
| TaskIsMilestone | Bool | ||
| TaskIsOverallocated | Bool | ||
| TaskIsProjectSummary | Bool | ||
| TaskIsRecurring | Bool | ||
| TaskIsSummary | Bool | ||
| TaskLateFinish | Datetime | ||
| TaskLateStart | Datetime | ||
| TaskLevelingDelay | Decimal | ||
| TaskModifiedDate | Datetime | ||
| TaskModifiedRevisionCounter | Int | ||
| TaskName | String | ||
| TaskOutlineLevel | Int | ||
| TaskOutlineNumber | String | ||
| TaskOvertimeCost | Decimal | ||
| TaskOvertimeWork | Decimal | ||
| TaskPercentCompleted | Int | ||
| TaskPercentWorkCompleted | Int | ||
| TaskPhysicalPercentCompleted | Int | ||
| TaskPriority | Int | ||
| TaskRegularCost | Decimal | ||
| TaskRegularWork | Decimal | ||
| TaskRemainingCost | Decimal | ||
| TaskRemainingDuration | Decimal | ||
| TaskRemainingOvertimeCost | Decimal | ||
| TaskRemainingOvertimeWork | Decimal | ||
| TaskRemainingRegularCost | Decimal | ||
| TaskRemainingRegularWork | Decimal | ||
| TaskRemainingWork | Decimal | ||
| TaskResourcePlanWork | Decimal | ||
| TaskSPI | Decimal | ||
| TaskStartDate | Datetime | ||
| TaskStartDateString | String | ||
| TaskStartVariance | Decimal | ||
| TaskStatusManagerUID | String | ||
| TaskSV | Decimal | ||
| TaskSVP | Decimal | ||
| TaskTCPI | Decimal | ||
| TaskTotalSlack | Decimal | ||
| TaskVAC | Decimal | ||
| TaskWBS | String | ||
| TaskWork | Decimal | ||
| TaskWorkVariance | Decimal | ||
| LinkedAssignments | String | ||
| LinkedAssignmentsBaselines | String | ||
| LinkedAssignmentsBaselineTimephasedData | String | ||
| LinkedBaselines | String | ||
| LinkedBaselinesTimephasedDataSet | String | ||
| LinkedIssues | String | ||
| LinkedProject | String | ||
| LinkedRisks | String | ||
| LinkedTimephasedInfo | String |
Retrieve task timephased dataset.
| Name | Type | References | Description |
| ProjectId [KEY] | String | ||
| TaskId [KEY] | String | ||
| TimeByDay [KEY] | Datetime | ||
| FiscalPeriodId | String | ||
| ProjectName | String | ||
| TaskActualCost | Decimal | ||
| TaskActualWork | Decimal | ||
| TaskBudgetCost | Decimal | ||
| TaskBudgetWork | Decimal | ||
| TaskCost | Decimal | ||
| TaskIsActive | Bool | ||
| TaskIsProjectSummary | Bool | ||
| TaskModifiedDate | Datetime | ||
| TaskName | String | ||
| TaskOvertimeWork | Decimal | ||
| TaskResourcePlanWork | Decimal | ||
| TaskWork | Decimal | ||
| LinkedProject | String | ||
| LinkedTask | String | ||
| LinkedTime | String |
Retrieve timeset.
| Name | Type | References | Description |
| TimeByDay [KEY] | Datetime | ||
| FiscalPeriodId | String | ||
| FiscalPeriodModifiedDate | Datetime | ||
| FiscalPeriodName | String | ||
| FiscalPeriodStart | Datetime | ||
| FiscalPeriodYear | Int | ||
| FiscalQuarter | Int | ||
| TimeDayOfTheMonth | Int | ||
| TimeDayOfTheWeek | Int | ||
| TimeMonthOfTheYear | Int | ||
| TimeQuarter | Int | ||
| TimeWeekOfTheYear | Int |
Retrieve timesheet classes.
| Name | Type | References | Description |
| DepartmentId [KEY] | String | ||
| TimesheetClassId [KEY] | String | ||
| DepartmentName | String | ||
| Description | String | ||
| LCID | Int | ||
| TimesheetClassName | String | ||
| TimesheetClassType | Int |
Retrieve timesheet line actual dataset.
| Name | Type | References | Description |
| AdjustmentIndex [KEY] | Int | ||
| TimeByDay [KEY] | Datetime | ||
| TimesheetLineId [KEY] | String | ||
| ActualOvertimeWorkBillable | Decimal | ||
| ActualOvertimeWorkNonBillable | Decimal | ||
| ActualWorkBillable | Decimal | ||
| ActualWorkNonBillable | Decimal | ||
| Comment | String | ||
| CreatedDate | Datetime | ||
| LastChangedResourceName | String | ||
| PlannedWork | Decimal | ||
| ResourceName | String | ||
| TimeByDay_DayOfMonth | Int | ||
| TimeByDay_DayOfWeek | Int | ||
| TimesheetLineModifiedDate | Datetime | ||
| LinkedLastChangedByResource | String | ||
| LinkedTime | String | ||
| LinkedTimesheetLine | String |
Retrieve timesheet lines.
| Name | Type | References | Description |
| TimesheetLineId [KEY] | String | ||
| ActualOvertimeWorkBillable | Decimal | ||
| ActualOvertimeWorkNonBillable | Decimal | ||
| ActualWorkBillable | Decimal | ||
| ActualWorkNonBillable | Decimal | ||
| AssignmentId | String | ||
| CreatedDate | Datetime | ||
| LastSavedWork | Decimal | ||
| LCID | Int | ||
| ModifiedDate | Datetime | ||
| PeriodEndDate | Datetime | ||
| PeriodStartDate | Datetime | ||
| PlannedWork | Decimal | ||
| ProjectId | String | ||
| ProjectName | String | ||
| TaskHierarchy | String | ||
| TaskId | String | ||
| TaskName | String | ||
| TimesheetApproverResourceId | String | ||
| TimesheetApproverResourceName | String | ||
| TimesheetClassDescription | String | ||
| TimesheetClassId | String | ||
| TimesheetClassName | String | ||
| TimesheetClassType | Int | ||
| TimesheetId | String | ||
| TimesheetLineComment | String | ||
| TimesheetLineStatus | String | ||
| TimesheetLineStatusId | Int | ||
| TimesheetName | String | ||
| TimesheetOwner | String | ||
| TimesheetOwnerId | String | ||
| TimesheetPeriodId | String | ||
| TimesheetPeriodName | String | ||
| TimesheetPeriodStatus | String | ||
| TimesheetPeriodStatusId | Int | ||
| TimesheetStatus | String | ||
| TimesheetStatusId | Int | ||
| LinkedActuals | String | ||
| LinkedApproverResource | String | ||
| LinkedTimesheet | String | ||
| LinkedTimesheetClass | String |
Retrieve timesheet periods.
| Name | Type | References | Description |
| PeriodId [KEY] | String | ||
| Description | String | ||
| EndDate | Datetime | ||
| LCID | Int | ||
| PeriodName | String | ||
| PeriodStatusId | Int | ||
| StartDate | Datetime |
Retrieve timesheets.
| Name | Type | References | Description |
| TimesheetId [KEY] | String | ||
| Comment | String | ||
| Description | String | ||
| EndDate | Datetime | ||
| ModifiedDate | Datetime | ||
| PeriodId | String | ||
| PeriodName | String | ||
| PeriodStatusId | Int | ||
| StartDate | Datetime | ||
| StatusDescription | String | ||
| TimesheetName | String | ||
| TimesheetOwner | String | ||
| TimesheetOwnerId | String | ||
| TimesheetStatusId | Int | ||
| LinkedLines | String | ||
| LinkedPeriods | String |
The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft Project (OData V3) | CData Schema |
| Edm.Binary | binary |
| Edm.Boolean | bool |
| Edm.DateTime | datetime |
| Edm.Decimal | decimal |
| Edm.Double | double |
| Edm.Guid | guid |
| Edm.Int32 | int |
| Edm.String | string |
| Edm.TimeOfDay | time |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are SharePointOnlineCookies,OAuth,OKTA,ADFS,AzureAD and OneLogin. |
| URL | URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/. |
| User | Specifies the user ID of the authenticating Microsoft Project user account. |
| Password | Specifies the password of the authenticating user account. |
| Property | Description |
| ProjectId | The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter. |
| AuthCookie | The cookie to use for authenticating to the online SharePoint server. |
| Property | Description |
| AzureTenant | Identifies the Microsoft Project tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional). |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSODomain | The domain of the user when using single sign-on (SSO). |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Scope | The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it defaults to the following: offline_access https://MyOrganization.sharepoint.com/.default . A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page. |
| State | Optional value for representing extra OAuth state information. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | The type of schema to use: ODataV1 or ODataV2. |
| Property | Description |
| MaxProjectionLength | Set this to override the maximum length of characters supported in the $select system query option by the Microsoft Project API service. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Microsoft Project, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are SharePointOnlineCookies,OAuth,OKTA,ADFS,AzureAD and OneLogin. |
| URL | URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/. |
| User | Specifies the user ID of the authenticating Microsoft Project user account. |
| Password | Specifies the password of the authenticating user account. |
The scheme used for authentication. Accepted entries are SharePointOnlineCookies,OAuth,OKTA,ADFS,AzureAD and OneLogin.
This field is used to authenticate to Microsoft Project. SharePointOnlineCookies is the default option.
URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
Specifies the user ID of the authenticating Microsoft Project user account.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the password of the authenticating user account.
The authenticating server requires both User and Password to validate the user's identity.
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| ProjectId | The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter. |
| AuthCookie | The cookie to use for authenticating to the online SharePoint server. |
The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.
The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.
Note: This property is applicable only for the "ODataV2" schema. For the "ODataV1" schema, no table requires the ProjectId to be specified, as the ProjectData endpoints return data for all the available projects.
The cookie to use for authenticating to the online SharePoint server.
After logging in to http://yourdomain.sharepoint.com/TeamSite, the "keep me signed in" setting must be checked in order for the connection to be established.
This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AzureTenant | Identifies the Microsoft Project tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional). |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
Identifies the Microsoft Project tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.
To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.
Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.
Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.
This section provides a complete list of the SSO properties you can configure in the connection string for this provider.
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSODomain | The domain of the user when using single sign-on (SSO). |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
The identity provider's login URL.
The identity provider's login URL.
The domain of the user when using single sign-on (SSO).
This property is only applicable when using single sign-on (UseSSO is set to true) and if the domain of the User (e.g. [email protected]) is different than the domain configured within the SSO service (e.g. [email protected]).
This property may be required when using the ADFS, OneLogin, or OKTA SSO services.
Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. This is used with the SSOLoginURL.
SSO configuration is discussed further in .
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Scope | The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it defaults to the following: offline_access https://MyOrganization.sharepoint.com/.default . A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page. |
| State | Optional value for representing extra OAuth state information. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it defaults to the following: offline_access https://MyOrganization.sharepoint.com/.default . A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page.
The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl.
Optional value for representing extra OAuth state information.
Optional value for representing extra OAuth state information.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Microsoft Project. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Microsoft Project. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Microsoft Project. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | The type of schema to use: ODataV1 or ODataV2. |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
Note: Since this Sync App supports multiple schemas, custom schema files for Microsoft Project should be structured such that:
Location should always be set to the parent folder, and not to an individual schema's folder.
If left unspecified, the default location is %APPDATA%\\CData\\MicrosoftProject Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
The type of schema to use: ODataV1 or ODataV2.
The schemas available are ODataV2 (MS Project's static schema with full CRUD support) and ODataV1 (MS Project's dynamic schema with read-only capabilities).
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxProjectionLength | Set this to override the maximum length of characters supported in the $select system query option by the Microsoft Project API service. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Microsoft Project, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Set this to override the maximum length of characters supported in the $select system query option by the Microsoft Project API service.
In case the set MaxProjectionLength is exceeded when selecting multiple columns, the Sync App will split the query into multiple requests, each of them containing a subset of the selected columns. Decreasing the value can help in cases when the API might not return all the columns in the response or might throw an error because the value specified in $select is too long. On the other hand, increasing it can result in better performance because fewer HTTP requests are sent. Set the value to -1 to send all selected columns in one request regardless of the length.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of results to return from Microsoft Project, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Projects WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.
Boolean determining if simple names should be used for tables and columns.
Microsoft Project tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.