Returns Project Risk for specified Project ID and Risk Code.
get
/primeapi/restapi/v16.2/projectRisk/project/{id}/riskCode/{riskCode}
Request
Path Parameters
- id
-
Type:
integer
(int64
)Required:true
- riskCode
Type:string
Required:true
Response
Supported Media Types
- application/json
200 Response
successful operation
Body
Root Schema : ApiEntityProjectRisk
Type:
object
- cause
-
Type:
string
A description of the cause of the risk. - codeValuesRisk
-
Type:
array
codeValuesRiskUnique Items Required:true
??projectRisk_resource_riskCodeValues?? - description
-
Type:
string
A detailed summary of the risk. - effect
-
Type:
string
The resulting effect of the presence of the risk. - hasPostResponseData
-
Type:
boolean
Default Value:false
- identifiedBy
-
Type:
object
ApplicationUser - identifiedById
-
Type:
integer
(int64
) - identifiedDate
-
Type:
string
(date-time
) - impacts
-
Type:
array
impactsUnique Items Required:true
- owner
-
Type:
object
ApplicationUser - ownerId
-
Type:
integer
(int64
) - project
-
Type:
object
ApiEntityProject - projectId
-
Type:
integer
(int64
) - projectRiskFlexCost
-
Type:
object
ApiEntityProjectRiskFlexCost - projectRiskFlexOther
-
Type:
object
ApiEntityProjectRiskFlexOther - projectRiskFlexText
-
Type:
object
ApiEntityProjectRiskFlexText - projectRiskId
-
Type:
integer
(int64
) - riskCategory
-
Type:
object
ApiEntityRiskCategory - riskCategoryId
-
Type:
integer
(int64
)The unique identifier for the risk type. - riskCode
-
Type:
string
The unique identifier for the risk. - riskName
-
Type:
string
The name of the risk. - riskStatus
-
Type:
string
Allowed Values:[ "PROPOSED", "OPEN", "ACTIVE", "REJECTED", "MANAGED", "IMPACTED" ]
- riskType
-
Type:
string
Allowed Values:[ "THREAT", "OPPORTUNITY" ]
The type of risk. Valid values are Threat and Opportunity.
Nested Schema : codeValuesRisk
Type:
array
Unique Items Required:
true
??projectRisk_resource_riskCodeValues??
-
Type:
object
ApiEntityCodeValueRisk
Nested Schema : ApplicationUser
Type:
object
- createDate
-
Type:
string
(date-time
) - createOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- createUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- ldapGuid
-
Type:
string
- name
-
Type:
string
- overlayObject
-
Type:
boolean
Default Value:false
- primaryKey
-
Type:
integer
(int64
) - privileges
-
Type:
array
privileges - snapshotObject
-
Type:
boolean
Default Value:false
- updateDate
-
Type:
string
(date-time
) - updateOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- updateUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- userId
-
Type:
integer
(int64
) - userName
-
Type:
string
- userProducts
-
Type:
array
userProductsUnique Items Required:true
- userSettings
-
Type:
array
userSettingsUnique Items Required:true
Nested Schema : impacts
Nested Schema : ApiEntityProject
Type:
object
- actualDuration
-
Type:
object
Duration - actualFinish
-
Type:
string
(date-time
)The Actual Finish displays the date on which a project is considered complete. - actualStart
-
Type:
string
(date-time
)The Actual Start indicates the date work on the project began. - addressLine1
-
Type:
string
The first line of the address of a location. This might be the building number and street address. - addressLine2
-
Type:
string
The second line of the address of a location. This might be a neighborhood or town. - calendarId
-
Type:
integer
(int64
)The unique identifier for the calendar. - cityName
-
Type:
string
The city name for a location. - codeValuesProject
-
Type:
array
codeValuesProjectUnique Items Required:true
Lists all project code types assigned to the project with its corresponding value. - countryCode
-
Type:
string
The country for a location. - currentApprovedFinishDate
-
Type:
string
(date-time
)The finish date for the Current Approved Budget set by the capital planner. - currentApprovedStartDate
-
Type:
string
(date-time
)The start date for the Current Approved Budget set by the capital planner. - dataDate
-
Type:
string
(date-time
)The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually. The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities. - description
-
Type:
string
Allowed Values:[ "Length[1-4000]" ]
The detailed summary for the project. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are especially useful in multi-user environments. - exchangeRateType
-
Type:
string
Allowed Values:[ "FLOATING", "PEGGED" ]
- finishDate
-
Type:
string
(date-time
)The date on which all project work is complete. - finishDateVariance
-
Type:
object
Duration - forecastFinishDate
-
Type:
string
(date-time
)The planned finish date of a project's remaining Forecast cost. - forecastStartDate
-
Type:
string
(date-time
)The planned start date of a project's remaining Forecast cost. - latitude
-
Type:
number
(double
)The geographical coordinate for the latitude of the location. The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. - linkForecastToSpend
-
Type:
boolean
Default Value:false
Enables you to link project Forecast data to project Actuals data. When linked, any updates to the project's Actuals values will automatically be applied to the project's Forecast values. - locationName
-
Type:
string
A name for the location that your users will understand and recognize. - longitude
-
Type:
number
(double
)The geographical coordinate for the longitude of the location. The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. - mustFinishByDate
-
Type:
string
(date-time
)The latest date on which the scheduled activities must be complete for a project. - owner
-
Type:
string
The manager or person responsible for the project. - parentProject
-
Type:
integer
(int64
) - pegRate
-
Type:
number
The custom exchange rate for a pegged exchange rate. - percentComplete
-
Type:
object
Percent - percentCompleteWeightedBy
-
Type:
string
Allowed Values:[ "COST", "QUANTITY", "HOURS", "MANUAL" ]
The weight for scope items is calculated using quantity. - planDuration
-
Type:
object
Duration - planEndDate
-
Type:
string
(date-time
)The finish date for the time phased Planned Budget of the project. Planned Budget cost spread will adjust when this date is changed. - planStartDate
-
Type:
string
(date-time
)The start date for the time phased Planned Budget of the project. Planned Budget cost spread will adjust when this date is changed. The Project Planned Start also represents the earliest date that activities can occur within a project schedule. - postalCode
-
Type:
string
The postal code, post code, or zip code of a location. - priorityNum
-
Type:
integer
(int64
)The project's priority in the strategic plan. This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. - projectCashFlows
-
Type:
array
projectCashFlowsLists all project cost field spread data assigned to the project. - projectCode
-
Type:
string
Allowed Values:[ "Length[1-60]" ]
The unique identifier for a project set by the user who created the project. - projectCPFlexCost
-
Type:
object
ApiEntityProjectCPFlexCost - projectCPFlexOther
-
Type:
object
ApiEntityProjectCPFlexOther - projectCPFlexText
-
Type:
object
ApiEntityProjectCPFlexText - projectCurrency
-
Type:
integer
(int64
)KEY - projectFinancial
-
Type:
object
ApiEntityProjectFinancial - projectId
-
Type:
integer
(int64
)The unique identifier for the project. - projectIntegrationType
-
Type:
string
Allowed Values:[ "P6", "UNIFIER" ]
Specifies if the project is integrated with another application. - projectName
-
Type:
string
Allowed Values:[ "Length[1-255]" ]
The name of the project. - projectSettings
-
Type:
array
projectSettingsUnique Items Required:true
- proposedFinishDate
-
Type:
string
(date-time
)The finish date for the Proposed Budget of the project. - proposedStartDate
-
Type:
string
(date-time
)The start date for the Proposed Budget of the project. - recordCount
-
Type:
integer
(int32
)The number of comments on a project. - remainingDuration
-
Type:
object
Duration - reportCycleId
-
Type:
integer
(int64
)The reporting cycle assigned to the project. - reportCycleNamingBoundary
-
Type:
string
Allowed Values:[ "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
Determines when period names will be reset. The options available are based on the selection for Reporting Cycle. The standard calendar start and end dates are used as boundaries for resetting periods. - riskLevel
-
Type:
string
Allowed Values:[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ]
The risk level assigned to the project. Projects can have a risk level of very high, high, medium, low, or very low. You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority. - riskMatrixId
-
Type:
integer
(int64
)The risk matrix assigned to the project for calculating project risk scores. - riskScore
-
Type:
integer
(int32
)The risk score value is based on the probability and impacts of a risk. It is derived from the probability impact matrix and any associated rules. - scheduledFinishDate
-
Type:
string
(date-time
)The calculated latest early finish date, which is based on the schedule most recently generated for the project. - securityGuid
-
Type:
string
STRING - sequenceNumber
-
Type:
integer
(int32
)Determines the order of appearance of projects in a list. - spendEffectiveDate
-
Type:
string
(date-time
)The month in which an actuals value was last added to the project. - spendFinishDate
-
Type:
string
(date-time
)The finish date for the project actuals. - spendStartDate
-
Type:
string
(date-time
)The start date for the project actuals. - startDate
-
Type:
string
(date-time
)The date on which work on the project starts. - startDateVariance
-
Type:
object
Duration - stateCode
-
Type:
string
A unique identifier for the state or province. - stateName
-
Type:
string
The state, region, or province of a location. - status
-
Type:
string
Allowed Values:[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETED" ]
The current status of a project. Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs. Rejected: The project proposal has been rejected and will not be initiated as a project. Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage. Active: The project is currently active and being executed. Inactive: The project has been rendered inactive and will temporarily accrue no costs. Complete: The project has been successfully completed and will no longer accrue costs. - strgyPriorityNum
-
Type:
integer
(int64
)The project's priority in the strategic plan. This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data. - summarizedDataDate
-
Type:
string
(date-time
) - websiteUrl
-
Type:
string
Allowed Values:[ "Length[1-200]" ]
The link to a website related to the project. - workspaceId
-
Type:
integer
(int64
)The workspace the project is associated with.
Nested Schema : ApiEntityProjectRiskFlexCost
Type:
object
- flexMap
-
Type:
object
flexMapRequired:true
Additional Properties Allowed: additionalProperties - projectRisk
-
Type:
object
ApiEntityProjectRisk - projectRiskId
-
Type:
integer
(int64
)Required:true
Nested Schema : ApiEntityProjectRiskFlexOther
Type:
object
- flexMap
-
Type:
object
flexMapRequired:true
Additional Properties Allowed: additionalProperties - projectRisk
-
Type:
object
ApiEntityProjectRisk - projectRiskId
-
Type:
integer
(int64
)Required:true
Nested Schema : ApiEntityProjectRiskFlexText
Type:
object
- flexMap
-
Type:
object
flexMapRequired:true
Additional Properties Allowed: additionalProperties - projectRisk
-
Type:
object
ApiEntityProjectRisk - projectRiskId
-
Type:
integer
(int64
)Required:true
Nested Schema : ApiEntityRiskCategory
Type:
object
- parentRiskCategory
-
Type:
object
ApiEntityRiskCategory - parentRiskCategoryId
-
Type:
integer
(int64
) - riskCategoryId
-
Type:
integer
(int64
) - riskCategoryName
-
Type:
string
- workspace
-
Type:
object
ApiEntityWorkspace - workspaceId
-
Type:
integer
(int64
)
Nested Schema : ApiEntityCodeValueRisk
Type:
object
- codeType
-
Type:
object
ApiEntityCodeType - codeValue
-
Type:
object
ApiEntityCodeValue - codeValueRiskId
-
Type:
integer
(int64
)KEY
Nested Schema : ApiEntityCodeType
Type:
object
- assignments
-
Type:
array
assignmentsUnique Items Required:true
- codeTypeCode
-
Type:
string
Allowed Values:[ "Length[1-40]" ]
This field displays the name of a code or value. - codeTypeId
-
Type:
integer
(int64
) - codeTypeName
-
Type:
string
Allowed Values:[ "Length[1-40]" ]
STRING - workspace
-
Type:
integer
(int64
)The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
object
- codeTypeId
-
Type:
integer
(int64
)The ID for the code type. - codeValueCode
-
Type:
string
Allowed Values:[ "LENGTH[1-32]" ]
The unique identifier for the code value. - codeValueId
-
Type:
integer
(int64
)The unique identifier for the code value. - codeValueName
-
Type:
string
Allowed Values:[ "LENGTH[1-100]" ]
The name of the code value. - parentCodeValue
-
Type:
integer
(int64
)The parent code value. - sequenceNumber
-
Type:
integer
(int32
)The number that specifies the position of the code value item within the code type list.
Nested Schema : assignments
Nested Schema : ApiEntityCodeEntityType
Type:
object
- codeType
-
Type:
object
ApiEntityCodeType - entityType
-
Type:
string
Allowed Values:[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "PROJECT_FUND", "WORKSPACE_FUND" ]
- primaryKey
-
Type:
integer
(int64
)
Nested Schema : privileges
Type:
array
-
Type:
string
Allowed Values:[ "ALL", "VIEW", "CREATE", "DELETE", "UPDATE", "VIEW_COST", "UPDATE_COST", "APPLICATION_ADMINISTRATOR", "ASSIGN_PROXY_USERS", "ADMINISTER_WORKFLOW_INSTANCES", "APP_SETTINGS", "INTEGRATION", "EDIT_PERFORMANCE_DASHBOARDS", "ADD_WORKSPACE", "EDIT_WORKSPACE", "DELETE_WORKSPACE", "EDIT_ANALYSIS_VIEWS", "ADD_FIELDS", "EDIT_FIELDS", "EDIT_STANDARD_FIELDS", "EDIT_LOCATIONS", "ADD_CODE", "EDIT_CODE", "DELETE_CODE", "ADD_CURVE", "EDIT_CURVE", "DELETE_CURVE", "ADD_RULES_OF_CREDIT", "EDIT_RULES_OF_CREDIT", "DELETE_RULES_OF_CREDIT", "START_WORKFLOWS", "ADD_WORKFLOW_DESIGN", "DELETE_WORKFLOW_DESIGN", "EDIT_WORKFLOW_DESIGN", "VIEW_WORKFLOW_DESIGN", "ADD_WORKFLOW_CONFIG", "DELETE_WORKFLOW_CONFIG", "EDIT_WORKFLOW_CONFIG", "VIEW_WORKFLOW_CONFIG", "ADD_FORMS", "DELETE_FORMS", "EDIT_FORMS", "VIEW_FORMS", "ADD_CAPITAL_PORTFOLIOS", "ADD_PROJECT", "ADD_PROJECT_PROPOSALS", "PROMOTE_REPORT", "ADD_SECURITY_GROUPS", "EDIT_SECURITY_GROUPS", "DELETE_SECURITY_GROUPS", "SECURITY_PROFILE", "WORKSPACE_ADMINISTRATOR", "ADD_CBS_CODES", "EDIT_CBS_CODES", "DELETE_CBS_CODES", "ADD_UNITS_OF_MEASURE", "EDIT_UNITS_OF_MEASURE", "DELETE_UNITS_OF_MEASURE", "ADD_REASONS", "EDIT_REASONS", "DELETE_REASONS", "ADD_WORKSPACE_COST_SHEET", "EDIT_WORKSPACE_COST_SHEET", "AGGREGATE_COST_DATA", "ADD_CALENDARS", "EDIT_CALENDARS", "DELETE_CALENDARS", "ADD_RESOURCES", "EDIT_RESOURCES", "DELETE_RESOURCES", "ADD_ROLES", "EDIT_ROLES", "DELETE_ROLES", "ADD_WORKSPACE_ACTIVITY_LAYOUTS", "EDIT_WORKSPACE_ACTIVITY_LAYOUTS", "DELETE_WORKSPACE_ACTIVITY_LAYOUTS", "MODIFY_WORKSPACE_DASHBOARDS", "ADD_INSIGHTS", "EDIT_INSIGHTS", "DELETE_INSIGHTS", "RISK_THRESHOLDS", "MODIFY_COMPANY", "RISK_MATRICES", "ADD_CURRENCY", "EDIT_CURRENCY", "DELETE_CURRENCY", "ADD_REPROT_CYCLE", "EDIT_REPORT_CYCLE", "DELETE_REPORT_CYCLE", "ADD_COST_CATEGORIES", "EDIT_COST_CATEGORIES", "DELETE_COST_CATEGORIES", "ADD_MEASURES", "EDIT_MEASURES", "DELETE_MEASURES", "ADD_CATEGORIES", "EDIT_CATEGORIES", "DELETE_CATEGORIES", "ADD_STRATEGY_TYPES", "EDIT_STRATEGY_TYPES", "DELETE_STRATEGY_TYPES", "ADD_WORKSPACE_FUND", "EDIT_WORKSPACE_FUND", "DELETE_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND_COSTS", "EDIT_WORKSPACE_FUND_COSTS", "VIEW_STRATEGIES", "ADD_STRATEGIES", "EDIT_STRATEGIES", "DELETE_STRATEGIES", "TEMPLATE_PROJECT", "PROJECT_ADMINISTRATOR", "EDIT_PROJECT", "DELETE_PROJECT", "EDIT_WORKSPACE_COST_UDFS", "VIEW_WORKSPACE_COST_UDFS", "EDIT_PROJECT_WBS_COSTS", "VIEW_PROJECT_WBS_COSTS", "ACCEPT_BUDGET_REQUEST_CHANGES", "PROJECT_BASELINES_SNAPSHOTS", "ENABLE_PROJECT_SCHEDULE", "ENABLE_PROJECT_LEVEL", "ENABLE_PROJECT_RISK_ANALYSIS", "DOCUMENTS", "EDIT_PROJECT_PROPOSALS", "DELETE_PROJECT_PROPOSALS", "EDIT_PROJECT_PROPOSALS_COSTS", "ADD_WBS", "EDIT_WBS", "DELETE_WBS", "ADD_PBS", "EDIT_PBS", "DELETE_PBS", "ADD_ACTIVITY", "EDIT_ACTIVITY", "DELETE_ACTIVITY", "ADD_RESOURCE_ASSIGNMENT", "EDIT_RESOURCE_ASSIGNMENT", "DELETE_RESOURCE_ASSIGNMENT", "ADD_WORK_PACKAGE", "EDIT_WORK_PACKAGE", "DELETE_WORK_PACKAGE", "ADD_SCOPE_ITEM", "EDIT_SCOPE_ITEM", "DELETE_SCOPE_ITEM", "VIEW_PROJECT_PBS_COSTS", "EDIT_PROJECT_PBS_COSTS", "ADD_SCOPE_ITEM_ASSIGNMENT", "EDIT_SCOPE_ITEM_ASSIGNMENT", "DELETE_SCOPE_ITEM_ASSIGNMENT", "ADD_SCOPE_CHANGE_REQUEST", "EDIT_SCOPE_CHANGE_REQUEST", "DELETE_SCOPE_CHANGE_REQUEST", "APPROVE_REJECT_SCOPE_CHANGE_REQUEST", "SET_PROJECT_BASELINE", "RESET_PROJECT_BASELINE", "ENABLE_PROJECT_INTEGRATION", "ADD_COST_SHEET_CODES", "EDIT_COST_SHEET_CODES", "DELETE_COST_SHEET_CODES", "ADD_PROJECT_ACTIVITY_LAYOUTS", "EDIT_PROJECT_ACTIVITY_LAYOUTS", "DELETE_PROJECT_ACTIVITY_LAYOUTS", "ADD_ACTIVITY_RELATIONSHIPS", "EDIT_ACTIVITY_RELATIONSHIPS", "DELETE_ACTIVITY_RELATIONSHIPS", "MODIFY_RISK_REGISTER", "ADD_RISK_REGISTER", "DELETE_RISK_REGISTER", "ADD_PROJECT_RISK_MATRIX", "DELETE_PROJECT_RISK_MATRIX", "MODIFY_PROJECT_RISK_MATRIX", "EDIT_PROJECT_CURRENCY", "VIEW_RISK_REGISTER", "MODIFY_ALERTS_THRESHOLDS", "MODIFY_PROJECT_DASHBOARDS", "ADD_PROJECT_RESOURCES", "EDIT_PROJECT_RESOURCES", "DELETE_PROJECT_RESOURCES", "ADD_PROJECT_ROLES", "EDIT_PROJECT_ROLES", "DELETE_PROJECT_ROLES", "VIEW_MANUAL_BUDGET", "ADD_MANUAL_BUDGET", "EDIT_MANUAL_BUDGET", "DELETE_MANUAL_BUDGET", "VIEW_PROJECT_ACTUALS", "ADD_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS", "DELETE_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS_COSTS", "VIEW_PROJECT_ACTUALS_COSTS", "VIEW_CONTRACT", "ADD_CONTRACT", "EDIT_CONTRACT", "DELETE_CONTRACT", "ADD_DEMAND", "EDIT_DEMAND", "DELETE_DEMAND", "EDIT_CONTRACT_COSTS", "VIEW_CONTRACT_COSTS", "VIEW_CONTRACT_BUDGET", "ADD_CONTRACT_BUDGET", "EDIT_CONTRACT_BUDGET", "DELETE_CONTRACT_BUDGET", "VIEW_COMMITMENT", "ADD_COMMITMENT", "EDIT_COMMITMENT", "DELETE_COMMITMENT", "EDIT_COMMITMENT_COSTS", "VIEW_COMMITMENT_COSTS", "VIEW_COMMITMENT_CHANGE_ORDERS", "EDIT_COMMITMENT_CHANGE_ORDERS", "ADD_COMMITMENT_CHANGE_ORDERS", "VIEW_CONTRACT_CHANGE_ORDERS", "EDIT_CONTRACT_CHANGE_ORDERS", "ADD_CONTRACT_CHANGE_ORDERS", "CLOSE_REPORTING_PERIOD", "PROJECT_INTEGRATION_CREATE", "PROJECT_INTEGRATION_DELETE", "ADD_PROJECT_SECURITY_GROUPS", "EDIT_PROJECT_SECURITY_GROUPS", "DELETE_PROJECT_SECURITY_GROUPS", "ADD_PROJECT_FUND", "EDIT_PROJECT_FUND", "DELETE_PROJECT_FUND", "VIEW_PROJECT_FUND", "VIEW_PROJECT_FUND_COSTS", "EDIT_PROJECT_FUND_COSTS", "ADD_LEAN_TASK", "EDIT_LEAN_TASK", "DELETE_LEAN_TASK", "ADD_LEAN_TASK_USER_COMPANY", "EDIT_LEAN_TASK_USER_COMPANY", "DELETE_LEAN_TASK_USER_COMPANY", "COMPLETE_COMMIT_LEAN_TASK", "COMPLETE_COMMIT_LEAN_TASK_USER_TASK", "EDIT_PROJECT_COMPANY", "CAPITAL_PORTFOLIO_PLAN_ADMINISTRATOR", "MODIFY_PORTFOLIO_DASHBOARDS", "EDIT_CAPITAL_PORTFOLIO", "DELETE_CAPITAL_PORTFOLIO", "EDIT_CAPITAL_PORTFOLIO_COSTS", "VIEW_CAPITAL_PORTFOLIO_COSTS", "ADD_CAPITAL_PLAN", "EDIT_CAPITAL_PLAN", "DELETE_CAPITAL_PLAN", "ASSIGN_WORKFLOWS_CAPITAL_PLAN_ACTIONS", "ADD_CAPITAL_PLAN_TARGETS", "EDIT_CAPITAL_PLAN_TARGETS", "DELETE_CAPITAL_PLAN_TARGETS", "ADD_CAPITAL_PLAN_THRESHOLDS", "EDIT_CAPITAL_PLAN_THRESHOLDS", "DELETE_CAPITAL_PLAN_THRESHOLDS", "ADD_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_SCENARIOS", "DELETE_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_COSTS", "VIEW_CAPITAL_PLAN_COSTS", "SEND_CAPITAL_PLAN_SCENARIO_REVIEW", "SHARE_CAPITAL_PLAN_SCENARIO", "SEND_CAPITAL_PLAN_SCENARIO_APPROVAL", "APPROVE_CAPITAL_PLAN_SCENARIO", "ASSIGN_ANALYSIS_VIEWS_NAVIGATION", "ADD_SNAPSHOTS", "DELETE_SNAPSHOTS", "EDIT_CAPACITY_PLAN", "VIEW_PROJECT_PORTFOLIO", "EDIT_PROJECT_PORTFOLIO", "ADD_FOLDER", "EDIT_FOLDER", "DELETE_FOLDER", "ADD_DOCUMENT", "EDIT_DOCUMENT", "DELETE_DOCUMENT", "DOWNLOAD_DOCUMENT", "DOCUMENT_ADMINISTRATOR", "ADD_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "EDIT_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "VIEW_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "DELETE_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "REPORT_ADMINISTRATOR", "EDIT_REPORT", "DELETE_REPORT", "IMPORT_P6XML", "SYNC_RESOURCE_ROLE" ]
Nested Schema : userProducts
Nested Schema : userSettings
Nested Schema : UserProduct
Type:
object
- applicationUser
-
Type:
object
ApplicationUser - createDate
-
Type:
string
(date-time
) - createOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- createUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- name
-
Type:
string
- overlayObject
-
Type:
boolean
Default Value:false
- primaryKey
-
Type:
integer
(int64
) - privileges
-
Type:
array
privileges - product
-
Type:
object
Product - snapshotObject
-
Type:
boolean
Default Value:false
- updateDate
-
Type:
string
(date-time
) - updateOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- updateUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- userProductId
-
Type:
integer
(int64
)
Nested Schema : privileges
Type:
array
-
Type:
string
Allowed Values:[ "ALL", "VIEW", "CREATE", "DELETE", "UPDATE", "VIEW_COST", "UPDATE_COST", "APPLICATION_ADMINISTRATOR", "ASSIGN_PROXY_USERS", "ADMINISTER_WORKFLOW_INSTANCES", "APP_SETTINGS", "INTEGRATION", "EDIT_PERFORMANCE_DASHBOARDS", "ADD_WORKSPACE", "EDIT_WORKSPACE", "DELETE_WORKSPACE", "EDIT_ANALYSIS_VIEWS", "ADD_FIELDS", "EDIT_FIELDS", "EDIT_STANDARD_FIELDS", "EDIT_LOCATIONS", "ADD_CODE", "EDIT_CODE", "DELETE_CODE", "ADD_CURVE", "EDIT_CURVE", "DELETE_CURVE", "ADD_RULES_OF_CREDIT", "EDIT_RULES_OF_CREDIT", "DELETE_RULES_OF_CREDIT", "START_WORKFLOWS", "ADD_WORKFLOW_DESIGN", "DELETE_WORKFLOW_DESIGN", "EDIT_WORKFLOW_DESIGN", "VIEW_WORKFLOW_DESIGN", "ADD_WORKFLOW_CONFIG", "DELETE_WORKFLOW_CONFIG", "EDIT_WORKFLOW_CONFIG", "VIEW_WORKFLOW_CONFIG", "ADD_FORMS", "DELETE_FORMS", "EDIT_FORMS", "VIEW_FORMS", "ADD_CAPITAL_PORTFOLIOS", "ADD_PROJECT", "ADD_PROJECT_PROPOSALS", "PROMOTE_REPORT", "ADD_SECURITY_GROUPS", "EDIT_SECURITY_GROUPS", "DELETE_SECURITY_GROUPS", "SECURITY_PROFILE", "WORKSPACE_ADMINISTRATOR", "ADD_CBS_CODES", "EDIT_CBS_CODES", "DELETE_CBS_CODES", "ADD_UNITS_OF_MEASURE", "EDIT_UNITS_OF_MEASURE", "DELETE_UNITS_OF_MEASURE", "ADD_REASONS", "EDIT_REASONS", "DELETE_REASONS", "ADD_WORKSPACE_COST_SHEET", "EDIT_WORKSPACE_COST_SHEET", "AGGREGATE_COST_DATA", "ADD_CALENDARS", "EDIT_CALENDARS", "DELETE_CALENDARS", "ADD_RESOURCES", "EDIT_RESOURCES", "DELETE_RESOURCES", "ADD_ROLES", "EDIT_ROLES", "DELETE_ROLES", "ADD_WORKSPACE_ACTIVITY_LAYOUTS", "EDIT_WORKSPACE_ACTIVITY_LAYOUTS", "DELETE_WORKSPACE_ACTIVITY_LAYOUTS", "MODIFY_WORKSPACE_DASHBOARDS", "ADD_INSIGHTS", "EDIT_INSIGHTS", "DELETE_INSIGHTS", "RISK_THRESHOLDS", "MODIFY_COMPANY", "RISK_MATRICES", "ADD_CURRENCY", "EDIT_CURRENCY", "DELETE_CURRENCY", "ADD_REPROT_CYCLE", "EDIT_REPORT_CYCLE", "DELETE_REPORT_CYCLE", "ADD_COST_CATEGORIES", "EDIT_COST_CATEGORIES", "DELETE_COST_CATEGORIES", "ADD_MEASURES", "EDIT_MEASURES", "DELETE_MEASURES", "ADD_CATEGORIES", "EDIT_CATEGORIES", "DELETE_CATEGORIES", "ADD_STRATEGY_TYPES", "EDIT_STRATEGY_TYPES", "DELETE_STRATEGY_TYPES", "ADD_WORKSPACE_FUND", "EDIT_WORKSPACE_FUND", "DELETE_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND_COSTS", "EDIT_WORKSPACE_FUND_COSTS", "VIEW_STRATEGIES", "ADD_STRATEGIES", "EDIT_STRATEGIES", "DELETE_STRATEGIES", "TEMPLATE_PROJECT", "PROJECT_ADMINISTRATOR", "EDIT_PROJECT", "DELETE_PROJECT", "EDIT_WORKSPACE_COST_UDFS", "VIEW_WORKSPACE_COST_UDFS", "EDIT_PROJECT_WBS_COSTS", "VIEW_PROJECT_WBS_COSTS", "ACCEPT_BUDGET_REQUEST_CHANGES", "PROJECT_BASELINES_SNAPSHOTS", "ENABLE_PROJECT_SCHEDULE", "ENABLE_PROJECT_LEVEL", "ENABLE_PROJECT_RISK_ANALYSIS", "DOCUMENTS", "EDIT_PROJECT_PROPOSALS", "DELETE_PROJECT_PROPOSALS", "EDIT_PROJECT_PROPOSALS_COSTS", "ADD_WBS", "EDIT_WBS", "DELETE_WBS", "ADD_PBS", "EDIT_PBS", "DELETE_PBS", "ADD_ACTIVITY", "EDIT_ACTIVITY", "DELETE_ACTIVITY", "ADD_RESOURCE_ASSIGNMENT", "EDIT_RESOURCE_ASSIGNMENT", "DELETE_RESOURCE_ASSIGNMENT", "ADD_WORK_PACKAGE", "EDIT_WORK_PACKAGE", "DELETE_WORK_PACKAGE", "ADD_SCOPE_ITEM", "EDIT_SCOPE_ITEM", "DELETE_SCOPE_ITEM", "VIEW_PROJECT_PBS_COSTS", "EDIT_PROJECT_PBS_COSTS", "ADD_SCOPE_ITEM_ASSIGNMENT", "EDIT_SCOPE_ITEM_ASSIGNMENT", "DELETE_SCOPE_ITEM_ASSIGNMENT", "ADD_SCOPE_CHANGE_REQUEST", "EDIT_SCOPE_CHANGE_REQUEST", "DELETE_SCOPE_CHANGE_REQUEST", "APPROVE_REJECT_SCOPE_CHANGE_REQUEST", "SET_PROJECT_BASELINE", "RESET_PROJECT_BASELINE", "ENABLE_PROJECT_INTEGRATION", "ADD_COST_SHEET_CODES", "EDIT_COST_SHEET_CODES", "DELETE_COST_SHEET_CODES", "ADD_PROJECT_ACTIVITY_LAYOUTS", "EDIT_PROJECT_ACTIVITY_LAYOUTS", "DELETE_PROJECT_ACTIVITY_LAYOUTS", "ADD_ACTIVITY_RELATIONSHIPS", "EDIT_ACTIVITY_RELATIONSHIPS", "DELETE_ACTIVITY_RELATIONSHIPS", "MODIFY_RISK_REGISTER", "ADD_RISK_REGISTER", "DELETE_RISK_REGISTER", "ADD_PROJECT_RISK_MATRIX", "DELETE_PROJECT_RISK_MATRIX", "MODIFY_PROJECT_RISK_MATRIX", "EDIT_PROJECT_CURRENCY", "VIEW_RISK_REGISTER", "MODIFY_ALERTS_THRESHOLDS", "MODIFY_PROJECT_DASHBOARDS", "ADD_PROJECT_RESOURCES", "EDIT_PROJECT_RESOURCES", "DELETE_PROJECT_RESOURCES", "ADD_PROJECT_ROLES", "EDIT_PROJECT_ROLES", "DELETE_PROJECT_ROLES", "VIEW_MANUAL_BUDGET", "ADD_MANUAL_BUDGET", "EDIT_MANUAL_BUDGET", "DELETE_MANUAL_BUDGET", "VIEW_PROJECT_ACTUALS", "ADD_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS", "DELETE_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS_COSTS", "VIEW_PROJECT_ACTUALS_COSTS", "VIEW_CONTRACT", "ADD_CONTRACT", "EDIT_CONTRACT", "DELETE_CONTRACT", "ADD_DEMAND", "EDIT_DEMAND", "DELETE_DEMAND", "EDIT_CONTRACT_COSTS", "VIEW_CONTRACT_COSTS", "VIEW_CONTRACT_BUDGET", "ADD_CONTRACT_BUDGET", "EDIT_CONTRACT_BUDGET", "DELETE_CONTRACT_BUDGET", "VIEW_COMMITMENT", "ADD_COMMITMENT", "EDIT_COMMITMENT", "DELETE_COMMITMENT", "EDIT_COMMITMENT_COSTS", "VIEW_COMMITMENT_COSTS", "VIEW_COMMITMENT_CHANGE_ORDERS", "EDIT_COMMITMENT_CHANGE_ORDERS", "ADD_COMMITMENT_CHANGE_ORDERS", "VIEW_CONTRACT_CHANGE_ORDERS", "EDIT_CONTRACT_CHANGE_ORDERS", "ADD_CONTRACT_CHANGE_ORDERS", "CLOSE_REPORTING_PERIOD", "PROJECT_INTEGRATION_CREATE", "PROJECT_INTEGRATION_DELETE", "ADD_PROJECT_SECURITY_GROUPS", "EDIT_PROJECT_SECURITY_GROUPS", "DELETE_PROJECT_SECURITY_GROUPS", "ADD_PROJECT_FUND", "EDIT_PROJECT_FUND", "DELETE_PROJECT_FUND", "VIEW_PROJECT_FUND", "VIEW_PROJECT_FUND_COSTS", "EDIT_PROJECT_FUND_COSTS", "ADD_LEAN_TASK", "EDIT_LEAN_TASK", "DELETE_LEAN_TASK", "ADD_LEAN_TASK_USER_COMPANY", "EDIT_LEAN_TASK_USER_COMPANY", "DELETE_LEAN_TASK_USER_COMPANY", "COMPLETE_COMMIT_LEAN_TASK", "COMPLETE_COMMIT_LEAN_TASK_USER_TASK", "EDIT_PROJECT_COMPANY", "CAPITAL_PORTFOLIO_PLAN_ADMINISTRATOR", "MODIFY_PORTFOLIO_DASHBOARDS", "EDIT_CAPITAL_PORTFOLIO", "DELETE_CAPITAL_PORTFOLIO", "EDIT_CAPITAL_PORTFOLIO_COSTS", "VIEW_CAPITAL_PORTFOLIO_COSTS", "ADD_CAPITAL_PLAN", "EDIT_CAPITAL_PLAN", "DELETE_CAPITAL_PLAN", "ASSIGN_WORKFLOWS_CAPITAL_PLAN_ACTIONS", "ADD_CAPITAL_PLAN_TARGETS", "EDIT_CAPITAL_PLAN_TARGETS", "DELETE_CAPITAL_PLAN_TARGETS", "ADD_CAPITAL_PLAN_THRESHOLDS", "EDIT_CAPITAL_PLAN_THRESHOLDS", "DELETE_CAPITAL_PLAN_THRESHOLDS", "ADD_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_SCENARIOS", "DELETE_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_COSTS", "VIEW_CAPITAL_PLAN_COSTS", "SEND_CAPITAL_PLAN_SCENARIO_REVIEW", "SHARE_CAPITAL_PLAN_SCENARIO", "SEND_CAPITAL_PLAN_SCENARIO_APPROVAL", "APPROVE_CAPITAL_PLAN_SCENARIO", "ASSIGN_ANALYSIS_VIEWS_NAVIGATION", "ADD_SNAPSHOTS", "DELETE_SNAPSHOTS", "EDIT_CAPACITY_PLAN", "VIEW_PROJECT_PORTFOLIO", "EDIT_PROJECT_PORTFOLIO", "ADD_FOLDER", "EDIT_FOLDER", "DELETE_FOLDER", "ADD_DOCUMENT", "EDIT_DOCUMENT", "DELETE_DOCUMENT", "DOWNLOAD_DOCUMENT", "DOCUMENT_ADMINISTRATOR", "ADD_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "EDIT_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "VIEW_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "DELETE_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "REPORT_ADMINISTRATOR", "EDIT_REPORT", "DELETE_REPORT", "IMPORT_P6XML", "SYNC_RESOURCE_ROLE" ]
Nested Schema : Product
Type:
object
- createDate
-
Type:
string
(date-time
) - createOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- createUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- enabled
-
Type:
boolean
Required:true
Default Value:false
- name
-
Type:
string
- overlayObject
-
Type:
boolean
Default Value:false
- primaryKey
-
Type:
integer
(int64
) - privileges
-
Type:
array
privileges - productId
-
Type:
integer
(int64
)Required:true
- productName
-
Type:
string
Required:true
Allowed Values:[ "PROJECT", "PORTFOLIO", "PROGRESS", "CONTRACT" ]
- purchasedCount
-
Type:
integer
(int32
)Minimum Value:0
- snapshotObject
-
Type:
boolean
Default Value:false
- updateDate
-
Type:
string
(date-time
) - updateOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- updateUser
-
Type:
string
Minimum Length:0
Maximum Length:255
Nested Schema : privileges
Type:
array
-
Type:
string
Allowed Values:[ "ALL", "VIEW", "CREATE", "DELETE", "UPDATE", "VIEW_COST", "UPDATE_COST", "APPLICATION_ADMINISTRATOR", "ASSIGN_PROXY_USERS", "ADMINISTER_WORKFLOW_INSTANCES", "APP_SETTINGS", "INTEGRATION", "EDIT_PERFORMANCE_DASHBOARDS", "ADD_WORKSPACE", "EDIT_WORKSPACE", "DELETE_WORKSPACE", "EDIT_ANALYSIS_VIEWS", "ADD_FIELDS", "EDIT_FIELDS", "EDIT_STANDARD_FIELDS", "EDIT_LOCATIONS", "ADD_CODE", "EDIT_CODE", "DELETE_CODE", "ADD_CURVE", "EDIT_CURVE", "DELETE_CURVE", "ADD_RULES_OF_CREDIT", "EDIT_RULES_OF_CREDIT", "DELETE_RULES_OF_CREDIT", "START_WORKFLOWS", "ADD_WORKFLOW_DESIGN", "DELETE_WORKFLOW_DESIGN", "EDIT_WORKFLOW_DESIGN", "VIEW_WORKFLOW_DESIGN", "ADD_WORKFLOW_CONFIG", "DELETE_WORKFLOW_CONFIG", "EDIT_WORKFLOW_CONFIG", "VIEW_WORKFLOW_CONFIG", "ADD_FORMS", "DELETE_FORMS", "EDIT_FORMS", "VIEW_FORMS", "ADD_CAPITAL_PORTFOLIOS", "ADD_PROJECT", "ADD_PROJECT_PROPOSALS", "PROMOTE_REPORT", "ADD_SECURITY_GROUPS", "EDIT_SECURITY_GROUPS", "DELETE_SECURITY_GROUPS", "SECURITY_PROFILE", "WORKSPACE_ADMINISTRATOR", "ADD_CBS_CODES", "EDIT_CBS_CODES", "DELETE_CBS_CODES", "ADD_UNITS_OF_MEASURE", "EDIT_UNITS_OF_MEASURE", "DELETE_UNITS_OF_MEASURE", "ADD_REASONS", "EDIT_REASONS", "DELETE_REASONS", "ADD_WORKSPACE_COST_SHEET", "EDIT_WORKSPACE_COST_SHEET", "AGGREGATE_COST_DATA", "ADD_CALENDARS", "EDIT_CALENDARS", "DELETE_CALENDARS", "ADD_RESOURCES", "EDIT_RESOURCES", "DELETE_RESOURCES", "ADD_ROLES", "EDIT_ROLES", "DELETE_ROLES", "ADD_WORKSPACE_ACTIVITY_LAYOUTS", "EDIT_WORKSPACE_ACTIVITY_LAYOUTS", "DELETE_WORKSPACE_ACTIVITY_LAYOUTS", "MODIFY_WORKSPACE_DASHBOARDS", "ADD_INSIGHTS", "EDIT_INSIGHTS", "DELETE_INSIGHTS", "RISK_THRESHOLDS", "MODIFY_COMPANY", "RISK_MATRICES", "ADD_CURRENCY", "EDIT_CURRENCY", "DELETE_CURRENCY", "ADD_REPROT_CYCLE", "EDIT_REPORT_CYCLE", "DELETE_REPORT_CYCLE", "ADD_COST_CATEGORIES", "EDIT_COST_CATEGORIES", "DELETE_COST_CATEGORIES", "ADD_MEASURES", "EDIT_MEASURES", "DELETE_MEASURES", "ADD_CATEGORIES", "EDIT_CATEGORIES", "DELETE_CATEGORIES", "ADD_STRATEGY_TYPES", "EDIT_STRATEGY_TYPES", "DELETE_STRATEGY_TYPES", "ADD_WORKSPACE_FUND", "EDIT_WORKSPACE_FUND", "DELETE_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND_COSTS", "EDIT_WORKSPACE_FUND_COSTS", "VIEW_STRATEGIES", "ADD_STRATEGIES", "EDIT_STRATEGIES", "DELETE_STRATEGIES", "TEMPLATE_PROJECT", "PROJECT_ADMINISTRATOR", "EDIT_PROJECT", "DELETE_PROJECT", "EDIT_WORKSPACE_COST_UDFS", "VIEW_WORKSPACE_COST_UDFS", "EDIT_PROJECT_WBS_COSTS", "VIEW_PROJECT_WBS_COSTS", "ACCEPT_BUDGET_REQUEST_CHANGES", "PROJECT_BASELINES_SNAPSHOTS", "ENABLE_PROJECT_SCHEDULE", "ENABLE_PROJECT_LEVEL", "ENABLE_PROJECT_RISK_ANALYSIS", "DOCUMENTS", "EDIT_PROJECT_PROPOSALS", "DELETE_PROJECT_PROPOSALS", "EDIT_PROJECT_PROPOSALS_COSTS", "ADD_WBS", "EDIT_WBS", "DELETE_WBS", "ADD_PBS", "EDIT_PBS", "DELETE_PBS", "ADD_ACTIVITY", "EDIT_ACTIVITY", "DELETE_ACTIVITY", "ADD_RESOURCE_ASSIGNMENT", "EDIT_RESOURCE_ASSIGNMENT", "DELETE_RESOURCE_ASSIGNMENT", "ADD_WORK_PACKAGE", "EDIT_WORK_PACKAGE", "DELETE_WORK_PACKAGE", "ADD_SCOPE_ITEM", "EDIT_SCOPE_ITEM", "DELETE_SCOPE_ITEM", "VIEW_PROJECT_PBS_COSTS", "EDIT_PROJECT_PBS_COSTS", "ADD_SCOPE_ITEM_ASSIGNMENT", "EDIT_SCOPE_ITEM_ASSIGNMENT", "DELETE_SCOPE_ITEM_ASSIGNMENT", "ADD_SCOPE_CHANGE_REQUEST", "EDIT_SCOPE_CHANGE_REQUEST", "DELETE_SCOPE_CHANGE_REQUEST", "APPROVE_REJECT_SCOPE_CHANGE_REQUEST", "SET_PROJECT_BASELINE", "RESET_PROJECT_BASELINE", "ENABLE_PROJECT_INTEGRATION", "ADD_COST_SHEET_CODES", "EDIT_COST_SHEET_CODES", "DELETE_COST_SHEET_CODES", "ADD_PROJECT_ACTIVITY_LAYOUTS", "EDIT_PROJECT_ACTIVITY_LAYOUTS", "DELETE_PROJECT_ACTIVITY_LAYOUTS", "ADD_ACTIVITY_RELATIONSHIPS", "EDIT_ACTIVITY_RELATIONSHIPS", "DELETE_ACTIVITY_RELATIONSHIPS", "MODIFY_RISK_REGISTER", "ADD_RISK_REGISTER", "DELETE_RISK_REGISTER", "ADD_PROJECT_RISK_MATRIX", "DELETE_PROJECT_RISK_MATRIX", "MODIFY_PROJECT_RISK_MATRIX", "EDIT_PROJECT_CURRENCY", "VIEW_RISK_REGISTER", "MODIFY_ALERTS_THRESHOLDS", "MODIFY_PROJECT_DASHBOARDS", "ADD_PROJECT_RESOURCES", "EDIT_PROJECT_RESOURCES", "DELETE_PROJECT_RESOURCES", "ADD_PROJECT_ROLES", "EDIT_PROJECT_ROLES", "DELETE_PROJECT_ROLES", "VIEW_MANUAL_BUDGET", "ADD_MANUAL_BUDGET", "EDIT_MANUAL_BUDGET", "DELETE_MANUAL_BUDGET", "VIEW_PROJECT_ACTUALS", "ADD_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS", "DELETE_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS_COSTS", "VIEW_PROJECT_ACTUALS_COSTS", "VIEW_CONTRACT", "ADD_CONTRACT", "EDIT_CONTRACT", "DELETE_CONTRACT", "ADD_DEMAND", "EDIT_DEMAND", "DELETE_DEMAND", "EDIT_CONTRACT_COSTS", "VIEW_CONTRACT_COSTS", "VIEW_CONTRACT_BUDGET", "ADD_CONTRACT_BUDGET", "EDIT_CONTRACT_BUDGET", "DELETE_CONTRACT_BUDGET", "VIEW_COMMITMENT", "ADD_COMMITMENT", "EDIT_COMMITMENT", "DELETE_COMMITMENT", "EDIT_COMMITMENT_COSTS", "VIEW_COMMITMENT_COSTS", "VIEW_COMMITMENT_CHANGE_ORDERS", "EDIT_COMMITMENT_CHANGE_ORDERS", "ADD_COMMITMENT_CHANGE_ORDERS", "VIEW_CONTRACT_CHANGE_ORDERS", "EDIT_CONTRACT_CHANGE_ORDERS", "ADD_CONTRACT_CHANGE_ORDERS", "CLOSE_REPORTING_PERIOD", "PROJECT_INTEGRATION_CREATE", "PROJECT_INTEGRATION_DELETE", "ADD_PROJECT_SECURITY_GROUPS", "EDIT_PROJECT_SECURITY_GROUPS", "DELETE_PROJECT_SECURITY_GROUPS", "ADD_PROJECT_FUND", "EDIT_PROJECT_FUND", "DELETE_PROJECT_FUND", "VIEW_PROJECT_FUND", "VIEW_PROJECT_FUND_COSTS", "EDIT_PROJECT_FUND_COSTS", "ADD_LEAN_TASK", "EDIT_LEAN_TASK", "DELETE_LEAN_TASK", "ADD_LEAN_TASK_USER_COMPANY", "EDIT_LEAN_TASK_USER_COMPANY", "DELETE_LEAN_TASK_USER_COMPANY", "COMPLETE_COMMIT_LEAN_TASK", "COMPLETE_COMMIT_LEAN_TASK_USER_TASK", "EDIT_PROJECT_COMPANY", "CAPITAL_PORTFOLIO_PLAN_ADMINISTRATOR", "MODIFY_PORTFOLIO_DASHBOARDS", "EDIT_CAPITAL_PORTFOLIO", "DELETE_CAPITAL_PORTFOLIO", "EDIT_CAPITAL_PORTFOLIO_COSTS", "VIEW_CAPITAL_PORTFOLIO_COSTS", "ADD_CAPITAL_PLAN", "EDIT_CAPITAL_PLAN", "DELETE_CAPITAL_PLAN", "ASSIGN_WORKFLOWS_CAPITAL_PLAN_ACTIONS", "ADD_CAPITAL_PLAN_TARGETS", "EDIT_CAPITAL_PLAN_TARGETS", "DELETE_CAPITAL_PLAN_TARGETS", "ADD_CAPITAL_PLAN_THRESHOLDS", "EDIT_CAPITAL_PLAN_THRESHOLDS", "DELETE_CAPITAL_PLAN_THRESHOLDS", "ADD_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_SCENARIOS", "DELETE_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_COSTS", "VIEW_CAPITAL_PLAN_COSTS", "SEND_CAPITAL_PLAN_SCENARIO_REVIEW", "SHARE_CAPITAL_PLAN_SCENARIO", "SEND_CAPITAL_PLAN_SCENARIO_APPROVAL", "APPROVE_CAPITAL_PLAN_SCENARIO", "ASSIGN_ANALYSIS_VIEWS_NAVIGATION", "ADD_SNAPSHOTS", "DELETE_SNAPSHOTS", "EDIT_CAPACITY_PLAN", "VIEW_PROJECT_PORTFOLIO", "EDIT_PROJECT_PORTFOLIO", "ADD_FOLDER", "EDIT_FOLDER", "DELETE_FOLDER", "ADD_DOCUMENT", "EDIT_DOCUMENT", "DELETE_DOCUMENT", "DOWNLOAD_DOCUMENT", "DOCUMENT_ADMINISTRATOR", "ADD_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "EDIT_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "VIEW_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "DELETE_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "REPORT_ADMINISTRATOR", "EDIT_REPORT", "DELETE_REPORT", "IMPORT_P6XML", "SYNC_RESOURCE_ROLE" ]
Nested Schema : ApplicationUserSetting
Type:
object
- applicationUser
-
Type:
object
ApplicationUser - applicationUserSettingId
-
Type:
integer
(int64
) - createDate
-
Type:
string
(date-time
) - createOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- createUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- name
-
Type:
string
- namespace
-
Type:
string
- overlayObject
-
Type:
boolean
Default Value:false
- primaryKey
-
Type:
integer
(int64
) - privileges
-
Type:
array
privileges - settingName
-
Type:
string
Allowed Values:[ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "MostRecentLocale", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectPortfolio", "SearchProjectCodes", "SearchCapitalPlans", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions" ]
- settingValue
-
Type:
string
- snapshotObject
-
Type:
boolean
Default Value:false
- updateDate
-
Type:
string
(date-time
) - updateOnBehalfOfUser
-
Type:
string
Minimum Length:0
Maximum Length:255
- updateUser
-
Type:
string
Minimum Length:0
Maximum Length:255
Nested Schema : privileges
Type:
array
-
Type:
string
Allowed Values:[ "ALL", "VIEW", "CREATE", "DELETE", "UPDATE", "VIEW_COST", "UPDATE_COST", "APPLICATION_ADMINISTRATOR", "ASSIGN_PROXY_USERS", "ADMINISTER_WORKFLOW_INSTANCES", "APP_SETTINGS", "INTEGRATION", "EDIT_PERFORMANCE_DASHBOARDS", "ADD_WORKSPACE", "EDIT_WORKSPACE", "DELETE_WORKSPACE", "EDIT_ANALYSIS_VIEWS", "ADD_FIELDS", "EDIT_FIELDS", "EDIT_STANDARD_FIELDS", "EDIT_LOCATIONS", "ADD_CODE", "EDIT_CODE", "DELETE_CODE", "ADD_CURVE", "EDIT_CURVE", "DELETE_CURVE", "ADD_RULES_OF_CREDIT", "EDIT_RULES_OF_CREDIT", "DELETE_RULES_OF_CREDIT", "START_WORKFLOWS", "ADD_WORKFLOW_DESIGN", "DELETE_WORKFLOW_DESIGN", "EDIT_WORKFLOW_DESIGN", "VIEW_WORKFLOW_DESIGN", "ADD_WORKFLOW_CONFIG", "DELETE_WORKFLOW_CONFIG", "EDIT_WORKFLOW_CONFIG", "VIEW_WORKFLOW_CONFIG", "ADD_FORMS", "DELETE_FORMS", "EDIT_FORMS", "VIEW_FORMS", "ADD_CAPITAL_PORTFOLIOS", "ADD_PROJECT", "ADD_PROJECT_PROPOSALS", "PROMOTE_REPORT", "ADD_SECURITY_GROUPS", "EDIT_SECURITY_GROUPS", "DELETE_SECURITY_GROUPS", "SECURITY_PROFILE", "WORKSPACE_ADMINISTRATOR", "ADD_CBS_CODES", "EDIT_CBS_CODES", "DELETE_CBS_CODES", "ADD_UNITS_OF_MEASURE", "EDIT_UNITS_OF_MEASURE", "DELETE_UNITS_OF_MEASURE", "ADD_REASONS", "EDIT_REASONS", "DELETE_REASONS", "ADD_WORKSPACE_COST_SHEET", "EDIT_WORKSPACE_COST_SHEET", "AGGREGATE_COST_DATA", "ADD_CALENDARS", "EDIT_CALENDARS", "DELETE_CALENDARS", "ADD_RESOURCES", "EDIT_RESOURCES", "DELETE_RESOURCES", "ADD_ROLES", "EDIT_ROLES", "DELETE_ROLES", "ADD_WORKSPACE_ACTIVITY_LAYOUTS", "EDIT_WORKSPACE_ACTIVITY_LAYOUTS", "DELETE_WORKSPACE_ACTIVITY_LAYOUTS", "MODIFY_WORKSPACE_DASHBOARDS", "ADD_INSIGHTS", "EDIT_INSIGHTS", "DELETE_INSIGHTS", "RISK_THRESHOLDS", "MODIFY_COMPANY", "RISK_MATRICES", "ADD_CURRENCY", "EDIT_CURRENCY", "DELETE_CURRENCY", "ADD_REPROT_CYCLE", "EDIT_REPORT_CYCLE", "DELETE_REPORT_CYCLE", "ADD_COST_CATEGORIES", "EDIT_COST_CATEGORIES", "DELETE_COST_CATEGORIES", "ADD_MEASURES", "EDIT_MEASURES", "DELETE_MEASURES", "ADD_CATEGORIES", "EDIT_CATEGORIES", "DELETE_CATEGORIES", "ADD_STRATEGY_TYPES", "EDIT_STRATEGY_TYPES", "DELETE_STRATEGY_TYPES", "ADD_WORKSPACE_FUND", "EDIT_WORKSPACE_FUND", "DELETE_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND", "VIEW_WORKSPACE_FUND_COSTS", "EDIT_WORKSPACE_FUND_COSTS", "VIEW_STRATEGIES", "ADD_STRATEGIES", "EDIT_STRATEGIES", "DELETE_STRATEGIES", "TEMPLATE_PROJECT", "PROJECT_ADMINISTRATOR", "EDIT_PROJECT", "DELETE_PROJECT", "EDIT_WORKSPACE_COST_UDFS", "VIEW_WORKSPACE_COST_UDFS", "EDIT_PROJECT_WBS_COSTS", "VIEW_PROJECT_WBS_COSTS", "ACCEPT_BUDGET_REQUEST_CHANGES", "PROJECT_BASELINES_SNAPSHOTS", "ENABLE_PROJECT_SCHEDULE", "ENABLE_PROJECT_LEVEL", "ENABLE_PROJECT_RISK_ANALYSIS", "DOCUMENTS", "EDIT_PROJECT_PROPOSALS", "DELETE_PROJECT_PROPOSALS", "EDIT_PROJECT_PROPOSALS_COSTS", "ADD_WBS", "EDIT_WBS", "DELETE_WBS", "ADD_PBS", "EDIT_PBS", "DELETE_PBS", "ADD_ACTIVITY", "EDIT_ACTIVITY", "DELETE_ACTIVITY", "ADD_RESOURCE_ASSIGNMENT", "EDIT_RESOURCE_ASSIGNMENT", "DELETE_RESOURCE_ASSIGNMENT", "ADD_WORK_PACKAGE", "EDIT_WORK_PACKAGE", "DELETE_WORK_PACKAGE", "ADD_SCOPE_ITEM", "EDIT_SCOPE_ITEM", "DELETE_SCOPE_ITEM", "VIEW_PROJECT_PBS_COSTS", "EDIT_PROJECT_PBS_COSTS", "ADD_SCOPE_ITEM_ASSIGNMENT", "EDIT_SCOPE_ITEM_ASSIGNMENT", "DELETE_SCOPE_ITEM_ASSIGNMENT", "ADD_SCOPE_CHANGE_REQUEST", "EDIT_SCOPE_CHANGE_REQUEST", "DELETE_SCOPE_CHANGE_REQUEST", "APPROVE_REJECT_SCOPE_CHANGE_REQUEST", "SET_PROJECT_BASELINE", "RESET_PROJECT_BASELINE", "ENABLE_PROJECT_INTEGRATION", "ADD_COST_SHEET_CODES", "EDIT_COST_SHEET_CODES", "DELETE_COST_SHEET_CODES", "ADD_PROJECT_ACTIVITY_LAYOUTS", "EDIT_PROJECT_ACTIVITY_LAYOUTS", "DELETE_PROJECT_ACTIVITY_LAYOUTS", "ADD_ACTIVITY_RELATIONSHIPS", "EDIT_ACTIVITY_RELATIONSHIPS", "DELETE_ACTIVITY_RELATIONSHIPS", "MODIFY_RISK_REGISTER", "ADD_RISK_REGISTER", "DELETE_RISK_REGISTER", "ADD_PROJECT_RISK_MATRIX", "DELETE_PROJECT_RISK_MATRIX", "MODIFY_PROJECT_RISK_MATRIX", "EDIT_PROJECT_CURRENCY", "VIEW_RISK_REGISTER", "MODIFY_ALERTS_THRESHOLDS", "MODIFY_PROJECT_DASHBOARDS", "ADD_PROJECT_RESOURCES", "EDIT_PROJECT_RESOURCES", "DELETE_PROJECT_RESOURCES", "ADD_PROJECT_ROLES", "EDIT_PROJECT_ROLES", "DELETE_PROJECT_ROLES", "VIEW_MANUAL_BUDGET", "ADD_MANUAL_BUDGET", "EDIT_MANUAL_BUDGET", "DELETE_MANUAL_BUDGET", "VIEW_PROJECT_ACTUALS", "ADD_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS", "DELETE_PROJECT_ACTUALS", "EDIT_PROJECT_ACTUALS_COSTS", "VIEW_PROJECT_ACTUALS_COSTS", "VIEW_CONTRACT", "ADD_CONTRACT", "EDIT_CONTRACT", "DELETE_CONTRACT", "ADD_DEMAND", "EDIT_DEMAND", "DELETE_DEMAND", "EDIT_CONTRACT_COSTS", "VIEW_CONTRACT_COSTS", "VIEW_CONTRACT_BUDGET", "ADD_CONTRACT_BUDGET", "EDIT_CONTRACT_BUDGET", "DELETE_CONTRACT_BUDGET", "VIEW_COMMITMENT", "ADD_COMMITMENT", "EDIT_COMMITMENT", "DELETE_COMMITMENT", "EDIT_COMMITMENT_COSTS", "VIEW_COMMITMENT_COSTS", "VIEW_COMMITMENT_CHANGE_ORDERS", "EDIT_COMMITMENT_CHANGE_ORDERS", "ADD_COMMITMENT_CHANGE_ORDERS", "VIEW_CONTRACT_CHANGE_ORDERS", "EDIT_CONTRACT_CHANGE_ORDERS", "ADD_CONTRACT_CHANGE_ORDERS", "CLOSE_REPORTING_PERIOD", "PROJECT_INTEGRATION_CREATE", "PROJECT_INTEGRATION_DELETE", "ADD_PROJECT_SECURITY_GROUPS", "EDIT_PROJECT_SECURITY_GROUPS", "DELETE_PROJECT_SECURITY_GROUPS", "ADD_PROJECT_FUND", "EDIT_PROJECT_FUND", "DELETE_PROJECT_FUND", "VIEW_PROJECT_FUND", "VIEW_PROJECT_FUND_COSTS", "EDIT_PROJECT_FUND_COSTS", "ADD_LEAN_TASK", "EDIT_LEAN_TASK", "DELETE_LEAN_TASK", "ADD_LEAN_TASK_USER_COMPANY", "EDIT_LEAN_TASK_USER_COMPANY", "DELETE_LEAN_TASK_USER_COMPANY", "COMPLETE_COMMIT_LEAN_TASK", "COMPLETE_COMMIT_LEAN_TASK_USER_TASK", "EDIT_PROJECT_COMPANY", "CAPITAL_PORTFOLIO_PLAN_ADMINISTRATOR", "MODIFY_PORTFOLIO_DASHBOARDS", "EDIT_CAPITAL_PORTFOLIO", "DELETE_CAPITAL_PORTFOLIO", "EDIT_CAPITAL_PORTFOLIO_COSTS", "VIEW_CAPITAL_PORTFOLIO_COSTS", "ADD_CAPITAL_PLAN", "EDIT_CAPITAL_PLAN", "DELETE_CAPITAL_PLAN", "ASSIGN_WORKFLOWS_CAPITAL_PLAN_ACTIONS", "ADD_CAPITAL_PLAN_TARGETS", "EDIT_CAPITAL_PLAN_TARGETS", "DELETE_CAPITAL_PLAN_TARGETS", "ADD_CAPITAL_PLAN_THRESHOLDS", "EDIT_CAPITAL_PLAN_THRESHOLDS", "DELETE_CAPITAL_PLAN_THRESHOLDS", "ADD_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_SCENARIOS", "DELETE_CAPITAL_PLAN_SCENARIOS", "EDIT_CAPITAL_PLAN_COSTS", "VIEW_CAPITAL_PLAN_COSTS", "SEND_CAPITAL_PLAN_SCENARIO_REVIEW", "SHARE_CAPITAL_PLAN_SCENARIO", "SEND_CAPITAL_PLAN_SCENARIO_APPROVAL", "APPROVE_CAPITAL_PLAN_SCENARIO", "ASSIGN_ANALYSIS_VIEWS_NAVIGATION", "ADD_SNAPSHOTS", "DELETE_SNAPSHOTS", "EDIT_CAPACITY_PLAN", "VIEW_PROJECT_PORTFOLIO", "EDIT_PROJECT_PORTFOLIO", "ADD_FOLDER", "EDIT_FOLDER", "DELETE_FOLDER", "ADD_DOCUMENT", "EDIT_DOCUMENT", "DELETE_DOCUMENT", "DOWNLOAD_DOCUMENT", "DOCUMENT_ADMINISTRATOR", "ADD_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "EDIT_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "VIEW_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "DELETE_DOCUMENT_FOLDER_STRUCTURE_TEMPLATE", "REPORT_ADMINISTRATOR", "EDIT_REPORT", "DELETE_REPORT", "IMPORT_P6XML", "SYNC_RESOURCE_ROLE" ]
Nested Schema : ApiEntityRiskImpact
Type:
object
- postRiskScoreThresholdCode
-
Type:
string
- postRiskScoreThresholdId
-
Type:
integer
(int64
)The unique identifier for the post response impact threshold. - projectName
-
Type:
string
- projectRisk
-
Type:
object
ApiEntityProjectRisk - projectRiskId
-
Type:
integer
(int64
)The unique identifier of the project to which the risk is assigned. - riskCode
-
Type:
string
- riskImpactId
-
Type:
integer
(int64
)A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the scoretype. - riskScoreThreshold
-
Type:
object
ApiEntityRiskScoreThreshold - riskScoreThresholdCode
-
Type:
string
- riskScoreThresholdId
-
Type:
integer
(int64
)The threshold of the risk score. - riskScoreType
-
Type:
object
ApiEntityRiskScoreType - riskScoreTypeId
-
Type:
integer
(int64
)The risk score type. - riskScoreTypeName
-
Type:
string
Nested Schema : ApiEntityRiskScoreThreshold
Type:
object
- color
-
Type:
string
The color that represents the urgency of the risk. - level
-
Type:
integer
(int32
)The level of the risk threshold. - lower
-
Type:
number
(double
)The lower limit of the risk score threshold range. - riskScoreThresholdCode
-
Type:
string
The unique identifier for the risk scoring threshold. - riskScoreThresholdId
-
Type:
integer
(int64
)The unique ID of the risk score threshold. - riskScoreThresholdName
-
Type:
string
The name of the risk threshold. - riskScoreType
-
Type:
object
ApiEntityRiskScoreType - riskScoreTypeId
-
Type:
integer
(int64
)The category to which the risk score belongs. - riskScoreTypeName
-
Type:
string
The name of the risk score type. - stringValue
-
Type:
string
The value of the string. - upper
-
Type:
number
(double
)The upper limit of the risk score threshold range.
Nested Schema : ApiEntityRiskScoreType
Type:
object
- riskScoreThresholds
-
Type:
array
riskScoreThresholdsUnique Items Required:true
- riskScoreTypeId
-
Type:
integer
(int64
) - riskScoreTypeName
-
Type:
string
- scoreType
-
Type:
string
Allowed Values:[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
- workspace
-
Type:
object
ApiEntityWorkspace - workspaceId
-
Type:
integer
(int64
)
Nested Schema : riskScoreThresholds
Nested Schema : ApiEntityWorkspace
Type:
object
- description
-
Type:
string
A summary of the workspace. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are useful in multi-user environments. - parentWorkspace
-
Type:
integer
(int64
)The workspace hierarchically above the child workspace. Parent workspaces can push down shared data to child workspaces. - securityGuid
-
Type:
string
The Globally Unique Identifier of the workspace. - sequenceNumber
-
Type:
integer
(int32
)Determines the order of appearance of workspaces in a list. - workspaceCode
-
Type:
string
The unique identifier for a workspace. - workspaceId
-
Type:
integer
(int64
)The unique identifier for the workspace. - workspaceName
-
Type:
string
The name of the workspace.
Nested Schema : Duration
Type:
object
- bigDecimal
-
Type:
number
- double
-
Type:
number
(double
)
Nested Schema : codeValuesProject
Type:
array
Unique Items Required:
true
Lists all project code types assigned to the project with its corresponding value.
-
Type:
object
ApiEntityCodeValueProject
Nested Schema : Percent
Type:
object
- bigDecimal
-
Type:
number
- double
-
Type:
number
(double
)
Nested Schema : projectCashFlows
Type:
array
Lists all project cost field spread data assigned to the project.
-
Type:
object
ApiEntityProjectCashFlow
Nested Schema : ApiEntityProjectCPFlexCost
Type:
object
- flexMap
-
Type:
object
flexMapAdditional Properties Allowed: additionalPropertiesLists all configured cost fields assigned to the project with its corresponding value as a (key,value) pair. - project
-
Type:
object
ApiEntityProject - projectId
-
Type:
integer
(int64
)
Nested Schema : ApiEntityProjectCPFlexOther
Type:
object
- flexMap
-
Type:
object
flexMapAdditional Properties Allowed: additionalPropertiesLists all configured date, number, integer fields assigned to the project with its corresponding value as a (key,value) pair. - project
-
Type:
object
ApiEntityProject - projectId
-
Type:
integer
(int64
)
Nested Schema : ApiEntityProjectCPFlexText
Type:
object
- flexMap
-
Type:
object
flexMapAdditional Properties Allowed: additionalPropertiesLists all configured text fields assigned to the project with its corresponding value as a (key,value) pair. - project
-
Type:
object
ApiEntityProject - projectId
-
Type:
integer
(int64
)
Nested Schema : ApiEntityProjectFinancial
Type:
object
- actualCost
-
Type:
object
Cost - annualDiscountRate
-
Type:
object
Percent - atCompletionCost
-
Type:
object
Cost - costPerfIndex
-
Type:
number
(double
)The measure of a project's cost efficiency. A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget. - costVariance
-
Type:
object
Cost - currentApprovedBudget
-
Type:
object
Cost - currentApprovedBudgetBaseDistributed
-
Type:
object
Cost - currentApprovedBudgetBaseUndistributed
-
Type:
object
Cost - currentApprovedSpendVariance
-
Type:
object
Cost - earnedValueCost
-
Type:
object
Cost - estAtCompleteCost
-
Type:
object
Cost - estToCompleteCost
-
Type:
object
Cost - forecastCost
-
Type:
object
Cost - forecastCostDistributed
-
Type:
object
Cost - forecastCostUndistributed
-
Type:
object
Cost - forecastCurrApprVar
-
Type:
object
Cost - intRateReturn
-
Type:
object
Percent - netPresentValue
-
Type:
object
Cost - paybackPeriod
-
Type:
number
(double
)The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project. - plannedBudget
-
Type:
object
Cost - plannedBudgetDistributed
-
Type:
object
Cost - plannedBudgetUndistributed
-
Type:
object
Cost - plannedValueCost
-
Type:
object
Cost - profitabilityIndex
-
Type:
number
(double
)The index based on the value of a project's present values divided by initial project investments. - project
-
Type:
object
ApiEntityProject - projectId
-
Type:
integer
(int64
) - proposedBudget
-
Type:
object
Cost - proposedBudgetBaseDistributed
-
Type:
object
Cost - proposedBudgetBaseUndistributed
-
Type:
object
Cost - proposedForecastVariance
-
Type:
object
Cost - proposedPlannedVar
-
Type:
object
Cost - remainingCost
-
Type:
object
Cost - returnInvestment
-
Type:
object
Percent - schedPerfIndex
-
Type:
number
(double
)The measure of the work accomplished as a percentage of the work scheduled on a project. Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule. A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the project is ahead of schedule. - scheduleVariance
-
Type:
object
Cost - spendCost
-
Type:
object
Cost - spendForecastVar
-
Type:
object
Cost - spendPlannedVariance
-
Type:
object
Cost - yearEndForecastCost
-
Type:
object
Cost - ytdSpendCost
-
Type:
object
Cost
Nested Schema : projectSettings
Nested Schema : ApiEntityCodeValueProject
Type:
object
- codeType
-
Type:
object
ApiEntityCodeType - codeValue
-
Type:
object
ApiEntityCodeValue - codeValueProjectId
-
Type:
integer
(int64
)The unique identifier of the workspace where the code value was created. - projectId
-
Type:
integer
(int64
)
Nested Schema : ApiEntityProjectCashFlow
Type:
object
- actualCost
-
Type:
object
Cost - actualForecastVar
-
Type:
object
Cost - atCompletionCost
-
Type:
object
Cost - currentApprovedBudget
-
Type:
object
Cost - currentApprovedSpendVariance
-
Type:
object
Cost - forecastCost
-
Type:
object
Cost - forecastCurrApprVar
-
Type:
object
Cost - plannedBudget
-
Type:
object
Cost - projectId
-
Type:
integer
(int64
)The unique identifier for the project. - projectPhaseFinancialId
-
Type:
integer
(int64
)The unique internal identifier for the project's time-phased cost spread. - proposedBudget
-
Type:
object
Cost - proposedForecastVariance
-
Type:
object
Cost - proposedPlannedVar
-
Type:
object
Cost - spendCost
-
Type:
object
Cost - spendForecastVar
-
Type:
object
Cost - spendPlannedVariance
-
Type:
object
Cost - spreadDate
-
Type:
string
(date-time
) - yearEndBudger
-
Type:
object
Cost - yearEndForecastCost
-
Type:
object
Cost - ytdActualCost
-
Type:
object
Cost - ytdSpendCost
-
Type:
object
Cost
Nested Schema : Cost
Type:
object
Nested Schema : flexMap
Type:
object
-
Type:
object
additionalProperties
Lists all configured cost fields assigned to the project with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : flexMap
Type:
object
-
Type:
object
additionalProperties
Lists all configured date, number, integer fields assigned to the project with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : flexMap
Type:
object
-
Type:
object
additionalProperties
Lists all configured text fields assigned to the project with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityProjectSetting
Type:
object
- projectId
-
Type:
integer
(int64
)The unique identifier for the project. - projectSettingId
-
Type:
integer
(int64
) - settingName
-
Type:
string
- settingValue
-
Type:
string
Nested Schema : flexMap
Nested Schema : additionalProperties
Type:
object
Nested Schema : flexMap
Nested Schema : additionalProperties
Type:
object
Nested Schema : flexMap
Nested Schema : additionalProperties
Type:
object