CData Cloud offers access to Microsoft Project across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Microsoft Project through CData Cloud.
CData Cloud allows you to standardize and configure connections to Microsoft Project as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Microsoft Project in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Microsoft Project and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Microsoft Project through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Microsoft Project by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
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 Cloud 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';
Record the ClientID and ClientSecret for later use.
<AppPermissionRequests> <AppPermissionRequest Scope="http://sharepoint/projectserver" Right="Manage"/> <AppPermissionRequest Scope="http://sharepoint/projectserver/projects" Right="Write"/> <AppPermissionRequest Scope="http://sharepoint/projectserver/enterpriseresources" Right="Write"/> <AppPermissionRequest Scope="http://sharepoint/projectserver/reporting" Right="Read"/> </AppPermissionRequests>
Note: The logged in user should also have the appropriate permissions to access the API.
There have been some changes made to the Cloud in the 2020 edition that should be taken into consideration.
Prior to the 2020 edition of the Cloud, 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.
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Cloud 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 Cloud 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 |
Assignments | Retrieve and modify assignments. |
Calendars | Retrieve and modify calendars. |
EnterpriseResources | Retrieve and modify resources. |
Phases | Retrieve and modify project phases. |
ProjectResources | Retrieve and modify project resources. |
Projects | Retrieve and modify projects. |
Stages | Retrieve and modify project stages. |
TaskLinks | Retrieve and modify task links. |
Tasks | Retrieve and modify tasks. |
TimeSheetLines | Retrieve and modify timesheets. |
TimeSheets | Retrieve and modify timesheets. |
Retrieve and modify 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 Assignments WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
Name | Type | ReadOnly | References | Required | Description |
Id [KEY] | String | True | False | ||
ActualCostWorkPerformed | Double | True | False | ||
ActualOvertimeCost | Double | True | False | ||
BaselineCost | Double | True | False | ||
BaselineCostPerUse | Double | True | False | ||
BaselineFinish | Datetime | True | False | ||
BaselineStart | Datetime | True | False | ||
BaselineWork | String | True | False | ||
BaselineWorkMilliseconds | Int | True | False | ||
BaselineWorkTimeSpan | Time | True | False | ||
BudgetedCostWorkPerformed | Double | True | False | ||
BudgetedCostWorkScheduled | Double | True | False | ||
CostVariance | Double | True | False | ||
CostVarianceAtCompletion | Double | True | False | ||
Created | Datetime | True | False | ||
CurrentCostVariance | Double | True | False | ||
Finish | Datetime | True | False | ||
FinishVariance | String | True | False | ||
FinishVarianceMilliseconds | Int | True | False | ||
FinishVarianceTimeSpan | Time | True | False | ||
IsConfirmed | Bool | True | False | ||
IsOverAllocated | Bool | True | False | ||
IsPublished | Bool | True | False | ||
IsResponsePending | Bool | True | False | ||
IsUpdateNeeded | Bool | True | False | ||
LevelingDelay | String | True | False | ||
LevelingDelayMilliseconds | Int | True | False | ||
LevelingDelayTimeSpan | Time | True | False | ||
Modified | Datetime | True | False | ||
Notes | String | True | False | ||
OvertimeCost | Double | True | False | ||
RemainingCost | Double | True | False | ||
RemainingOvertimeCost | Double | True | False | ||
Resume | Datetime | True | False | ||
ScheduleCostVariance | Double | True | False | ||
Start | Datetime | True | False | ||
StartVariance | String | True | False | ||
StartVarianceMilliseconds | Int | True | False | ||
StartVarianceTimeSpan | Time | True | False | ||
Stop | Datetime | True | False | ||
WorkContourType | Int | True | False | ||
WorkVariance | String | True | False | ||
WorkVarianceMilliseconds | Int | True | False | ||
WorkVarianceTimeSpan | Time | True | 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 | ||
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. |
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 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 | ||
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 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 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 ProjectResources WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
Name | Type | ReadOnly | References | Required | Description |
Id [KEY] | String | True | False | ||
ActualCost | Double | True | False | ||
ActualCostWorkPerformed | String | True | False | ||
ActualCostWorkPerformedMilliseconds | Int | True | False | ||
ActualCostWorkPerformedTimeSpan | Time | True | False | ||
ActualOvertimeCost | Double | True | False | ||
ActualOvertimeWork | String | True | False | ||
ActualOvertimeWorkMilliseconds | Int | True | False | ||
ActualOvertimeWorkTimeSpan | Time | True | False | ||
ActualWork | String | True | False | ||
ActualWorkMilliseconds | Int | True | False | ||
ActualWorkTimeSpan | Time | True | False | ||
AvailableFrom | Datetime | True | False | ||
AvailableTo | Datetime | True | False | ||
BaselineCost | Double | True | False | ||
BaselineWork | String | True | False | ||
BaselineWorkMilliseconds | Int | True | False | ||
BaselineWorkTimeSpan | Time | True | False | ||
BudetCostWorkPerformed | Double | True | False | ||
BudgetedCost | Double | True | False | ||
BudgetedCostWorkScheduled | Double | True | False | ||
BudgetedWork | String | True | False | ||
BudgetedWorkMilliseconds | Int | True | False | ||
BudgetedWorkTimeSpan | Time | True | False | ||
Cost | Double | True | False | ||
CostVariance | Double | True | False | ||
CostVarianceAtCompletion | Double | True | False | ||
Created | Datetime | True | False | ||
CurrentCostVariance | Double | True | False | ||
Finish | Datetime | True | False | ||
IsBudgeted | Bool | True | False | ||
IsGenericResource | Bool | True | False | ||
IsOverAllocated | Bool | True | False | ||
Modified | Datetime | True | False | ||
Notes | String | True | False | ||
OvertimeCost | Double | True | False | ||
OvertimeWork | String | True | False | ||
OvertimeWorkMilliseconds | Int | True | False | ||
OvertimeWorkTimeSpan | Time | True | False | ||
PeakWork | String | True | False | ||
PeakWorkMilliseconds | Int | True | False | ||
PeakWorkTimeSpan | Time | True | False | ||
PercentWorkComplete | Int | True | False | ||
RegularWork | String | True | False | ||
RegularWorkMilliseconds | Int | True | False | ||
RegularWorkTimeSpan | Time | True | False | ||
RemainingCost | Double | True | False | ||
RemainingOvertimeCost | Double | True | False | ||
RemainingOvertimeWork | String | True | False | ||
RemainingOvertimeWorkMilliseconds | Int | True | False | ||
RemainingOvertimeWorkTimeSpan | Time | True | False | ||
RemainingWork | String | True | False | ||
RemainingWorkMilliseconds | Int | True | False | ||
RemainingWorkTimeSpan | Time | True | False | ||
ScheduleCostVariance | Double | True | False | ||
Start | Datetime | True | False | ||
Work | String | True | False | ||
WorkMilliseconds | Int | True | False | ||
WorkTimeSpan | Time | True | False | ||
WorkVariance | String | True | False | ||
WorkVarianceMilliseconds | Int | True | False | ||
WorkVarianceTimeSpan | Time | 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 | ||
LinkedAssignments | String | False | False | ||
LinkedDefaultAssignmentOwner | String | False | False | ||
ProjectId [KEY] | String | True | False |
Id of the parent. |
Retrieve and modify projects.
Name | Type | ReadOnly | References | Required | Description |
Id [KEY] | String | True | False | ||
ApprovedEnd | Datetime | True | False | ||
ApprovedStart | Datetime | True | False | ||
CalculateActualCosts | Bool | True | False | ||
CalculatesActualCosts | Bool | True | False | ||
CheckedOutDate | Datetime | True | False | ||
CheckOutDescription | String | True | False | ||
CheckOutId | String | True | False | ||
CreatedDate | Datetime | True | False | ||
CriticalSlackLimit | Int | True | False | ||
DefaultFinishTime | Datetime | True | False | ||
DefaultOvertimeRateUnits | Int | True | False | ||
DefaultStandardRateUnits | Int | True | False | ||
DefaultStartTime | Datetime | True | False | ||
HasMppPendingImport | Bool | True | False | ||
HonorConstraints | Bool | True | False | ||
IsCheckedOut | Bool | True | False | ||
LastPublishedDate | Datetime | True | False | ||
LastSavedDate | Datetime | True | False | ||
ListId | String | True | False | ||
MoveActualIfLater | Bool | True | False | ||
MoveActualToStatus | Bool | True | False | ||
MoveRemainingIfEarlier | Bool | True | False | ||
MoveRemainingToStatus | Bool | True | False | ||
MultipleCriticalPaths | Bool | True | False | ||
OptimizerDecision | Int | True | False | ||
PercentComplete | Int | True | False | ||
PlannerDecision | Int | True | False | ||
ProjectSiteUrl | String | True | False | ||
ProjectType | Int | True | False | ||
SplitInProgress | Bool | True | False | ||
SpreadActualCostsToStatus | Bool | True | False | ||
SpreadPercentCompleteToStatus | Bool | True | False | ||
SummaryTaskId | String | True | False | ||
TaskListId | String | True | False | ||
WebId | 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 | ||
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 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 | ||
LinkedCustomFields | String | False | False | ||
LinkedPhase | String | False | False | ||
LinkedProjectDetailPages | String | False | False | ||
LinkedWorkflowStatusPage | String | False | False |
Retrieve and modify 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 TaskLinks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
Name | Type | ReadOnly | References | Required | Description |
Id [KEY] | String | True | False | ||
DependencyType | Int | False | False | ||
EndId | String | False | False | ||
LinkLagDuration | String | False | False | ||
StartId | String | False | False | ||
LinkedEnd | String | False | False | ||
LinkedStart | String | False | False | ||
ProjectId [KEY] | String | True | False |
Id of the parent. | |
PredecessorTaskId | String | True | False |
Id of the preceding task. | |
SuccessorTaskId | String | True | False |
Id of the succeeding task. |
Retrieve and modify 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 Tasks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'
Name | Type | ReadOnly | References | Required | Description |
Id [KEY] | String | True | False | ||
ActualCostWorkPerformed | Double | True | False | ||
ActualDuration | String | True | False | ||
ActualDurationMilliseconds | Int | True | False | ||
ActualDurationTimeSpan | Time | True | False | ||
ActualOvertimeCost | Double | True | False | ||
ActualOvertimeWork | String | True | False | ||
ActualOvertimeWorkMilliseconds | Int | True | False | ||
ActualOvertimeWorkTimeSpan | Time | True | False | ||
BaselineCost | Double | True | False | ||
BaselineDuration | String | True | False | ||
BaselineDurationMilliseconds | Int | True | False | ||
BaselineDurationTimeSpan | Time | True | False | ||
BaselineFinish | Datetime | True | False | ||
BaselineStart | Datetime | True | False | ||
BaselineWork | String | True | False | ||
BaselineWorkMilliseconds | Int | True | False | ||
BaselineWorkTimeSpan | Time | True | False | ||
BudgetCost | Double | True | False | ||
BudgetedCostWorkPerformed | Double | True | False | ||
BudgetedCostWorkScheduled | Double | True | False | ||
Contact | String | True | False | ||
CostPerformanceIndex | Double | True | False | ||
CostVariance | Double | True | False | ||
CostVarianceAtCompletion | Double | True | False | ||
CostVariancePercentage | Int | True | False | ||
Created | Datetime | True | False | ||
CurrentCostVariance | Double | True | False | ||
DurationVariance | String | True | False | ||
DurationVarianceMilliseconds | Int | True | False | ||
DurationVarianceTimeSpan | Time | True | False | ||
EarliestFinish | Datetime | True | False | ||
EarliestStart | Datetime | True | False | ||
EstimateAtCompletion | Double | True | False | ||
ExternalProjectUid | String | True | False | ||
ExternalTaskUid | String | True | False | ||
FinishSlack | String | True | False | ||
FinishSlackMilliseconds | Int | True | False | ||
FinishSlackTimeSpan | Time | True | False | ||
FinishVariance | String | True | False | ||
FinishVarianceMilliseconds | Int | True | False | ||
FinishVarianceTimeSpan | Time | True | False | ||
FixedCostAccrual | Int | True | False | ||
FreeSlack | String | True | False | ||
FreeSlackMilliseconds | Int | True | False | ||
FreeSlackTimeSpan | Time | True | False | ||
IgnoreResourceCalendar | Bool | True | False | ||
IsCritical | Bool | True | False | ||
IsDurationEstimate | Bool | True | False | ||
IsExternalTask | Bool | True | False | ||
IsOverAllocated | Bool | True | False | ||
IsRecurring | Bool | True | False | ||
IsRecurringSummary | Bool | True | False | ||
IsRolledUp | Bool | True | False | ||
IsSubProject | Bool | True | False | ||
IsSubProjectReadOnly | Bool | True | False | ||
IsSubProjectScheduledFromFinish | Bool | True | False | ||
IsSummary | Bool | True | False | ||
LatestFinish | Datetime | True | False | ||
LatestStart | Datetime | True | False | ||
LevelingDelay | String | True | False | ||
LevelingDelayMilliseconds | Int | True | False | ||
LevelingDelayTimeSpan | Time | True | False | ||
Modified | Datetime | True | False | ||
Notes | String | True | False | ||
OutlinePosition | String | True | False | ||
OvertimeCost | Double | True | False | ||
OvertimeWork | String | True | False | ||
OvertimeWorkMilliseconds | Int | True | False | ||
OvertimeWorkTimeSpan | Time | True | False | ||
PercentWorkComplete | Int | True | False | ||
PreLevelingFinish | Datetime | True | False | ||
PreLevelingStart | Datetime | True | False | ||
RegularWork | String | True | False | ||
RegularWorkMilliseconds | Int | True | False | ||
RegularWorkTimeSpan | Time | True | False | ||
RemainingCost | Double | True | False | ||
RemainingOvertimeCost | Double | True | False | ||
RemainingOvertimeWork | String | True | False | ||
RemainingOvertimeWorkMilliseconds | Int | True | False | ||
RemainingOvertimeWorkTimeSpan | Time | True | False | ||
RemainingWork | String | True | False | ||
RemainingWorkMilliseconds | Int | True | False | ||
RemainingWorkTimeSpan | Time | True | False | ||
Resume | Datetime | True | False | ||
ScheduleCostVariance | Double | True | False | ||
ScheduledDuration | String | True | False | ||
ScheduledDurationMilliseconds | Int | True | False | ||
ScheduledDurationTimeSpan | Time | True | False | ||
ScheduledFinish | Datetime | True | False | ||
ScheduledStart | Datetime | True | False | ||
SchedulePerformanceIndex | Double | True | False | ||
ScheduleVariancePercentage | Int | True | False | ||
StartSlack | String | True | False | ||
StartSlackMilliseconds | Int | True | False | ||
StartSlackTimeSpan | Time | True | False | ||
StartVariance | String | True | False | ||
StartVarianceMilliseconds | Int | True | False | ||
StartVarianceTimeSpan | Time | True | False | ||
Stop | Datetime | True | False | ||
ToCompletePerformanceIndex | Double | True | False | ||
TotalSlack | String | True | False | ||
TotalSlackMilliseconds | Int | True | False | ||
TotalSlackTimeSpan | Time | True | False | ||
WorkBreakdownStructure | String | True | False | ||
WorkVariance | String | True | False | ||
WorkVarianceMilliseconds | Int | True | False | ||
WorkVarianceTimeSpan | Time | 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 | ||
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 | ||
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. |
Retrieve and modify timesheets.
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 | ||
LinkedAssignment | String | False | False | ||
LinkedTimeSheet | String | False | False | ||
LinkedWork | String | False | False | ||
PeriodId [KEY] | String | True | False |
Id of the parent. |
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 | ||
LinkedCreator | String | False | False | ||
LinkedLines | String | False | False | ||
LinkedManager | String | False | False | ||
LinkedPeriod | 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 events. |
ProjectDetailPages | Retrieve project details. |
StageDetailPages | Retrieve project details.. |
Tasks_Assignments | Retrieve and modify assignments. |
Tasks_Calendar | Retrieve and modify assignments. |
TimeSheetPeriods | Retrieve timesheet periods. |
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 events.
Name | Type | References | Description |
Id [KEY] | Int | ||
EventName | String | ||
SourceName | String |
Retrieve project details.
Name | Type | References | Description |
Id [KEY] | String | ||
Name | String | ||
PageType | Int | ||
LinkedItem | String |
Retrieve project details..
Name | Type | References | Description |
Id [KEY] | String | ||
Name | String | ||
PageType | Int | ||
LinkedItem | String | ||
StageId [KEY] | String | Id of the parent. |
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 timesheet periods.
Name | Type | References | Description |
Id [KEY] | String | ||
End | Datetime | ||
Name | String | ||
Start | Datetime | ||
LinkedTimeSheet | String |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Project.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Project, along with an indication of whether the procedure succeeded or failed.
Name | Description |
CheckIn | Check in the specified project. |
CheckOut | Check out the specified project. |
GetOnlineCookies | Retrieves the cookies for authentication with SharePoint Online. |
Publish | Publish the specified project. |
Check in the specified project.
Name | Type | Description |
ProjectId | String | The Id of the project you are checking in. |
Force | String | Set to true to force check in. Default is false. |
Name | Type | Description |
Success | String | The result of the operation. |
Check out the specified project.
Name | Type | Description |
ProjectId | String | The Id of the project you are checking out. |
Name | Type | Description |
Success | String | The result of the operation. |
Retrieves the cookies for authentication with SharePoint Online.
Name | Type | Description |
User | String | Your SharePoint Online username. |
Password | String | Your SharePoint Online password. |
STSURL | String | Your SharePoint Online STSURL. This only needs to be set if your organization uses a local ADFS server for authentication. |
Name | Type | Description |
Cookie | String | The cookies that will need to be entered in the AuthCookie connection string property. |
Publish the specified project.
Name | Type | Description |
ProjectId | String | The Id of the project you are publishing. |
CheckIn | String | Set to true to publish the proejct. Default value is false. |
Name | Type | Description |
Success | String | The result of the operation. |
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 |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Project.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Project, along with an indication of whether the procedure succeeded or failed.
Name | Description |
GetOnlineCookies | Retrieves the cookies for authentication with SharePoint Online. |
Retrieves the cookies for authentication with SharePoint Online.
Name | Type | Description |
User | String | Your SharePoint Online username. |
Password | String | Your SharePoint Online password. |
STSURL | String | Your SharePoint Online STSURL. This only needs to be set if your organization uses a local ADFS server for authentication. |
Name | Type | Description |
Cookie | String | The cookies that will need to be entered in the AuthCookie connection string property. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Microsoft Project:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Projects table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Projects'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Projects table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Projects'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:microsoftproject:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The Cloud 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 Auto,OAuth,OKTA,ADFS, and OneLogin. |
URL | URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/. |
User | The Microsoft Project user account used to authenticate. |
Password | The password used to authenticate the user. |
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. |
Property | Description |
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
AzureEnvironment | The Azure Environment to use when establishing a connection. |
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 in a semicolon-separated list. |
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an 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 deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. 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. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Schema | The type of schema to use: ODataV1 or ODataV2. |
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Pagesize | The maximum number of results to return per page from Microsoft Project. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
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 Auto,OAuth,OKTA,ADFS, and OneLogin. |
URL | URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/. |
User | The Microsoft Project user account used to authenticate. |
Password | The password used to authenticate the user. |
The scheme used for authentication. Accepted entries are Auto,OAuth,OKTA,ADFS, and OneLogin.
string
"Auto"
This field is used to authenticate to Microsoft Project. Auto is the default option.
URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
string
""
URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
The Microsoft Project user account used to authenticate.
string
""
Together with Password, this field is used to authenticate against the Microsoft Project server.
The password used to authenticate the user.
string
""
The User and Password are together used to authenticate with the server.
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. |
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.
string
""
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.
This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.
Property | Description |
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
AzureEnvironment | The Azure Environment to use when establishing a connection. |
The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
string
""
The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.
Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.
The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.
The Azure Environment to use when establishing a connection.
string
"GLOBAL"
In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, 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 in a semicolon-separated list. |
The identity provider's login URL.
string
""
The identity provider's login URL.
The domain of the user when using single sign-on (SSO).
string
""
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 in a semicolon-separated list.
string
""
Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction 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 | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an 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 deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. 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 client Id assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
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 deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. 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.
string
""
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.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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 Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Schema | The type of schema to use: ODataV1 or ODataV2. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
The type of schema to use: ODataV1 or ODataV2.
string
"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 |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Pagesize | The maximum number of results to return per page from Microsoft Project. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
The maximum number of results to return per page from Microsoft Project.
int
400
The Pagesize property affects the maximum number of results to return per page from Microsoft Project. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
Boolean determining if simple names should be used for tables and columns.
bool
false
Microsoft Project tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud 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.